MQTT - Voltage/Current Bricklet 2.0

This is the description of the MQTT API bindings for the Voltage/Current Bricklet 2.0. General information and technical specifications for the Voltage/Current Bricklet 2.0 are summarized in its hardware description.

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

Examples

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

Callback

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Voltage/Current Bricklet 2.0

setup:
    # Handle incoming current callbacks
    subscribe to tinkerforge/callback/voltage_current_v2_bricklet/XYZ/current
    publish '{"register": true}' to tinkerforge/register/voltage_current_v2_bricklet/XYZ/current # Register current callback
    
    # Set period for current callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/voltage_current_v2_bricklet/XYZ/set_current_callback_configuration

Simple

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Voltage/Current Bricklet 2.0

setup:
    # Get current voltage
    subscribe to tinkerforge/response/voltage_current_v2_bricklet/XYZ/get_voltage
    publish '' to tinkerforge/request/voltage_current_v2_bricklet/XYZ/get_voltage
    
    # Get current current
    subscribe to tinkerforge/response/voltage_current_v2_bricklet/XYZ/get_current
    publish '' to tinkerforge/request/voltage_current_v2_bricklet/XYZ/get_current

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Voltage/Current Bricklet 2.0

setup:
    # Handle incoming power callbacks
    subscribe to tinkerforge/callback/voltage_current_v2_bricklet/XYZ/power
    publish '{"register": true}' to tinkerforge/register/voltage_current_v2_bricklet/XYZ/power # Register power callback
    
    # Configure threshold for power "greater than 10 W"
    # with a debounce period of 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false, "option": "greater", "min": 10000, "max": 0}' to tinkerforge/request/voltage_current_v2_bricklet/XYZ/set_power_callback_configuration

API

All published payloads to and from the MQTT bindings are in JSON format.

If an error occures, the bindings publish a JSON object containing the error message as attribute "_ERROR". It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions

request/voltage_current_v2_bricklet/<UID>/get_current
Response payload:
  • current -- int

Returns the current. The value is in mA and between -20000mA and 20000mA.

If you want to get the value periodically, it is recommended to use the register/voltage_current_v2_bricklet/<UID>/current callback. You can set the callback configuration with request/voltage_current_v2_bricklet/<UID>/set_current_callback_configuration.

request/voltage_current_v2_bricklet/<UID>/get_voltage
Response payload:
  • voltage -- int

Returns the voltage. The value is in mV and between 0mV and 36000mV.

If you want to get the value periodically, it is recommended to use the register/voltage_current_v2_bricklet/<UID>/voltage callback. You can set the callback configuration with request/voltage_current_v2_bricklet/<UID>/set_voltage_callback_configuration.

request/voltage_current_v2_bricklet/<UID>/get_power
Response payload:
  • power -- int

Returns the power. The value is in mW and between 0mV and 720000mW.

If you want to get the value periodically, it is recommended to use the register/voltage_current_v2_bricklet/<UID>/power callback. You can set the callback configuration with request/voltage_current_v2_bricklet/<UID>/set_power_callback_configuration.

request/voltage_current_v2_bricklet/<UID>/set_configuration
Request payload:
  • averaging -- int (has symbols)
  • voltage_conversion_time -- int (has symbols)
  • current_conversion_time -- int (has symbols)

Sets the configuration of the Voltage/Current Bricklet 2.0. It is possible to configure number of averages as well as voltage and current conversion time.

Averaging:

Value Number of Averages
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Voltage/Current conversion:

Value Conversion time
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.

The following symbols are available for this function:

for averaging:

  • "1" = 0
  • "4" = 1
  • "16" = 2
  • "64" = 3
  • "128" = 4
  • "256" = 5
  • "512" = 6
  • "1024" = 7

for voltage_conversion_time:

  • "140us" = 0
  • "204us" = 1
  • "332us" = 2
  • "588us" = 3
  • "11ms" = 4
  • "2116ms" = 5
  • "4156ms" = 6
  • "8244ms" = 7
request/voltage_current_v2_bricklet/<UID>/get_configuration
Response payload:
  • averaging -- int (has symbols)
  • voltage_conversion_time -- int
  • current_conversion_time -- int

Returns the configuration as set by request/voltage_current_v2_bricklet/<UID>/set_configuration.

The following symbols are available for this function:

for averaging:

  • "1" = 0
  • "4" = 1
  • "16" = 2
  • "64" = 3
  • "128" = 4
  • "256" = 5
  • "512" = 6
  • "1024" = 7

Advanced Functions

request/voltage_current_v2_bricklet/<UID>/set_calibration
Request payload:
  • voltage_multiplier -- int
  • voltage_divisor -- int
  • current_multiplier -- int
  • current_divisor -- int

Since the ADC and the shunt resistor used for the measurements are not perfect they need to be calibrated by a multiplier and a divisor if a very precise reading is needed.

For example, if you are expecting a current of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the current multiplier to 1000 and the divisor to 1023. The same applies for the voltage.

The calibration will be saved on the EEPROM of the Voltage/Current Bricklet and only needs to be done once.

request/voltage_current_v2_bricklet/<UID>/get_calibration
Response payload:
  • voltage_multiplier -- int
  • voltage_divisor -- int
  • current_multiplier -- int
  • current_divisor -- int

Returns the calibration as set by request/voltage_current_v2_bricklet/<UID>/set_calibration.

request/voltage_current_v2_bricklet/<UID>/get_spitfp_error_count
Response payload:
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

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.

request/voltage_current_v2_bricklet/<UID>/set_bootloader_mode
Request payload:
  • mode -- int (has symbols)
Response payload:
  • status -- int (has symbols)

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 symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

for status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/voltage_current_v2_bricklet/<UID>/get_bootloader_mode
Response payload:
  • mode -- int (has symbols)

Returns the current bootloader mode, see request/voltage_current_v2_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/voltage_current_v2_bricklet/<UID>/set_write_firmware_pointer
Request payload:
  • pointer -- int

Sets the firmware pointer for request/voltage_current_v2_bricklet/<UID>/write_firmware. 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.

request/voltage_current_v2_bricklet/<UID>/write_firmware
Request payload:
  • data -- [int,... (x64)]
Response payload:
  • status -- int

Writes 64 Bytes of firmware at the position as written by request/voltage_current_v2_bricklet/<UID>/set_write_firmware_pointer 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.

request/voltage_current_v2_bricklet/<UID>/set_status_led_config
Request payload:
  • config -- int (has symbols)

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 symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/voltage_current_v2_bricklet/<UID>/get_status_led_config
Response payload:
  • config -- int (has symbols)

Returns the configuration as set by request/voltage_current_v2_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/voltage_current_v2_bricklet/<UID>/get_chip_temperature
Response payload:
  • temperature -- int

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.

request/voltage_current_v2_bricklet/<UID>/reset

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!

request/voltage_current_v2_bricklet/<UID>/write_uid
Request payload:
  • uid -- int

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.

request/voltage_current_v2_bricklet/<UID>/read_uid
Response payload:
  • uid -- int

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

request/voltage_current_v2_bricklet/<UID>/get_identity
Response payload:
  • uid -- string
  • connected_uid -- string
  • position -- char
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (has symbols)
  • _display_name -- string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Voltage/Current 2.0's name in a human readable form.

Callback Configuration Functions

request/voltage_current_v2_bricklet/<UID>/set_current_callback_configuration
Request payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

The period in ms is the period with which the register/voltage_current_v2_bricklet/<UID>/current 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 register/voltage_current_v2_bricklet/<UID>/current 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 symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/voltage_current_v2_bricklet/<UID>/get_current_callback_configuration
Response payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by request/voltage_current_v2_bricklet/<UID>/set_current_callback_configuration.

The following symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/voltage_current_v2_bricklet/<UID>/set_voltage_callback_configuration
Request payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

The period in ms is the period with which the register/voltage_current_v2_bricklet/<UID>/voltage 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 register/voltage_current_v2_bricklet/<UID>/voltage 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 symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/voltage_current_v2_bricklet/<UID>/get_voltage_callback_configuration
Response payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by request/voltage_current_v2_bricklet/<UID>/set_voltage_callback_configuration.

The following symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/voltage_current_v2_bricklet/<UID>/set_power_callback_configuration
Request payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

The period in ms is the period with which the register/voltage_current_v2_bricklet/<UID>/power 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 register/voltage_current_v2_bricklet/<UID>/power 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 symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/voltage_current_v2_bricklet/<UID>/get_power_callback_configuration
Response payload:
  • period -- int
  • value_has_to_change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by request/voltage_current_v2_bricklet/<UID>/set_power_callback_configuration.

The following symbols are available for this function:

for option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

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.

register/voltage_current_v2_bricklet/<UID>/current
Request payload:
  • register -- bool
Response payload:
  • current -- int

A callback can be registered for this event by publishing to the .../register/voltage_current_v2_bricklet/<UID>/current[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/voltage_current_v2_bricklet/<UID>/current[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/voltage_current_v2_bricklet/<UID>/set_current_callback_configuration.

The callback payload is the same as request/voltage_current_v2_bricklet/<UID>/get_current.

register/voltage_current_v2_bricklet/<UID>/voltage
Request payload:
  • register -- bool
Response payload:
  • voltage -- int

A callback can be registered for this event by publishing to the .../register/voltage_current_v2_bricklet/<UID>/voltage[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/voltage_current_v2_bricklet/<UID>/voltage[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/voltage_current_v2_bricklet/<UID>/set_voltage_callback_configuration.

The callback payload is the same as request/voltage_current_v2_bricklet/<UID>/get_voltage.

register/voltage_current_v2_bricklet/<UID>/power
Request payload:
  • register -- bool
Response payload:
  • power -- int

A callback can be registered for this event by publishing to the .../register/voltage_current_v2_bricklet/<UID>/power[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/voltage_current_v2_bricklet/<UID>/power[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/voltage_current_v2_bricklet/<UID>/set_power_callback_configuration.

The callback payload is the same as request/voltage_current_v2_bricklet/<UID>/get_power.