Specifications / Modbus Protocol / API / Bricklets (Discontinued) / Voltage/Current Bricklet

Modbus - Voltage/Current Bricklet¶

This is the description of the Modbus protocol for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.

API¶

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

Basic Functions¶

BrickletVoltageCurrent.get_current¶

Function ID:	1
Request:	empty payload
Response:	current – Type: int32, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with set_current_callback_period.

BrickletVoltageCurrent.get_voltage¶

Function ID:	2
Request:	empty payload
Response:	voltage – Type: int32, Unit: 1 mV, Range: [0 to 36000]

Returns the voltage.

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.

BrickletVoltageCurrent.get_power¶

Function ID:	3
Request:	empty payload
Response:	power – Type: int32, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the power periodically, it is recommended to use the CALLBACK_POWER callback and set the period with set_power_callback_period.

BrickletVoltageCurrent.set_configuration¶

Function ID:	4
Request:	averaging – Type: uint8, Range: See meanings, Default: 3 voltage_conversion_time – Type: uint8, Range: See meanings, Default: 4 current_conversion_time – Type: uint8, Range: See meanings, Default: 4
Response:	no response

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

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

For averaging:

0 = 1
1 = 4
2 = 16
3 = 64
4 = 128
5 = 256
6 = 512
7 = 1024

For voltage_conversion_time:

0 = 140us
1 = 204us
2 = 332us
3 = 588us
4 = 1.1ms
5 = 2.116ms
6 = 4.156ms
7 = 8.244ms

For current_conversion_time:

0 = 140us
1 = 204us
2 = 332us
3 = 588us
4 = 1.1ms
5 = 2.116ms
6 = 4.156ms
7 = 8.244ms

BrickletVoltageCurrent.get_configuration¶

Function ID:	5
Request:	empty payload
Response:	averaging – Type: uint8, Range: See meanings, Default: 3 voltage_conversion_time – Type: uint8, Range: See meanings, Default: 4 current_conversion_time – Type: uint8, Range: See meanings, Default: 4

Returns the configuration as set by set_configuration.

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

For averaging:

0 = 1
1 = 4
2 = 16
3 = 64
4 = 128
5 = 256
6 = 512
7 = 1024

For voltage_conversion_time:

0 = 140us
1 = 204us
2 = 332us
3 = 588us
4 = 1.1ms
5 = 2.116ms
6 = 4.156ms
7 = 8.244ms

For current_conversion_time:

0 = 140us
1 = 204us
2 = 332us
3 = 588us
4 = 1.1ms
5 = 2.116ms
6 = 4.156ms
7 = 8.244ms

Advanced Functions¶

BrickletVoltageCurrent.set_calibration¶

Function ID:	6
Request:	gain_multiplier – Type: uint16, Range: [0 to 2¹⁶ - 1] gain_divisor – Type: uint16, Range: [0 to 2¹⁶ - 1]
Response:	no response

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

BrickletVoltageCurrent.get_calibration¶

Function ID:	7
Request:	empty payload
Response:	gain_multiplier – Type: uint16, Range: [0 to 2¹⁶ - 1] gain_divisor – Type: uint16, Range: [0 to 2¹⁶ - 1]

Returns the calibration as set by set_calibration.

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

BrickletVoltageCurrent.set_current_callback_period¶

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

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

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletVoltageCurrent.get_current_callback_period¶

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

Returns the period as set by set_current_callback_period.

BrickletVoltageCurrent.set_voltage_callback_period¶

Function ID:	10
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.

BrickletVoltageCurrent.get_voltage_callback_period¶

Function ID:	11
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.

BrickletVoltageCurrent.set_power_callback_period¶

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

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

The CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

BrickletVoltageCurrent.get_power_callback_period¶

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

Returns the period as set by get_power_callback_period.

BrickletVoltageCurrent.set_current_callback_threshold¶

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

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.

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 meanings are defined for the elements of this function:

For option:

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

BrickletVoltageCurrent.get_current_callback_threshold¶

Function ID:	15
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by set_current_callback_threshold.

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

For option:

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

BrickletVoltageCurrent.set_voltage_callback_threshold¶

Function ID:	16
Request:	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.

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

BrickletVoltageCurrent.get_voltage_callback_threshold¶

Function ID:	17
Request:	empty payload
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

BrickletVoltageCurrent.set_power_callback_threshold¶

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

Sets the thresholds for the CALLBACK_POWER_REACHED callback.

The following options are possible:

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

BrickletVoltageCurrent.get_power_callback_threshold¶

Function ID:	19
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by set_power_callback_threshold.

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

For option:

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

BrickletVoltageCurrent.set_debounce_period¶

Function ID:	20
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_CURRENT_REACHED,
CALLBACK_VOLTAGE_REACHED,
CALLBACK_POWER_REACHED

are triggered, if the thresholds

set_current_callback_threshold,
set_voltage_callback_threshold,
set_power_callback_threshold

keep being reached.

BrickletVoltageCurrent.get_debounce_period¶

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

BrickletVoltageCurrent.CALLBACK_CURRENT¶

Function ID:	22
Response:	current – Type: int32, Unit: 1 mA, Range: [-20000 to 20000]

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

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletVoltageCurrent.CALLBACK_VOLTAGE¶

Function ID:	23
Response:	voltage – Type: int32, Unit: 1 mV, Range: [0 to 36000]

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.

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

BrickletVoltageCurrent.CALLBACK_POWER¶

Function ID:	24
Response:	power – Type: int32, Unit: 1 mW, Range: [0 to 720000]

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

The CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

BrickletVoltageCurrent.CALLBACK_CURRENT_REACHED¶

Function ID:	25
Response:	current – Type: int32, Unit: 1 mA, Range: [-20000 to 20000]

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

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

BrickletVoltageCurrent.CALLBACK_VOLTAGE_REACHED¶

Function ID:	26
Response:	voltage – Type: int32, Unit: 1 mV, Range: [0 to 36000]

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.

BrickletVoltageCurrent.CALLBACK_POWER_REACHED¶

Function ID:	27
Response:	power – Type: int32, Unit: 1 mA, Range: [-20000 to 20000]

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

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