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 -- uint16

Returns the measured voltage. The value is in mV and between 0V and 42V. 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 -- uint16

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

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 -- uint8
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.

The range for the averaging is 1-50.

The default value is 50.

BrickletAnalogInV2.get_moving_average
Function ID:

14

Request:

empty payload

Response:
  • average -- uint8

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

BrickletAnalogInV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletAnalogInV2.set_voltage_callback_period
Function ID:

3

Request:
  • period -- uint32
Response:

no response

Sets the period in ms 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.

The default value is 0.

BrickletAnalogInV2.get_voltage_callback_period
Function ID:

4

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_voltage_callback_period.

BrickletAnalogInV2.set_analog_value_callback_period
Function ID:

5

Request:
  • period -- uint32
Response:

no response

Sets the period in ms 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.

The default value is 0.

BrickletAnalogInV2.get_analog_value_callback_period
Function ID:

6

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_analog_value_callback_period.

BrickletAnalogInV2.set_voltage_callback_threshold
Function ID:

7

Request:
  • option -- char
  • min -- uint16
  • max -- uint16
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 default value is ('x', 0, 0).

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAnalogInV2.get_voltage_callback_threshold
Function ID:

8

Request:

empty payload

Response:
  • option -- char
  • min -- uint16
  • max -- uint16

Returns the threshold as set by set_voltage_callback_threshold.

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAnalogInV2.set_analog_value_callback_threshold
Function ID:

9

Request:
  • option -- char
  • min -- uint16
  • max -- uint16
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 default value is ('x', 0, 0).

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAnalogInV2.get_analog_value_callback_threshold
Function ID:

10

Request:

empty payload

Response:
  • option -- char
  • min -- uint16
  • max -- uint16

Returns the threshold as set by set_analog_value_callback_threshold.

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAnalogInV2.set_debounce_period
Function ID:

11

Request:
  • debounce -- uint32
Response:

no response

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletAnalogInV2.get_debounce_period
Function ID:

12

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletAnalogInV2.CALLBACK_VOLTAGE
Function ID:

15

Response:
  • voltage -- uint16

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 -- uint16

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 -- uint16

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 -- uint16

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.