Shell - Industrial Analog Out Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Shell - Industrial Analog Out 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 Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out 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).

### Simple Current

Download (example-simple-current.sh)

    1
    2
    3
    4
    5
    6
    7
    8

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=XYZ

    # set a current of 4.5mA
    tinkerforge call industrial-analog-out-bricklet $uid set-current 4500

### Simple Voltage

Download (example-simple-voltage.sh)

    1
    2
    3
    4
    5
    6
    7
    8

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=XYZ

    # set a voltage of 3.3V
    tinkerforge call industrial-analog-out-bricklet $uid set-voltage 3300

## 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

### Command Structure

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

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

  Parameters:

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

  The `call` command is used to call a function of the Industrial Analog Out 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 Analog Out Bricklet and exits

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

  Parameters:

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

  The `dispatch` command is used to dispatch a callback of the Industrial Analog Out 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 Analog Out Bricklet and exits

tinkerforge call `industrial-analog-out-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-analog-out-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-analog-out-bricklet` <uid> `enable`

  Output: | no output

  Enables the output of voltage and current.

  The default is disabled.

tinkerforge call `industrial-analog-out-bricklet` <uid> `disable`

  Output: | no output

  Disables the output of voltage and current.

  The default is disabled.

tinkerforge call `industrial-analog-out-bricklet` <uid> `is-enabled`

  Output:

  - enabled -- bool

  Returns true if output of voltage and current is enabled, false otherwise.

tinkerforge call `industrial-analog-out-bricklet` <uid> `set-voltage` <voltage>

  Parameters:

  - <voltage> -- int

  Output: | no output

  Sets the output voltage in mV.

tinkerforge call `industrial-analog-out-bricklet` <uid> `get-voltage`

  Output:

  - voltage -- int

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

tinkerforge call `industrial-analog-out-bricklet` <uid> `set-current` <current>

  Parameters:

  - <current> -- int

  Output: | no output

  Sets the output current in µA.

tinkerforge call `industrial-analog-out-bricklet` <uid> `get-current`

  Output:

  - current -- int

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

### Advanced Functions

tinkerforge call `industrial-analog-out-bricklet` <uid> `set-configuration` <voltage-range> <current-range>

  Parameters:

  - <voltage-range> -- int (has symbols)
  - <current-range> -- int (has symbols)

  Output: | no output

  Configures the voltage and current range.

  Possible voltage ranges are:

  - 0V to 5V
  - 0V to 10V

  Possible current ranges are:

  - 4mA to 20mA
  - 0mA to 20mA
  - 0mA to 24mA

  The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

  The following symbols are available for this function:

  - `0-to-5v` = 0, for <voltage-range>
  - `0-to-10v` = 1, for <voltage-range>
  - `4-to-20ma` = 0, for <current-range>
  - `0-to-20ma` = 1, for <current-range>
  - `0-to-24ma` = 2, for <current-range>

tinkerforge call `industrial-analog-out-bricklet` <uid> `get-configuration`

  Output:

  - voltage-range -- int (has symbols)
  - current-range -- int (has symbols)

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

  The following symbols are available for this function:

  - `0-to-5v` = 0, for voltage-range
  - `0-to-10v` = 1, for voltage-range
  - `4-to-20ma` = 0, for current-range
  - `0-to-20ma` = 1, for current-range
  - `0-to-24ma` = 2, for current-range

tinkerforge call `industrial-analog-out-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.

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