Modbus - Voltage/Current Bricklet 2.0

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

API

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

Basic Functions

BrickletVoltageCurrentV2.get_current
Function ID:

1

Request:

empty payload

Response:
  • current -- int32

Returns the current. The value is in mA and between -20000mA and 20000mA.

If you want to get the value periodically, it is recommended to use the CALLBACK_CURRENT callback. You can set the callback configuration with set_current_callback_configuration.

BrickletVoltageCurrentV2.get_voltage
Function ID:

5

Request:

empty payload

Response:
  • voltage -- int32

Returns the voltage. The value is in mV and between 0mV and 36000mV.

If you want to get the value periodically, it is recommended to use the CALLBACK_VOLTAGE callback. You can set the callback configuration with set_voltage_callback_configuration.

BrickletVoltageCurrentV2.get_power
Function ID:

9

Request:

empty payload

Response:
  • power -- int32

Returns the power. The value is in mW and between 0mV and 720000mW.

If you want to get the value periodically, it is recommended to use the CALLBACK_POWER callback. You can set the callback configuration with set_power_callback_configuration.

BrickletVoltageCurrentV2.set_configuration
Function ID:

13

Request:
  • averaging -- uint8
  • voltage_conversion_time -- uint8
  • current_conversion_time -- uint8
Response:

no response

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

Averaging:

Value Number of Averages
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Voltage/Current conversion:

Value Conversion time
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.

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

  • 0: 1, for averaging
  • 1: 4, for averaging
  • 2: 16, for averaging
  • 3: 64, for averaging
  • 4: 128, for averaging
  • 5: 256, for averaging
  • 6: 512, for averaging
  • 7: 1024, for averaging
BrickletVoltageCurrentV2.get_configuration
Function ID:

14

Request:

empty payload

Response:
  • averaging -- uint8
  • voltage_conversion_time -- uint8
  • current_conversion_time -- uint8

Returns the configuration as set by set_configuration.

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

  • 0: 1, for averaging
  • 1: 4, for averaging
  • 2: 16, for averaging
  • 3: 64, for averaging
  • 4: 128, for averaging
  • 5: 256, for averaging
  • 6: 512, for averaging
  • 7: 1024, for averaging

Advanced Functions

BrickletVoltageCurrentV2.set_calibration
Function ID:

15

Request:
  • voltage_multiplier -- uint16
  • voltage_divisor -- uint16
  • current_multiplier -- uint16
  • current_divisor -- uint16
Response:

no response

Since the ADC and the shunt resistor used for the measurements are not perfect they need to be calibrated by a multiplier and a divisor if a very precise reading is needed.

For example, if you are expecting a current of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the current multiplier to 1000 and the divisor to 1023. The same applies for the voltage.

BrickletVoltageCurrentV2.get_calibration
Function ID:

16

Request:

empty payload

Response:
  • voltage_multiplier -- uint16
  • voltage_divisor -- uint16
  • current_multiplier -- uint16
  • current_divisor -- uint16

Returns the calibration as set by set_calibration.

BrickletVoltageCurrentV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletVoltageCurrentV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletVoltageCurrentV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

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

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletVoltageCurrentV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletVoltageCurrentV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletVoltageCurrentV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletVoltageCurrentV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletVoltageCurrentV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletVoltageCurrentV2.reset
Function ID:243
Request:empty payload
Response:no response

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletVoltageCurrentV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletVoltageCurrentV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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

BrickletVoltageCurrentV2.set_current_callback_configuration
Function ID:

2

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_CURRENT callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, '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
BrickletVoltageCurrentV2.get_current_callback_configuration
Function ID:

3

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_current_callback_configuration.

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

6

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

The period in ms is the period with which the CALLBACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_VOLTAGE callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, '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
BrickletVoltageCurrentV2.get_voltage_callback_configuration
Function ID:

7

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_voltage_callback_configuration.

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

10

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_POWER callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, '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
BrickletVoltageCurrentV2.get_power_callback_configuration
Function ID:

11

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_power_callback_configuration.

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

Callbacks

BrickletVoltageCurrentV2.CALLBACK_CURRENT
Function ID:

4

Response:
  • current -- int32

This callback is triggered periodically according to the configuration set by set_current_callback_configuration.

The response value is the same as get_current.

BrickletVoltageCurrentV2.CALLBACK_VOLTAGE
Function ID:

8

Response:
  • voltage -- int32

This callback is triggered periodically according to the configuration set by set_voltage_callback_configuration.

The response value is the same as get_voltage.

BrickletVoltageCurrentV2.CALLBACK_POWER
Function ID:

12

Response:
  • power -- int32

This callback is triggered periodically according to the configuration set by set_power_callback_configuration.

The response value is the same as get_power.