Modbus - AC Current Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

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

API

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

Basic Functions

BrickletACCurrent.get_current
Function ID:

1

Request:

empty payload

Response:
  • current -- uint16

TODO

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

BrickletACCurrent.set_configuration
Function ID:

15

Request:
  • current_range -- uint8
Response:

no response

BrickletACCurrent.get_configuration
Function ID:

16

Request:

empty payload

Response:
  • current_range -- uint8

Advanced Functions

BrickletACCurrent.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 CALLBACK_ANALOG_VALUE and set the period with set_analog_value_callback_period.

BrickletACCurrent.set_moving_average
Function ID:

13

Request:
  • average -- uint8
Response:

no response

Sets the length of a moving averaging for the moisture value.

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.

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

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

BrickletACCurrent.set_current_callback_period
Function ID:

3

Request:
  • period -- uint32
Response:

no response

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

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

The default value is 0.

BrickletACCurrent.get_current_callback_period
Function ID:

4

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_current_callback_period.

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

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

The default value is 0.

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

BrickletACCurrent.set_current_callback_threshold
Function ID:

7

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

BrickletACCurrent.get_current_callback_threshold
Function ID:

8

Request:

empty payload

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

Returns the threshold as set by set_current_callback_threshold.

BrickletACCurrent.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).

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

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

BrickletACCurrent.get_debounce_period
Function ID:

12

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletACCurrent.CALLBACK_CURRENT
Function ID:

17

Response:
  • current -- uint16

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.

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

BrickletACCurrent.CALLBACK_ANALOG_VALUE
Function ID:

18

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.

CALLBACK_ANALOG_VALUE is only triggered if the current has changed since the last triggering.

BrickletACCurrent.CALLBACK_CURRENT_REACHED
Function ID:

19

Response:
  • current -- uint16

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.

BrickletACCurrent.CALLBACK_ANALOG_VALUE_REACHED
Function ID:

20

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.

Creative Commons Licence The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.