Modbus - Industrial Dual 0-20mA Bricklet

This is the description of the Modbus protocol for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA Bricklet are summarized in its hardware description.

API

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

Two sensors can be connected to the Bricklet. Functions that are related directly to a sensor have a sensor parameter to specify one of the two sensors. Valid values for the sensor parameter are 0 and 1.

Basic Functions

BrickletIndustrialDual020mA.get_current
Function ID:
  • 1
Request:
  • sensor – Type: uint8, Range: [0 to 255]
Response:
  • current – Type: int32, Range: [-231 to 231 - 1]

Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with set_current_callback_period.

Advanced Functions

BrickletIndustrialDual020mA.set_sample_rate
Function ID:
  • 8
Request:
  • rate – Type: uint8, Range: See meanings
Response:
  • no response

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value Description
0 240 samples per second, 12 bit resolution
1 60 samples per second, 14 bit resolution
2 15 samples per second, 16 bit resolution
3 4 samples per second, 18 bit resolution

The default value is 3 (4 samples per second with 18 bit resolution).

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

For rate:

  • 0 = 240 SPS
  • 1 = 60 SPS
  • 2 = 15 SPS
  • 3 = 4 SPS
BrickletIndustrialDual020mA.get_sample_rate
Function ID:
  • 9
Request:
  • empty payload
Response:
  • rate – Type: uint8, Range: See meanings

Returns the sample rate as set by set_sample_rate.

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

For rate:

  • 0 = 240 SPS
  • 1 = 60 SPS
  • 2 = 15 SPS
  • 3 = 4 SPS
BrickletIndustrialDual020mA.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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

Callback Configuration Functions

BrickletIndustrialDual020mA.set_current_callback_period
Function ID:
  • 2
Request:
  • sensor – Type: uint8, Range: [0 to 255]
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

Sets the period with which the CALLBACK_CURRENT callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletIndustrialDual020mA.get_current_callback_period
Function ID:
  • 3
Request:
  • sensor – Type: uint8, Range: [0 to 255]
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_current_callback_period.

BrickletIndustrialDual020mA.set_current_callback_threshold
Function ID:
  • 4
Request:
  • sensor – Type: uint8, Range: [0 to 255]
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int32, Range: [-231 to 231 - 1]
  • max – Type: int32, Range: [-231 to 231 - 1]
Response:
  • no response

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback for the given sensor.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the current is outside the min and max values
'i' Callback is triggered when the current is inside the min and max values
'<' Callback is triggered when the current is smaller than the min value (max is ignored)
'>' Callback is triggered when the current is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletIndustrialDual020mA.get_current_callback_threshold
Function ID:
  • 5
Request:
  • sensor – Type: uint8, Range: [0 to 255]
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: int32, Range: [-231 to 231 - 1]
  • max – Type: int32, Range: [-231 to 231 - 1]

Returns the threshold as set by set_current_callback_threshold.

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

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletIndustrialDual020mA.set_debounce_period
Function ID:
  • 6
Request:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:
  • no response

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

BrickletIndustrialDual020mA.get_debounce_period
Function ID:
  • 7
Request:
  • empty payload
Response:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletIndustrialDual020mA.CALLBACK_CURRENT
Function ID:
  • 10
Response:
  • sensor – Type: uint8, Range: [0 to 255]
  • current – Type: int32, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by set_current_callback_period. The response value is the current of the sensor.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletIndustrialDual020mA.CALLBACK_CURRENT_REACHED
Function ID:
  • 11
Response:
  • sensor – Type: uint8, Range: [0 to 255]
  • current – Type: int32, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by set_current_callback_threshold is reached. The response value is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period.