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

Modbus - Analog In Bricklet 2.0¶

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

API¶

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

Basic Functions¶

BrickletAnalogInV2.get_voltage¶

Function ID:	1
Request:	empty payload
Response:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 42000]

Returns the measured voltage. The resolution is approximately 10mV.

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¶

BrickletAnalogInV2.get_analog_value¶

Function ID:	2
Request:	empty payload
Response:	value – Type: uint16, Range: [0 to 2¹² - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with set_analog_value_callback_period.

BrickletAnalogInV2.set_moving_average¶

Function ID:	13
Request:	average – Type: uint8, Range: [1 to 50], Default: 50
Response:	no response

Sets the length of a moving averaging for the voltage.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

BrickletAnalogInV2.get_moving_average¶

Function ID:	14
Request:	empty payload
Response:	average – Type: uint8, Range: [1 to 50], Default: 50

Returns the length of the moving average as set by set_moving_average.

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

BrickletAnalogInV2.set_voltage_callback_period¶

Function ID:	3
Request:	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. A value of 0 turns the callback off.

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

BrickletAnalogInV2.get_voltage_callback_period¶

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

Returns the period as set by set_voltage_callback_period.

BrickletAnalogInV2.set_analog_value_callback_period¶

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

Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

BrickletAnalogInV2.get_analog_value_callback_period¶

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

Returns the period as set by set_analog_value_callback_period.

BrickletAnalogInV2.set_voltage_callback_threshold¶

Function ID:	7
Request:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0
Response:	no response

Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.

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

BrickletAnalogInV2.get_voltage_callback_threshold¶

Function ID:	8
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Unit: 1 mV, Range: [0 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

BrickletAnalogInV2.set_analog_value_callback_threshold¶

Function ID:	9
Request:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0
Response:	no response

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the analog value is outside the min and max values
'i'	Callback is triggered when the analog value is inside the min and max values
'<'	Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>'	Callback is triggered when the analog value 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

BrickletAnalogInV2.get_analog_value_callback_threshold¶

Function ID:	10
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by set_analog_value_callback_threshold.

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

For option:

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

BrickletAnalogInV2.set_debounce_period¶

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

Sets the period with which the threshold callbacks

CALLBACK_VOLTAGE_REACHED,
CALLBACK_ANALOG_VALUE_REACHED

are triggered, if the thresholds

set_voltage_callback_threshold,
set_analog_value_callback_threshold

keep being reached.

BrickletAnalogInV2.get_debounce_period¶

Function ID:	12
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¶

BrickletAnalogInV2.CALLBACK_VOLTAGE¶

Function ID:	15
Response:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 42000]

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

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

BrickletAnalogInV2.CALLBACK_ANALOG_VALUE¶

Function ID:	16
Response:	value – Type: uint16, Range: [0 to 2¹² - 1]

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

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

BrickletAnalogInV2.CALLBACK_VOLTAGE_REACHED¶

Function ID:	17
Response:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 42000]

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

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

BrickletAnalogInV2.CALLBACK_ANALOG_VALUE_REACHED¶

Function ID:	18
Response:	value – Type: uint16, Range: [0 to 2¹² - 1]

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

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