TCP/IP - Industrial Analog Out Bricklet 2.0

This is the description of the TCP/IP protocol 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.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletIndustrialAnalogOutV2.set_enabled
Function ID:

1

Request:
  • enabled -- bool
Response:

no response

Enables/disables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOutV2.get_enabled
Function ID:

2

Request:

empty payload

Response:
  • enabled -- bool

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

BrickletIndustrialAnalogOutV2.set_voltage
Function ID:

3

Request:
  • voltage -- uint16
Response:

no response

Sets the output voltage in mV.

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

BrickletIndustrialAnalogOutV2.get_voltage
Function ID:

4

Request:

empty payload

Response:
  • voltage -- uint16

Returns the voltage as set by set_voltage.

BrickletIndustrialAnalogOutV2.set_current
Function ID:

5

Request:
  • current -- uint16
Response:

no response

Sets the output current in µA.

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

BrickletIndustrialAnalogOutV2.get_current
Function ID:

6

Request:

empty payload

Response:
  • current -- uint16

Returns the current as set by set_current.

BrickletIndustrialAnalogOutV2.set_out_led_config
Function ID:

9

Request:
  • config -- uint8
Response:

no response

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 set_out_led_status_config.

By default the LED is configured as "Out Status"

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show out status, for config
BrickletIndustrialAnalogOutV2.get_out_led_config
Function ID:

10

Request:

empty payload

Response:
  • config -- uint8

Returns the Out LED configuration as set by set_out_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show out status, for config
BrickletIndustrialAnalogOutV2.set_out_led_status_config
Function ID:

11

Request:
  • min -- uint16
  • max -- uint16
  • config -- uint8
Response:

no response

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see 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 meanings are defined for the parameters of this function:

  • 0: threshold, for config
  • 1: intensity, for config
BrickletIndustrialAnalogOutV2.get_out_led_status_config
Function ID:

12

Request:

empty payload

Response:
  • min -- uint16
  • max -- uint16
  • config -- uint8

Returns the Out LED status configuration as set by set_out_led_status_config.

The following meanings are defined for the parameters of this function:

  • 0: threshold, for config
  • 1: intensity, for config

Advanced Functions

BrickletIndustrialAnalogOutV2.set_configuration
Function ID:

7

Request:
  • voltage_range -- uint8
  • current_range -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: 0 to 5v, for voltage_range
  • 1: 0 to 10v, for voltage_range
  • 0: 4 to 20ma, for current_range
  • 1: 0 to 20ma, for current_range
  • 2: 0 to 24ma, for current_range
BrickletIndustrialAnalogOutV2.get_configuration
Function ID:

8

Request:

empty payload

Response:
  • voltage_range -- uint8
  • current_range -- uint8

Returns the configuration as set by set_configuration.

The following meanings are defined for the parameters of this function:

  • 0: 0 to 5v, for voltage_range
  • 1: 0 to 10v, for voltage_range
  • 0: 4 to 20ma, for current_range
  • 1: 0 to 20ma, for current_range
  • 2: 0 to 24ma, for current_range
BrickletIndustrialAnalogOutV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletIndustrialAnalogOutV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletIndustrialAnalogOutV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletIndustrialAnalogOutV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for 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.

BrickletIndustrialAnalogOutV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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

BrickletIndustrialAnalogOutV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletIndustrialAnalogOutV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletIndustrialAnalogOutV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

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.

BrickletIndustrialAnalogOutV2.reset
Function ID:243
Request:empty payload
Response:no response

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!

BrickletIndustrialAnalogOutV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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.

BrickletIndustrialAnalogOutV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletIndustrialAnalogOutV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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