xmc1400_breakout_bricklet

package
v0.0.0-...-8a98e63 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 11, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Breakout for Infineon XMC1400 microcontroller.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/XMC1400Breakout_Bricklet_Go.html.

Index

Constants

View Source 
const DeviceDisplayName = "XMC1400 Breakout Bricklet"
View Source 
const DeviceIdentifier = 279

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode 

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus 

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function 

type Function = uint8
const (
	FunctionSetGPIOConfig                     Function = 1
	FunctionGetGPIOInput                      Function = 2
	FunctionSetADCChannelConfig               Function = 3
	FunctionGetADCChannelConfig               Function = 4
	FunctionGetADCChannelValue                Function = 5
	FunctionGetADCValues                      Function = 6
	FunctionSetADCValuesCallbackConfiguration Function = 7
	FunctionGetADCValuesCallbackConfiguration Function = 8
	FunctionGetCount                          Function = 10
	FunctionSetCountCallbackConfiguration     Function = 11
	FunctionGetCountCallbackConfiguration     Function = 12
	FunctionGetSPITFPErrorCount               Function = 234
	FunctionSetBootloaderMode                 Function = 235
	FunctionGetBootloaderMode                 Function = 236
	FunctionSetWriteFirmwarePointer           Function = 237
	FunctionWriteFirmware                     Function = 238
	FunctionSetStatusLEDConfig                Function = 239
	FunctionGetStatusLEDConfig                Function = 240
	FunctionGetChipTemperature                Function = 242
	FunctionReset                             Function = 243
	FunctionWriteUID                          Function = 248
	FunctionReadUID                           Function = 249
	FunctionGetIdentity                       Function = 255
	FunctionCallbackADCValues                 Function = 9
	FunctionCallbackCount                     Function = 13
)

type GPIOInputHysteresis 

type GPIOInputHysteresis = uint8
const (
	GPIOInputHysteresisStandard GPIOInputHysteresis = 0
	GPIOInputHysteresisLarge    GPIOInputHysteresis = 4
)

type GPIOMode 

type GPIOMode = uint8
const (
	GPIOModeInputTristate         GPIOMode = 0
	GPIOModeInputPullDown         GPIOMode = 1
	GPIOModeInputPullUp           GPIOMode = 2
	GPIOModeInputSampling         GPIOMode = 3
	GPIOModeInputInvertedTristate GPIOMode = 4
	GPIOModeInputInvertedPullDown GPIOMode = 5
	GPIOModeInputInvertedPullUp   GPIOMode = 6
	GPIOModeInputInvertedSampling GPIOMode = 7
	GPIOModeOutputPushPull        GPIOMode = 8
	GPIOModeOutputOpenDrain       GPIOMode = 9
)

type StatusLEDConfig 

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

type ThresholdOption 

type ThresholdOption = rune
const (
	ThresholdOptionOff     ThresholdOption = 'x'
	ThresholdOptionOutside ThresholdOption = 'o'
	ThresholdOptionInside  ThresholdOption = 'i'
	ThresholdOptionSmaller ThresholdOption = '<'
	ThresholdOptionGreater ThresholdOption = '>'
)

type XMC1400BreakoutBricklet 

type XMC1400BreakoutBricklet struct {
	// contains filtered or unexported fields
}

func New 

func New(uid string, ipcon *ipconnection.IPConnection) (XMC1400BreakoutBricklet, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*XMC1400BreakoutBricklet) DeregisterADCValuesCallback 

func (device *XMC1400BreakoutBricklet) DeregisterADCValuesCallback(registrationId uint64)

Remove a registered ADC Values callback.

func (*XMC1400BreakoutBricklet) DeregisterCountCallback 

func (device *XMC1400BreakoutBricklet) DeregisterCountCallback(registrationId uint64)

Remove a registered Count callback.

func (*XMC1400BreakoutBricklet) GetADCChannelConfig 

func (device *XMC1400BreakoutBricklet) GetADCChannelConfig(channel uint8) (enable bool, err error)

Returns the config for the given channel as set by SetADCChannelConfig.

func (*XMC1400BreakoutBricklet) GetADCChannelValue 

func (device *XMC1400BreakoutBricklet) GetADCChannelValue(channel uint8) (value uint16, err error)

Returns the 12-bit value of the given ADC channel of the ADC driver example.

func (*XMC1400BreakoutBricklet) GetADCValues 

func (device *XMC1400BreakoutBricklet) GetADCValues() (values [8]uint16, err error)

Returns the values for all 8 ADC channels of the adc driver example.

This example function also has a corresponding callback.

See SetADCValuesCallbackConfiguration and RegisterADCValuesCallback callback.

func (*XMC1400BreakoutBricklet) GetADCValuesCallbackConfiguration 

func (device *XMC1400BreakoutBricklet) GetADCValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetADCValuesCallbackConfiguration.

func (*XMC1400BreakoutBricklet) GetAPIVersion 

func (device *XMC1400BreakoutBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*XMC1400BreakoutBricklet) GetBootloaderMode 

func (device *XMC1400BreakoutBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*XMC1400BreakoutBricklet) GetChipTemperature 

func (device *XMC1400BreakoutBricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*XMC1400BreakoutBricklet) GetCount 

func (device *XMC1400BreakoutBricklet) GetCount() (count uint32, err error)

Returns the value of the example count (see example.c).

This example function uses the add_callback_value_function-helper in the generator. The getter as well as the callback and callback configuration functions are auto-generated for the API as well as the firmware.

If you want to get the value periodically, it is recommended to use the RegisterCountCallback callback. You can set the callback configuration with SetCountCallbackConfiguration.

func (*XMC1400BreakoutBricklet) GetCountCallbackConfiguration 

func (device *XMC1400BreakoutBricklet) GetCountCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32, err error)

Returns the callback configuration as set by SetCountCallbackConfiguration.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*XMC1400BreakoutBricklet) GetGPIOInput 

func (device *XMC1400BreakoutBricklet) GetGPIOInput(port uint8, pin uint8) (value bool, err error)

Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.

func (*XMC1400BreakoutBricklet) GetIdentity 

func (device *XMC1400BreakoutBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*XMC1400BreakoutBricklet) GetResponseExpected 

func (device *XMC1400BreakoutBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*XMC1400BreakoutBricklet) GetSPITFPErrorCount 

func (device *XMC1400BreakoutBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*XMC1400BreakoutBricklet) GetStatusLEDConfig 

func (device *XMC1400BreakoutBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*XMC1400BreakoutBricklet) ReadUID 

func (device *XMC1400BreakoutBricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*XMC1400BreakoutBricklet) RegisterADCValuesCallback 

func (device *XMC1400BreakoutBricklet) RegisterADCValuesCallback(fn func([8]uint16)) uint64

This callback is triggered periodically according to the configuration set by SetADCValuesCallbackConfiguration.

The parameters are the same as GetADCValues.

func (*XMC1400BreakoutBricklet) RegisterCountCallback 

func (device *XMC1400BreakoutBricklet) RegisterCountCallback(fn func(uint32)) uint64

This callback is triggered periodically according to the configuration set by SetCountCallbackConfiguration.

The parameter is the same as GetCount.

func (*XMC1400BreakoutBricklet) Reset 

func (device *XMC1400BreakoutBricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*XMC1400BreakoutBricklet) SetADCChannelConfig 

func (device *XMC1400BreakoutBricklet) SetADCChannelConfig(channel uint8, enable bool) (err error)

Enables a ADC channel for the ADC driver example (adc.c/adc.h).

There are 8 ADC channels and they correspond to the following pins:

* Channel 0: P2_6 * Channel 1: P2_8 * Channel 2: P2_9 * Channel 3: P2_10 * Channel 4: P2_11 * Channel 5: P2_0 * Channel 6: P2_1 * Channel 7: P2_2

func (*XMC1400BreakoutBricklet) SetADCValuesCallbackConfiguration 

func (device *XMC1400BreakoutBricklet) SetADCValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterADCValuesCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*XMC1400BreakoutBricklet) SetBootloaderMode 

func (device *XMC1400BreakoutBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot
  • BootloaderStatusOK
  • BootloaderStatusInvalidMode
  • BootloaderStatusNoChange
  • BootloaderStatusEntryFunctionNotPresent
  • BootloaderStatusDeviceIdentifierIncorrect
  • BootloaderStatusCRCMismatch

func (*XMC1400BreakoutBricklet) SetCountCallbackConfiguration 

func (device *XMC1400BreakoutBricklet) SetCountCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32) (err error)

The period is the period with which the RegisterCountCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterCountCallback callback.

The following options are possible: 

Option| Description
--- | ---
'x'|    Threshold is turned off
'o'|    Threshold is triggered when the value is *outside* the min and max values
'i'|    Threshold is triggered when the value is *inside* or equal to the min and max values
'<'|    Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'|    Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*XMC1400BreakoutBricklet) SetGPIOConfig 

func (device *XMC1400BreakoutBricklet) SetGPIOConfig(port uint8, pin uint8, mode GPIOMode, inputHysteresis GPIOInputHysteresis, outputLevel bool) (err error)

Example for a setter function. The values are the values that can be given to the XMC_GPIO_Init function. See communication.c in the firmware.

Associated constants:

  • GPIOModeInputTristate
  • GPIOModeInputPullDown
  • GPIOModeInputPullUp
  • GPIOModeInputSampling
  • GPIOModeInputInvertedTristate
  • GPIOModeInputInvertedPullDown
  • GPIOModeInputInvertedPullUp
  • GPIOModeInputInvertedSampling
  • GPIOModeOutputPushPull
  • GPIOModeOutputOpenDrain
  • GPIOInputHysteresisStandard
  • GPIOInputHysteresisLarge

func (*XMC1400BreakoutBricklet) SetResponseExpected 

func (device *XMC1400BreakoutBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*XMC1400BreakoutBricklet) SetResponseExpectedAll 

func (device *XMC1400BreakoutBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*XMC1400BreakoutBricklet) SetStatusLEDConfig 

func (device *XMC1400BreakoutBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*XMC1400BreakoutBricklet) SetWriteFirmwarePointer 

func (device *XMC1400BreakoutBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*XMC1400BreakoutBricklet) WriteFirmware 

func (device *XMC1400BreakoutBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*XMC1400BreakoutBricklet) WriteUID 

func (device *XMC1400BreakoutBricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.