MQTT - Industrial Analog Out Bricklet 2.0

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

Download (example-simple-current.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

setup:
    # Set output current to 4.5mA
    publish '{"current": 4500}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_current 
    
    publish '{"enabled": true}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_enabled 

cleanup:
    # If you are done, run this to clean up
    publish '{"enabled": false}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_enabled 

Simple Voltage

Download (example-simple-voltage.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

setup:
    # Set output voltage to 3.3V
    publish '{"voltage": 3300}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_voltage 
    
    publish '{"enabled": true}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_enabled 

cleanup:
    # If you are done, run this to clean up
    publish '{"enabled": false}' to tinkerforge/request/industrial_analog_out_v2_bricklet/XYZ/set_enabled 

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/industrial_analog_out_v2_bricklet/<UID>/set_enabled
Request payload:
 
  • enabled -- bool

Enables/disables the output of voltage and current.

The default is disabled.

request/industrial_analog_out_v2_bricklet/<UID>/get_enabled
Response payload:
 
  • enabled -- bool

Returns true if output of voltage and current is enabled, false otherwise.

request/industrial_analog_out_v2_bricklet/<UID>/set_voltage
Request payload:
 
  • voltage -- int

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

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

Returns the voltage as set by request/industrial_analog_out_v2_bricklet/<UID>/set_voltage.

request/industrial_analog_out_v2_bricklet/<UID>/set_current
Request payload:
 
  • current -- int

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

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

Returns the current as set by request/industrial_analog_out_v2_bricklet/<UID>/set_current.

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

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to "Out Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).

You can configure the channel status behavior with request/industrial_analog_out_v2_bricklet/<UID>/set_out_led_status_config.

By default the LED is configured as "Out Status"

The following symbols are available for this function:

for config:

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

Returns the Out LED configuration as set by request/industrial_analog_out_v2_bricklet/<UID>/set_out_led_config

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowOutStatus" = 3
request/industrial_analog_out_v2_bricklet/<UID>/set_out_led_status_config
Request payload:
 
  • min -- int
  • max -- int
  • config -- int (has symbols)

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see request/industrial_analog_out_v2_bricklet/<UID>/set_out_led_config.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV or µA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the "max" parameter to the threshold value in mV or µA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

By default the channel LED status config is set to intensity with min=0V and max=10V.

The following symbols are available for this function:

for config:

  • "Threshold" = 0
  • "Intensity" = 1
request/industrial_analog_out_v2_bricklet/<UID>/get_out_led_status_config
Response payload:
 
  • min -- int
  • max -- int
  • config -- int (has symbols)

Returns the Out LED status configuration as set by request/industrial_analog_out_v2_bricklet/<UID>/set_out_led_status_config.

The following symbols are available for this function:

for config:

  • "Threshold" = 0
  • "Intensity" = 1

Advanced Functions

request/industrial_analog_out_v2_bricklet/<UID>/set_configuration
Request payload:
 
  • voltage_range -- int (has symbols)
  • current_range -- int (has symbols)

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following symbols are available for this function:

for voltage_range:

  • "0To5V" = 0
  • "0To10V" = 1

for current_range:

  • "4To20mA" = 0
  • "0To20mA" = 1
  • "0To24ma" = 2
request/industrial_analog_out_v2_bricklet/<UID>/get_configuration
Response payload:
 
  • voltage_range -- int (has symbols)
  • current_range -- int (has symbols)

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

The following symbols are available for this function:

for voltage_range:

  • "0To5V" = 0
  • "0To10V" = 1

for current_range:

  • "4To20mA" = 0
  • "0To20mA" = 1
  • "0To24ma" = 2
request/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_v2_bricklet/<UID>/get_bootloader_mode
Response payload:
 
  • mode -- int (has symbols)

Returns the current bootloader mode, see request/industrial_analog_out_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/industrial_analog_out_v2_bricklet/<UID>/set_write_firmware_pointer
Request payload:
 
  • pointer -- int

Sets the firmware pointer for request/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_v2_bricklet/<UID>/get_status_led_config
Response payload:
 
  • config -- int (has symbols)

Returns the configuration as set by request/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_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/industrial_analog_out_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/industrial_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 Industrial Analog Out 2.0's name in a human readable form.