Go - XMC1400 Breakout Bricklet

This is the description of the Go API bindings for the XMC1400 Breakout Bricklet. General information and technical specifications for the XMC1400 Breakout Bricklet are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

The example code below is Public Domain (CC0 1.0).

Gpio

Download (example_gpio.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/xmc1400_breakout_bricklet"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your XMC1400 Breakout Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    xb, _ := xmc1400_breakout_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
    for i := 0; i < 5; i++ {
        time.Sleep(1000 * time.Millisecond)
        xb.SetGPIOConfig(1, 0, xmc1400_breakout_bricklet.GPIOModeOutputPushPull, 0, false)
        time.Sleep(1000 * time.Millisecond)
        xb.SetGPIOConfig(1, 0, xmc1400_breakout_bricklet.GPIOModeOutputPushPull, 0, true)
    }

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The XMC1400 Breakout Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/xmc1400_breakout_bricklet

Nearly every function of the Go bindings can return an ipconnection.DeviceError, implementing the error interface. The error can have one of the following values:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func xmc1400_breakout_bricklet.New(uid string, ipcon *IPConnection) (device XMC1400BreakoutBricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: XMC1400BreakoutBricklet
  • err – Type: error

Creates a new XMC1400BreakoutBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := xmc1400_breakout_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected (see examples above).

func (*XMC1400BreakoutBricklet) SetGPIOConfig(port uint8, pin uint8, mode uint8, inputHysteresis uint8, outputLevel bool) (err error)
Parameters:
  • port – Type: uint8, Range: [0 to 255]
  • pin – Type: uint8, Range: [0 to 255]
  • mode – Type: uint8, Range: See constants
  • inputHysteresis – Type: uint8, Range: See constants
  • outputLevel – Type: bool
Returns:
  • err – Type: 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.

The following constants are available for this function:

For mode:

  • xmc1400_breakout_bricklet.GPIOModeInputTristate = 0
  • xmc1400_breakout_bricklet.GPIOModeInputPullDown = 1
  • xmc1400_breakout_bricklet.GPIOModeInputPullUp = 2
  • xmc1400_breakout_bricklet.GPIOModeInputSampling = 3
  • xmc1400_breakout_bricklet.GPIOModeInputInvertedTristate = 4
  • xmc1400_breakout_bricklet.GPIOModeInputInvertedPullDown = 5
  • xmc1400_breakout_bricklet.GPIOModeInputInvertedPullUp = 6
  • xmc1400_breakout_bricklet.GPIOModeInputInvertedSampling = 7
  • xmc1400_breakout_bricklet.GPIOModeOutputPushPull = 8
  • xmc1400_breakout_bricklet.GPIOModeOutputOpenDrain = 9

For inputHysteresis:

  • xmc1400_breakout_bricklet.GPIOInputHysteresisStandard = 0
  • xmc1400_breakout_bricklet.GPIOInputHysteresisLarge = 4
func (*XMC1400BreakoutBricklet) GetGPIOInput(port uint8, pin uint8) (value bool, err error)
Parameters:
  • port – Type: uint8, Range: [0 to 255]
  • pin – Type: uint8, Range: [0 to 255]
Returns:
  • value – Type: bool
  • err – Type: error

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

func (*XMC1400BreakoutBricklet) SetADCChannelConfig(channel uint8, enable bool) (err error)
Parameters:
  • channel – Type: uint8, Range: [0 to 255]
  • enable – Type: bool
Returns:
  • err – Type: 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) GetADCChannelConfig(channel uint8) (enable bool, err error)
Parameters:
  • channel – Type: uint8, Range: [0 to 255]
Returns:
  • enable – Type: bool
  • err – Type: error

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

func (*XMC1400BreakoutBricklet) GetADCChannelValue(channel uint8) (value uint16, err error)
Parameters:
  • channel – Type: uint8, Range: [0 to 255]
Returns:
  • value – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: error

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

func (*XMC1400BreakoutBricklet) GetADCValues() (values [8]uint16, err error)
Returns:
  • values – Type: [8]uint16, Range: [0 to 216 - 1]
  • err – Type: 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) GetCount() (count uint32, err error)
Returns:
  • count – Type: uint32, Range: [0 to 232 - 1]
  • err – Type: 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().

Advanced Functions

func (*XMC1400BreakoutBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Returns:
  • apiVersion – Type: [3]uint8, Range: [0 to 255]
  • err – Type: error

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) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
Returns:
  • responseExpected – Type: bool
  • err – Type: 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • xmc1400_breakout_bricklet.FunctionSetGPIOConfig = 1
  • xmc1400_breakout_bricklet.FunctionSetADCChannelConfig = 3
  • xmc1400_breakout_bricklet.FunctionSetADCValuesCallbackConfiguration = 7
  • xmc1400_breakout_bricklet.FunctionSetCountCallbackConfiguration = 11
  • xmc1400_breakout_bricklet.FunctionSetWriteFirmwarePointer = 237
  • xmc1400_breakout_bricklet.FunctionSetStatusLEDConfig = 239
  • xmc1400_breakout_bricklet.FunctionReset = 243
  • xmc1400_breakout_bricklet.FunctionWriteUID = 248
func (*XMC1400BreakoutBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
  • responseExpected – Type: bool
Returns:
  • err – Type: 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • xmc1400_breakout_bricklet.FunctionSetGPIOConfig = 1
  • xmc1400_breakout_bricklet.FunctionSetADCChannelConfig = 3
  • xmc1400_breakout_bricklet.FunctionSetADCValuesCallbackConfiguration = 7
  • xmc1400_breakout_bricklet.FunctionSetCountCallbackConfiguration = 11
  • xmc1400_breakout_bricklet.FunctionSetWriteFirmwarePointer = 237
  • xmc1400_breakout_bricklet.FunctionSetStatusLEDConfig = 239
  • xmc1400_breakout_bricklet.FunctionReset = 243
  • xmc1400_breakout_bricklet.FunctionWriteUID = 248
func (*XMC1400BreakoutBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameters:
  • responseExpected – Type: bool
Returns:
  • err – Type: error

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

func (*XMC1400BreakoutBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Returns:
  • errorCountAckChecksum – Type: uint32, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: uint32, Range: [0 to 232 - 1]
  • errorCountFrame – Type: uint32, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: uint32, Range: [0 to 232 - 1]
  • err – Type: 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) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameters:
  • mode – Type: uint8, Range: See constants
Returns:
  • status – Type: uint8, Range: See constants
  • err – Type: 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.

The following constants are available for this function:

For mode:

  • xmc1400_breakout_bricklet.BootloaderModeBootloader = 0
  • xmc1400_breakout_bricklet.BootloaderModeFirmware = 1
  • xmc1400_breakout_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • xmc1400_breakout_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • xmc1400_breakout_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

For status:

  • xmc1400_breakout_bricklet.BootloaderStatusOK = 0
  • xmc1400_breakout_bricklet.BootloaderStatusInvalidMode = 1
  • xmc1400_breakout_bricklet.BootloaderStatusNoChange = 2
  • xmc1400_breakout_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • xmc1400_breakout_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • xmc1400_breakout_bricklet.BootloaderStatusCRCMismatch = 5
func (*XMC1400BreakoutBricklet) GetBootloaderMode() (mode uint8, err error)
Returns:
  • mode – Type: uint8, Range: See constants
  • err – Type: error

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

  • xmc1400_breakout_bricklet.BootloaderModeBootloader = 0
  • xmc1400_breakout_bricklet.BootloaderModeFirmware = 1
  • xmc1400_breakout_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • xmc1400_breakout_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • xmc1400_breakout_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*XMC1400BreakoutBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameters:
  • pointer – Type: uint32, Range: [0 to 232 - 1]
Returns:
  • err – Type: 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(data [64]uint8) (status uint8, err error)
Parameters:
  • data – Type: [64]uint8, Range: [0 to 255]
Returns:
  • status – Type: uint8, Range: [0 to 255]
  • err – Type: 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) SetStatusLEDConfig(config uint8) (err error)
Parameters:
  • config – Type: uint8, Range: See constants
Returns:
  • err – Type: 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.

The following constants are available for this function:

For config:

  • xmc1400_breakout_bricklet.StatusLEDConfigOff = 0
  • xmc1400_breakout_bricklet.StatusLEDConfigOn = 1
  • xmc1400_breakout_bricklet.StatusLEDConfigShowHeartbeat = 2
  • xmc1400_breakout_bricklet.StatusLEDConfigShowStatus = 3
func (*XMC1400BreakoutBricklet) GetStatusLEDConfig() (config uint8, err error)
Returns:
  • config – Type: uint8, Range: See constants
  • err – Type: error

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

  • xmc1400_breakout_bricklet.StatusLEDConfigOff = 0
  • xmc1400_breakout_bricklet.StatusLEDConfigOn = 1
  • xmc1400_breakout_bricklet.StatusLEDConfigShowHeartbeat = 2
  • xmc1400_breakout_bricklet.StatusLEDConfigShowStatus = 3
func (*XMC1400BreakoutBricklet) GetChipTemperature() (temperature int16, err error)
Returns:
  • temperature – Type: int16, Range: [-215 to 215 - 1]
  • err – Type: error

Returns the temperature in °C 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) Reset() (err error)
Returns:
  • err – Type: 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) WriteUID(uid uint32) (err error)
Parameters:
  • uid – Type: uint32, Range: [0 to 232 - 1]
Returns:
  • err – Type: 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.

func (*XMC1400BreakoutBricklet) ReadUID() (uid uint32, err error)
Returns:
  • uid – Type: uint32, Range: [0 to 232 - 1]
  • err – Type: error

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

func (*XMC1400BreakoutBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Returns:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: rune
  • hardwareVersion – Type: [3]uint8, Range: [0 to 255]
  • firmwareVersion – Type: [3]uint8, Range: [0 to 255]
  • deviceIdentifier – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

func (*XMC1400BreakoutBricklet) SetADCValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
Parameters:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false
Returns:
  • err – Type: 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) GetADCValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Returns:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false
  • err – Type: error

Returns the callback configuration as set by SetADCValuesCallbackConfiguration().

func (*XMC1400BreakoutBricklet) SetCountCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min uint32, max uint32) (err error)
Parameters:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false
  • option – Type: rune, Range: See constants, Default: 'x'
  • min – Type: uint32, Range: [0 to 232 - 1]
  • max – Type: uint32, Range: [0 to 232 - 1]
Returns:
  • err – Type: 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.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

For option:

  • xmc1400_breakout_bricklet.ThresholdOptionOff = 'x'
  • xmc1400_breakout_bricklet.ThresholdOptionOutside = 'o'
  • xmc1400_breakout_bricklet.ThresholdOptionInside = 'i'
  • xmc1400_breakout_bricklet.ThresholdOptionSmaller = '<'
  • xmc1400_breakout_bricklet.ThresholdOptionGreater = '>'
func (*XMC1400BreakoutBricklet) GetCountCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min uint32, max uint32, err error)
Returns:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: bool, Default: false
  • option – Type: rune, Range: See constants, Default: 'x'
  • min – Type: uint32, Range: [0 to 232 - 1]
  • max – Type: uint32, Range: [0 to 232 - 1]
  • err – Type: error

Returns the callback configuration as set by SetCountCallbackConfiguration().

The following constants are available for this function:

For option:

  • xmc1400_breakout_bricklet.ThresholdOptionOff = 'x'
  • xmc1400_breakout_bricklet.ThresholdOptionOutside = 'o'
  • xmc1400_breakout_bricklet.ThresholdOptionInside = 'i'
  • xmc1400_breakout_bricklet.ThresholdOptionSmaller = '<'
  • xmc1400_breakout_bricklet.ThresholdOptionGreater = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later with the corresponding Deregister*Callback function.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

func (*XMC1400BreakoutBricklet) RegisterADCValuesCallback(func(values [8]uint16)) (registrationId uint64)
Callback Parameters:
  • values – Type: [8]uint16, Range: [0 to 216 - 1]
Returns:
  • registrationId – Type: uint64

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

The callback parameters are the same as GetADCValues().

func (*XMC1400BreakoutBricklet) RegisterCountCallback(func(count uint32)) (registrationId uint64)
Callback Parameters:
  • count – Type: uint32, Range: [0 to 232 - 1]
Returns:
  • registrationId – Type: uint64

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

The callback parameter is the same as GetCount().

Constants

xmc1400_breakout_bricklet.DeviceIdentifier

This constant is used to identify a XMC1400 Breakout Bricklet.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

xmc1400_breakout_bricklet.DeviceDisplayName

This constant represents the human readable name of a XMC1400 Breakout Bricklet.