Specifications / Modbus Protocol / API / Bricklets (Discontinued) / Industrial Dual Analog In Bricklet

Modbus - Industrial Dual Analog In Bricklet¶

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

API¶

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

Basic Functions¶

BrickletIndustrialDualAnalogIn.get_voltage¶

Function ID:	1
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	voltage – Type: int32, Unit: 1 mV, Range: [-35000 to 35000]

Returns the voltage for the given channel.

If you want to get the voltage periodically, it is recommended to use the CALLBACK_VOLTAGE callback and set the period with set_voltage_callback_period.

Advanced Functions¶

BrickletIndustrialDualAnalogIn.set_sample_rate¶

Function ID:	8
Request:	rate – Type: uint8, Range: See meanings, Default: 6
Response:	no response

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

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

For rate:

0 = 976 SPS
1 = 488 SPS
2 = 244 SPS
3 = 122 SPS
4 = 61 SPS
5 = 4 SPS
6 = 2 SPS
7 = 1 SPS

BrickletIndustrialDualAnalogIn.get_sample_rate¶

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

Returns the sample rate as set by set_sample_rate.

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

For rate:

0 = 976 SPS
1 = 488 SPS
2 = 244 SPS
3 = 122 SPS
4 = 61 SPS
5 = 4 SPS
6 = 2 SPS
7 = 1 SPS

BrickletIndustrialDualAnalogIn.set_calibration¶

Function ID:	10
Request:	offset – Type: int32[2], Range: [-2²³ to 2²³ - 1] gain – Type: int32[2], Range: [-2²³ to 2²³ - 1]
Response:	no response

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

BrickletIndustrialDualAnalogIn.get_calibration¶

Function ID:	11
Request:	empty payload
Response:	offset – Type: int32[2], Range: [-2²³ to 2²³ - 1] gain – Type: int32[2], Range: [-2²³ to 2²³ - 1]

Returns the calibration as set by set_calibration.

BrickletIndustrialDualAnalogIn.get_adc_values¶

Function ID:	12
Request:	empty payload
Response:	value – Type: int32[2], Range: [-2²³ to 2²³ - 1]

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see set_calibration.

BrickletIndustrialDualAnalogIn.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¶

BrickletIndustrialDualAnalogIn.set_voltage_callback_period¶

Function ID:	2
Request:	channel – Type: uint8, Range: [0 to 1] period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Response:	no response

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

The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

BrickletIndustrialDualAnalogIn.get_voltage_callback_period¶

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

Returns the period as set by set_voltage_callback_period.

BrickletIndustrialDualAnalogIn.set_voltage_callback_threshold¶

Function ID:	4
Request:	channel – Type: uint8, Range: [0 to 1] option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0
Response:	no response

Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback for the given channel.

The following options are possible:

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

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

For option:

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

BrickletIndustrialDualAnalogIn.get_voltage_callback_threshold¶

Function ID:	5
Request:	channel – Type: uint8, Range: [0 to 1]
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by set_voltage_callback_threshold.

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

For option:

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

BrickletIndustrialDualAnalogIn.set_debounce_period¶

Function ID:	6
Request:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Response:	no response

Sets the period with which the threshold callback

CALLBACK_VOLTAGE_REACHED

is triggered, if the threshold

set_voltage_callback_threshold

keeps being reached.

BrickletIndustrialDualAnalogIn.get_debounce_period¶

Function ID:	7
Request:	empty payload
Response:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

Callbacks¶

BrickletIndustrialDualAnalogIn.CALLBACK_VOLTAGE¶

Function ID:	13
Response:	channel – Type: uint8, Range: [0 to 1] voltage – Type: int32, Unit: 1 mV, Range: [-35000 to 35000]

This callback is triggered periodically with the period that is set by set_voltage_callback_period. The response value is the voltage of the channel.

The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

BrickletIndustrialDualAnalogIn.CALLBACK_VOLTAGE_REACHED¶

Function ID:	14
Response:	channel – Type: uint8, Range: [0 to 1] voltage – Type: int32, Unit: 1 mV, Range: [-35000 to 35000]

This callback is triggered when the threshold as set by set_voltage_callback_threshold is reached. The response value is the voltage of the channel.

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