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 Shell API bindings 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.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Possible exit codes for all tinkerforge commands are:
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.
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Industrial Dual Analog In Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Industrial Dual Analog In Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: |
|
Returns the voltage for the given channel in mV.
If you want to get the voltage periodically, it is recommended to use the callback voltage and set the period with set-voltage-callback-period.
Parameters: |
|
---|---|
Output: | no output |
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.
The following symbols are available for this function:
Output: |
|
---|
Returns the sample rate as set by set-sample-rate.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
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
Output: |
|
---|
Returns the calibration as set by set-calibration.
Output: |
|
---|
Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see set-calibration.
Output: |
|
---|
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the voltage callback is triggered periodically for the given channel. A value of 0 turns the callback off.
voltage is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Parameters: |
|
---|---|
Output: |
|
Returns the period as set by set-voltage-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the 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).
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: |
|
Returns the threshold as set by set-voltage-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch industrial-dual-analog-in-bricklet <uid> example
The available callbacks are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-voltage-callback-period. The parameter is the voltage of the channel.
voltage is only triggered if the voltage has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-voltage-callback-threshold is reached. The parameter 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.