MQTT - Analog Out Bricklet 2.0

This is the description of the MQTT API bindings for the Analog Out Bricklet 2.0. General information and technical specifications for the Analog Out 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).

Simple

Download (example-simple.txt)

1
2
3
4
5
# Change XYZ to the UID of your Analog Out Bricklet 2.0

setup:
    # Set output voltage to 3.3V
    publish '{"voltage": 3300}' to tinkerforge/request/analog_out_v2_bricklet/XYZ/set_output_voltage 

API

All published payload to an from the MQTT bindings is in the 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/analog_out_v2_bricklet/<UID>/set_output_voltage
Request payload:
 
  • voltage -- int

Sets the voltage in mV. The possible range is 0V to 12V (0-12000).

request/analog_out_v2_bricklet/<UID>/get_output_voltage
Response payload:
 
  • voltage -- int

Returns the voltage as set by request/analog_out_v2_bricklet/<UID>/set_output_voltage.

Advanced Functions

request/analog_out_v2_bricklet/<UID>/get_input_voltage
Response payload:
 
  • voltage -- int

Returns the input voltage in mV.

request/analog_out_v2_bricklet/<UID>/get_identity
Response payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • 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 Analog Out 2.0's name in a human readable form.