MQTT - Industrial Dual 0-20mA Bricklet¶

Simple¶

Download (example-simple.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

setup:
    # Get current current from sensor 1
    subscribe to tinkerforge/response/industrial_dual_0_20ma_bricklet/XYZ/get_current
    publish '{"sensor": 1}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/get_current

Callback¶

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

setup:
    # Handle incoming current callbacks
    subscribe to tinkerforge/callback/industrial_dual_0_20ma_bricklet/XYZ/current
    publish '{"register": true}' to tinkerforge/register/industrial_dual_0_20ma_bricklet/XYZ/current # Register current callback

    # Set period for current (sensor 1) callback to 1s (1000ms)
    # Note: The current (sensor 1) callback is only called every second
    #       if the current (sensor 1) has changed since the last call!
    publish '{"sensor": 1, "period": 1000}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/set_current_callback_period

Threshold¶

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/set_debounce_period

    # Handle incoming current reached callbacks
    subscribe to tinkerforge/callback/industrial_dual_0_20ma_bricklet/XYZ/current_reached
    publish '{"register": true}' to tinkerforge/register/industrial_dual_0_20ma_bricklet/XYZ/current_reached # Register current_reached callback

    # Configure threshold for current (sensor 1) "greater than 10 mA"
    publish '{"sensor": 1, "option": "greater", "min": 10000000, "max": 0}' to tinkerforge/request/industrial_dual_0_20ma_bricklet/XYZ/set_current_callback_threshold

Basic Functions¶

request/industrial_dual_0_20ma_bricklet/<UID>/get_current¶

Request:	sensor – Type: int, Range: [0 to 1]
Response:	current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

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

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 register/industrial_dual_0_20ma_bricklet/<UID>/current callback and set the period with request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period.

Advanced Functions¶

request/industrial_dual_0_20ma_bricklet/<UID>/set_sample_rate¶

Request:	rate – Type: int, Range: See symbols, 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 symbols are available for this function:

For rate:

• "240_sps" = 0
• "60_sps" = 1
• "15_sps" = 2
• "4_sps" = 3

request/industrial_dual_0_20ma_bricklet/<UID>/get_sample_rate¶

Request:	empty payload
Response:	rate – Type: int, Range: See symbols, Default: 3

Returns the sample rate as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_sample_rate.

The following symbols are available for this function:

For rate:

• "240_sps" = 0
• "60_sps" = 1
• "15_sps" = 2
• "4_sps" = 3

request/industrial_dual_0_20ma_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: 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', '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. 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 Dual 0-20mA's name in a human readable form.

Callback Configuration Functions¶

request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period¶

Request:	sensor – Type: int, Range: [0 to 1] period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the register/industrial_dual_0_20ma_bricklet/<UID>/current callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The register/industrial_dual_0_20ma_bricklet/<UID>/current callback is only triggered if the current has changed since the last triggering.

request/industrial_dual_0_20ma_bricklet/<UID>/get_current_callback_period¶

Request:	sensor – Type: int, Range: [0 to 1]
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period.

request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold¶

Request:	sensor – Type: int, Range: [0 to 1] option – Type: char, Range: See symbols, Default: "x" min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
Response:	no response

Sets the thresholds for the register/industrial_dual_0_20ma_bricklet/<UID>/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 following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/industrial_dual_0_20ma_bricklet/<UID>/get_current_callback_threshold¶

Request:	sensor – Type: int, Range: [0 to 1]
Response:	option – Type: char, Range: See symbols, Default: "x" min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold.

The following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/industrial_dual_0_20ma_bricklet/<UID>/set_debounce_period¶

Request:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:	no response

Sets the period with which the threshold callback

• register/industrial_dual_0_20ma_bricklet/<UID>/current_reached

is triggered, if the threshold

• request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold

keeps being reached.

request/industrial_dual_0_20ma_bricklet/<UID>/get_debounce_period¶

Request:	empty payload
Response:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_debounce_period.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/industrial_dual_0_20ma_bricklet/<UID>/current¶

Register Request:	register – Type: bool
Callback Response:	sensor – Type: int, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

A callback can be registered for this event by publishing to the .../register/industrial_dual_0_20ma_bricklet/<UID>/current[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/industrial_dual_0_20ma_bricklet/<UID>/current[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_period. The callback payload is the current of the sensor.

The register/industrial_dual_0_20ma_bricklet/<UID>/current callback is only triggered if the current has changed since the last triggering.

register/industrial_dual_0_20ma_bricklet/<UID>/current_reached¶

Register Request:	register – Type: bool
Callback Response:	sensor – Type: int, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

A callback can be registered for this event by publishing to the .../register/industrial_dual_0_20ma_bricklet/<UID>/current_reached[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/industrial_dual_0_20ma_bricklet/<UID>/current_reached[/<SUFFIX>] topic for each registered suffix.

This callback is triggered when the threshold as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_current_callback_threshold is reached. The callback payload is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by request/industrial_dual_0_20ma_bricklet/<UID>/set_debounce_period.