Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Analog In Bricklet 3.0

openHAB - Analog In Bricklet 3.0

Warning

The openHAB bindings are still in beta, but the development was stopped.

This is the description of the openHAB API bindings for the Analog In Bricklet 3.0. General information and technical specifications for the Analog In Bricklet 3.0 are summarized in its hardware description.

An installation guide for the openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:brickletanaloginv3:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Oversampling – Type: Choice, Default: 4096x
  • Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms. The oversampling uses the moving average principle. A new value is always calculated once per millisecond. With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).
  • Options: 32x, 64x, 128x, 256x, 512x, 1024x, 2048x, 4096x, 8192x, 16384x

  • Status LED Configuration – 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

Voltage

The measured voltage

Type:
  • Number:ElectricPotential
UID:
  • tinkerforge:brickletanaloginv3:[UID]:BrickletAnalogInV3Voltage
Read only:
  • Yes
Unit:
  • Volt
Range:
  • 0 Volt to 42 Volt (Step 0.001 Volt)
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.

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:brickletanaloginv3:[UID]")
val hwVersion = actions.brickletAnalogInV3GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletAnalogInV3GetVoltage()
Return Map:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 42000]

Returns the measured voltage. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (the thing configuration).

If you want to get the value periodically, it is recommended to use the Voltage channel. You can set the channel configuration with the configuration of Voltage.

Advanced Actions

brickletAnalogInV3GetOversampling()
Return Map:
  • oversampling – Type: int, Range: See constants, Default: 7

Returns the oversampling value as set by the thing configuration.

The following constants are available for this function:

For oversampling:

  • val OVERSAMPLING_32 = 0
  • val OVERSAMPLING_64 = 1
  • val OVERSAMPLING_128 = 2
  • val OVERSAMPLING_256 = 3
  • val OVERSAMPLING_512 = 4
  • val OVERSAMPLING_1024 = 5
  • val OVERSAMPLING_2048 = 6
  • val OVERSAMPLING_4096 = 7
  • val OVERSAMPLING_8192 = 8
  • val OVERSAMPLING_16384 = 9
brickletAnalogInV3GetCalibration()
Return Map:
  • offset – Type: int, Unit: 1 mV, Range: [-215 to 215 - 1]
  • multiplier – Type: int, Range: [0 to 216 - 1]
  • divisor – Type: int, Range: [0 to 216 - 1]

Returns the calibration as set by This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

brickletAnalogInV3GetChipTemperature()
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.

brickletAnalogInV3GetStatusLEDConfig()
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
brickletAnalogInV3GetSPITFPErrorCount()
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.

brickletAnalogInV3Reset()

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!

brickletAnalogInV3GetIdentity()
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 at position 'z'.

The device identifier numbers can be found here. 

Internal Actions

brickletAnalogInV3ReadUID()
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.