Modbus - Industrial Analog Out Bricklet

This is the description of the Modbus protocol for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out Bricklet are summarized in its hardware description.

API

A general description of the Modbus protocol structure can be found here.

Basic Functions

BrickletIndustrialAnalogOut.enable
Function ID:1
Request:empty payload
Response:no response

Enables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.disable
Function ID:2
Request:empty payload
Response:no response

Disables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.is_enabled
Function ID:

3

Request:

empty payload

Response:
  • enabled -- bool

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

BrickletIndustrialAnalogOut.set_voltage
Function ID:

4

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.

BrickletIndustrialAnalogOut.get_voltage
Function ID:

5

Request:

empty payload

Response:
  • voltage -- uint16

Returns the voltage as set by set_voltage.

BrickletIndustrialAnalogOut.set_current
Function ID:

6

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.

BrickletIndustrialAnalogOut.get_current
Function ID:

7

Request:

empty payload

Response:
  • current -- uint16

Returns the current as set by set_current.

Advanced Functions

BrickletIndustrialAnalogOut.set_configuration
Function ID:

8

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
BrickletIndustrialAnalogOut.get_configuration
Function ID:

9

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