openHAB - XMC1400 Breakout Bricklet

This is the description of the openHAB 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 openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:brickletxmc1400breakout:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • ADC Values Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval for ADC values in milliseconds. A value of 0 disables automatic updates.

  • Status LED Config – Type: Choice, Default: Show Status
  • 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.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

Count

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

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutCount
Read only:
  • Yes
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
ADC Value 0

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue0
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 1

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue1
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 2

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue2
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 3

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue3
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 4

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue4
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 5

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue5
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 6

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue6
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)
ADC Value 7

The value for one of the 8 ADC channels of the adc driver example.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletxmc1400breakout:[UID]:BrickletXMC1400BreakoutADCValue7
Read only:
  • Yes
Range:
  • 0 to 4095 (Step 1)

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:brickletxmc1400breakout:[UID]")
val hwVersion = actions.brickletXMC1400BreakoutGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletXMC1400BreakoutGetCount()
Return Map:
  • count – Type: long, Range: [0 to 232 - 1]

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 channel and channel 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 Count channel. You can set the channel configuration with the configuration of Count.

Advanced Actions

brickletXMC1400BreakoutGetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

brickletXMC1400BreakoutGetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletXMC1400BreakoutGetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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.

brickletXMC1400BreakoutGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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 is always as position 'z'.

The device identifier numbers can be found here

Internal Actions

brickletXMC1400BreakoutReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

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