This is the description of the TCP/IP protocol for the Current12 Bricklet. General information and technical specifications for the Current12 Bricklet are summarized in its hardware description.
A general description of the TCP/IP protocol structure can be found here.
Function ID: | 1 |
---|---|
Request: | empty payload |
Response: |
|
Returns the current of the sensor. The value is in mA and between -12500mA and 12500mA.
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.
Function ID: | 2 |
---|---|
Request: | empty payload |
Response: | no response |
Calibrates the 0 value of the sensor. You have to call this function when there is no current present.
The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.
The resulting calibration will be saved on the EEPROM of the Current Bricklet.
Function ID: | 3 |
---|---|
Request: | empty payload |
Response: |
|
Returns true if more than 12.5A were measured.
Note
To reset this value you have to power cycle the Bricklet.
Function ID: | 4 |
---|---|
Request: | empty payload |
Response: |
|
Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.
Note
The value returned by get_current is averaged over several samples to yield less noise, while get_analog_value gives back raw unfiltered analog values. The only reason to use get_analog_value is, if you need the full resolution of the analog-to-digital converter.
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.
Function ID: | 255 |
---|---|
Request: | empty payload |
Response: |
|
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.
Function ID: | 5 |
---|---|
Request: |
|
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.
Function ID: | 6 |
---|---|
Request: | empty payload |
Response: |
|
Returns the period as set by set_current_callback_period.
Function ID: | 7 |
---|---|
Request: |
|
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.
Function ID: | 8 |
---|---|
Request: | empty payload |
Response: |
|
Returns the period as set by set_analog_value_callback_period.
Function ID: | 9 |
---|---|
Request: |
|
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).
Function ID: | 10 |
---|---|
Request: | empty payload |
Response: |
|
Returns the threshold as set by set_current_callback_threshold.
Function ID: | 11 |
---|---|
Request: |
|
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).
Function ID: | 12 |
---|---|
Request: | empty payload |
Response: |
|
Returns the threshold as set by set_analog_value_callback_threshold.
Function ID: | 13 |
---|---|
Request: |
|
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.
Function ID: | 14 |
---|---|
Request: | empty payload |
Response: |
|
Returns the debounce period as set by set_debounce_period.
Function ID: | 15 |
---|---|
Response: |
|
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.
Function ID: | 16 |
---|---|
Response: |
|
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.
Function ID: | 17 |
---|---|
Response: |
|
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.
Function ID: | 18 |
---|---|
Response: |
|
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.
Function ID: | 19 |
---|---|
Response: | empty payload |
This callback is triggered when an over current is measured (see is_over_current).