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 TCP/IP protocol for the Industrial Dual Analog In Bricklet. General information and technical specifications for the Industrial Dual Analog In Bricklet are summarized in its hardware description.
A general description of the TCP/IP protocol structure can be found here.
The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.
Function ID: | 1 |
---|---|
Request: |
|
Response: |
|
Returns the voltage for the given channel in mV.
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: | 8 |
---|---|
Request: |
|
Response: | no response |
Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.
Function ID: | 9 |
---|---|
Request: | empty payload |
Response: |
|
Returns the sample rate as set by set_sample_rate.
Function ID: | 10 |
---|---|
Request: |
|
Response: | no response |
Sets offset and gain of MCP3911 internal calibration registers.
See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function
Function ID: | 11 |
---|---|
Request: | empty payload |
Response: |
|
Returns the calibration as set by set_calibration.
Function ID: | 12 |
---|---|
Request: | empty payload |
Response: |
|
Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see set_calibration.
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: | 2 |
---|---|
Request: |
|
Response: | no response |
Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered periodically for the given channel. 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: | 3 |
---|---|
Request: |
|
Response: |
|
Returns the period as set by set_voltage_callback_period.
Function ID: | 4 |
---|---|
Request: |
|
Response: | no response |
Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback for the given channel.
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: | 5 |
---|---|
Request: |
|
Response: |
|
Returns the threshold as set by set_voltage_callback_threshold.
Function ID: | 6 |
---|---|
Request: |
|
Response: | no response |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Function ID: | 7 |
---|---|
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 channel.
CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
Function ID: | 14 |
---|---|
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 channel.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period.