Specifications / Modbus Protocol / API / Bricklets / Industrial Dual 0-20mA Bricklet 2.0

Modbus - Industrial Dual 0-20mA Bricklet 2.0¶

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

API¶

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

Basic Functions¶

BrickletIndustrialDual020mAV2.get_current¶

Function ID:	1
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	current – Type: int32, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified channel.

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 connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective.

If you want to get the value periodically, it is recommended to use the CALLBACK_CURRENT callback. You can set the callback configuration with set_current_callback_configuration.

BrickletIndustrialDual020mAV2.set_channel_led_config¶

Function ID:	9
Request:	channel – Type: uint8, Range: [0 to 1] config – Type: uint8, Range: See meanings, Default: 3
Response:	no response

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel 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 measured value.

You can configure the channel status behavior with set_channel_led_status_config.

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Channel Status

BrickletIndustrialDual020mAV2.get_channel_led_config¶

Function ID:	10
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the channel LED configuration as set by set_channel_led_config

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Channel Status

BrickletIndustrialDual020mAV2.set_channel_led_status_config¶

Function ID:	11
Request:	channel – Type: uint8, Range: [0 to 1] min – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 4000000 max – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 20000000 config – Type: uint8, Range: See meanings, Default: 1
Response:	no response

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see set_channel_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 nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.

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

For config:

0 = Threshold
1 = Intensity

BrickletIndustrialDual020mAV2.get_channel_led_status_config¶

Function ID:	12
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	min – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 4000000 max – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 20000000 config – Type: uint8, Range: See meanings, Default: 1

Returns the channel LED status configuration as set by set_channel_led_status_config.

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

For config:

0 = Threshold
1 = Intensity

Advanced Functions¶

BrickletIndustrialDual020mAV2.set_sample_rate¶

Function ID:	5
Request:	rate – Type: uint8, Range: See meanings, Default: 3
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 following meanings are defined for the elements of this function:

For rate:

0 = 240 SPS
1 = 60 SPS
2 = 15 SPS
3 = 4 SPS

BrickletIndustrialDual020mAV2.get_sample_rate¶

Function ID:	6
Request:	empty payload
Response:	rate – Type: uint8, Range: See meanings, Default: 3

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

BrickletIndustrialDual020mAV2.set_gain¶

Function ID:	7
Request:	gain – Type: uint8, Range: See meanings, Default: 0
Response:	no response

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

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

For gain:

0 = 1x
1 = 2x
2 = 4x
3 = 8x

BrickletIndustrialDual020mAV2.get_gain¶

Function ID:	8
Request:	empty payload
Response:	gain – Type: uint8, Range: See meanings, Default: 0

Returns the gain as set by set_gain.

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

For gain:

0 = 1x
1 = 2x
2 = 4x
3 = 8x

BrickletIndustrialDual020mAV2.get_spitfp_error_count¶

Function ID:	234
Request:	empty payload
Response:	error_count_ack_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_frame – Type: uint32, Range: [0 to 2³² - 1] error_count_overflow – Type: uint32, Range: [0 to 2³² - 1]

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.

BrickletIndustrialDual020mAV2.set_status_led_config¶

Function ID:	239
Request:	config – Type: uint8, Range: See meanings, Default: 3
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 elements of this function:

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletIndustrialDual020mAV2.get_status_led_config¶

Function ID:	240
Request:	empty payload
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletIndustrialDual020mAV2.get_chip_temperature¶

Function ID:	242
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature 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.

BrickletIndustrialDual020mAV2.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!

BrickletIndustrialDual020mAV2.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, Range: [0 to 2¹⁶ - 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here.

Callback Configuration Functions¶

BrickletIndustrialDual020mAV2.set_current_callback_configuration¶

Function ID:	2
Request:	channel – Type: uint8, Range: [0 to 1] period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0
Response:	no response

The period is the period with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_CURRENT callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

For option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletIndustrialDual020mAV2.get_current_callback_configuration¶

Function ID:	3
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by set_current_callback_configuration.

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

For option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

Callbacks¶

BrickletIndustrialDual020mAV2.CALLBACK_CURRENT¶

Function ID:	4
Response:	channel – Type: uint8, Range: [0 to 1] current – Type: int32, Unit: 1 nA, Range: [0 to 22505322]

This callback is triggered periodically according to the configuration set by set_current_callback_configuration.

The response value is the same as get_current.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletIndustrialDual020mAV2.set_bootloader_mode¶

Function ID:	235
Request:	mode – Type: uint8, Range: See meanings
Response:	status – Type: uint8, Range: See meanings

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 elements of this function:

For mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

For status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletIndustrialDual020mAV2.get_bootloader_mode¶

Function ID:	236
Request:	empty payload
Response:	mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

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

For mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletIndustrialDual020mAV2.set_write_firmware_pointer¶

Function ID:	237
Request:	pointer – Type: uint32, Unit: 1 B, Range: [0 to 2³² - 1]
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.

BrickletIndustrialDual020mAV2.write_firmware¶

Function ID:	238
Request:	data – Type: uint8[64], Range: [0 to 255]
Response:	status – Type: uint8, Range: [0 to 255]

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.

BrickletIndustrialDual020mAV2.write_uid¶

Function ID:	248
Request:	uid – Type: uint32, Range: [0 to 2³² - 1]
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.

BrickletIndustrialDual020mAV2.read_uid¶

Function ID:	249
Request:	empty payload
Response:	uid – Type: uint32, Range: [0 to 2³² - 1]

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