Shell - Industrial Dual Analog In Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# Shell - Industrial Dual Analog In 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 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.

## Examples

The example code below is Public Domain (CC0 1.0).

## API

Possible exit codes for all `tinkerforge` commands are:

- 1: interrupted (ctrl+c)
- 2: syntax error
- 21: Python 2.5 or newer is required
- 22: Python `argparse` module is missing
- 23: socket error
- 24: other exception
- 25: invalid placeholder in format string
- 26: authentication error
- 201: timeout occurred
- 209: invalid argument value
- 210: function is not supported
- 211: unknown error

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.

### Command Structure

The common options of the `call` and `dispatch` commands are documented here. The specific command structure is shown below.

tinkerforge `call` `industrial-dual-analog-in-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `call` command is used to call a function of the Industrial Dual Analog In Bricklet. It can take several options:

  - `--help` shows help for the specific `call` command and exits
  - `--list-functions` shows a list of known functions of the Industrial Dual Analog In Bricklet and exits

tinkerforge `dispatch` `industrial-dual-analog-in-bricklet` [<option>..] <uid> <callback>

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `dispatch` command is used to dispatch a callback of the Industrial Dual Analog In Bricklet. It can take several options:

  - `--help` shows help for the specific `dispatch` command and exits
  - `--list-callbacks` shows a list of known callbacks of the Industrial Dual Analog In Bricklet and exits

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `<function>` [<option>..] [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `<function>` to be called can take different options depending of its kind. All functions can take the following options:

  - `--help` shows help for the specific function and exits

  Getter functions can take the following options:

  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

  Setter functions can take the following options:

  - `--expect-response` requests response and waits for it

  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.

tinkerforge dispatch `industrial-dual-analog-in-bricklet` <uid> `<callback>` [<option>..]

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `<callback>` to be dispatched can take several options:

  - `--help` shows help for the specific callback and exits
  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

### Basic Functions

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-voltage` <channel>

  Parameters:

  - <channel> -- int

  Output:

  - voltage -- int

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

### Advanced Functions

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `set-sample-rate` <rate>

  Parameters:

  - <rate> -- int (has symbols)

  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:

  - `976-sps` = 0, for <rate>
  - `488-sps` = 1, for <rate>
  - `244-sps` = 2, for <rate>
  - `122-sps` = 3, for <rate>
  - `61-sps` = 4, for <rate>
  - `4-sps` = 5, for <rate>
  - `2-sps` = 6, for <rate>
  - `1-sps` = 7, for <rate>

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-sample-rate`

  Output:

  - rate -- int (has symbols)

  Returns the sample rate as set by `set-sample-rate`.

  The following symbols are available for this function:

  - `976-sps` = 0, for rate
  - `488-sps` = 1, for rate
  - `244-sps` = 2, for rate
  - `122-sps` = 3, for rate
  - `61-sps` = 4, for rate
  - `4-sps` = 5, for rate
  - `2-sps` = 6, for rate
  - `1-sps` = 7, for rate

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `set-calibration` <offset> <gain>

  Parameters:

  - <offset> -- int,int
  - <gain> -- int,int

  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

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-calibration`

  Output:

  - offset -- int,int
  - gain -- int,int

  Returns the calibration as set by `set-calibration`.

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-adc-values`

  Output:

  - value -- int,int

  Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see `set-calibration`.

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-identity`

  Output:

  - uid -- string
  - connected-uid -- string
  - position -- char
  - hardware-version -- int,int,int
  - firmware-version -- int,int,int
  - device-identifier -- int (has symbols)

  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

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `set-voltage-callback-period` <channel> <period>

  Parameters:

  - <channel> -- int
  - <period> -- int

  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.

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-voltage-callback-period` <channel>

  Parameters:

  - <channel> -- int

  Output:

  - period -- int

  Returns the period as set by `set-voltage-callback-period`.

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `set-voltage-callback-threshold` <channel> <option> <min> <max>

  Parameters:

  - <channel> -- int
  - <option> -- char (has symbols)
  - <min> -- int
  - <max> -- int

  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:

  - `off` = x, for <option>
  - `outside` = o, for <option>
  - `inside` = i, for <option>
  - `smaller` = <, for <option>
  - `greater` = >, for <option>

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-voltage-callback-threshold` <channel>

  Parameters:

  - <channel> -- int

  Output:

  - option -- char (has symbols)
  - min -- int
  - max -- int

  Returns the threshold as set by `set-voltage-callback-threshold`.

  The following symbols are available for this function:

  - `off` = x, for option
  - `outside` = o, for option
  - `inside` = i, for option
  - `smaller` = <, for option
  - `greater` = >, for option

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `set-debounce-period` <debounce>

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the period in ms with which the threshold callback

  - `voltage-reached`

  is triggered, if the threshold

  - `set-voltage-callback-threshold`

  keeps being reached.

  The default value is 100.

tinkerforge call `industrial-dual-analog-in-bricklet` <uid> `get-debounce-period`

  Output:

  - debounce -- int

  Returns the debounce period as set by `set-debounce-period`.

### Callbacks

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.

tinkerforge dispatch `industrial-dual-analog-in-bricklet` <uid> `voltage`

  Output:

  - channel -- int
  - voltage -- int

  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.

tinkerforge dispatch `industrial-dual-analog-in-bricklet` <uid> `voltage-reached`

  Output:

  - channel -- int
  - voltage -- int

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

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