This is the description of the TCP/IP protocol for the Analog In Bricklet. General information and technical specifications for the Analog In 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 voltage of the sensor. The value is in mV and between 0V and 45V. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.
If you want to get the voltage periodically, it is recommended to use the callback CALLBACK_VOLTAGE and set the period with set_voltage_callback_period.
Function ID: | 17 |
---|---|
Request: |
|
Response: | no response |
Sets the measurement range. Possible ranges:
The default measurement range is 0.
New in version 2.0.1 (Plugin).
Function ID: | 2 |
---|---|
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_voltage 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: | 19 |
---|---|
Request: |
|
Response: | no response |
Set the length of a averaging for the voltage value.
Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.
The default value is 50.
New in version 2.0.3 (Plugin).
Function ID: | 20 |
---|---|
Request: | empty payload |
Response: |
|
Returns the averaging configuration as set by set_averaging.
New in version 2.0.3 (Plugin).
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: | 3 |
---|---|
Request: |
|
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.
CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Function ID: | 4 |
---|---|
Request: | empty payload |
Response: |
|
Returns the period as set by set_voltage_callback_period.
Function ID: | 5 |
---|---|
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: | 6 |
---|---|
Request: | empty payload |
Response: |
|
Returns the period as set by set_analog_value_callback_period.
Function ID: | 7 |
---|---|
Request: |
|
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).
Function ID: | 8 |
---|---|
Request: | empty payload |
Response: |
|
Returns the threshold as set by set_voltage_callback_threshold.
Function ID: | 9 |
---|---|
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: | 10 |
---|---|
Request: | empty payload |
Response: |
|
Returns the threshold as set by set_analog_value_callback_threshold.
Function ID: | 11 |
---|---|
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: | 12 |
---|---|
Request: | empty payload |
Response: |
|
Returns the debounce period as set by set_debounce_period.
Function ID: | 13 |
---|---|
Response: |
|
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.
CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
Function ID: | 14 |
---|---|
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 voltage has changed since the last triggering.
Function ID: | 15 |
---|---|
Response: |
|
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.
Function ID: | 16 |
---|---|
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.