Shell - Analog Out Bricklet
This is the description of the Shell API bindings for the Analog Out Bricklet. General information and technical
specifications for the 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
Download (example-simple.sh)
| #!/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 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 analog-out-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters: |
- <uid> -- string
- <function> -- string
|
The call command is used to call a function of the 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 Analog Out Bricklet and exits
-
tinkerforge dispatch analog-out-bricklet [<option>..] <uid> <callback>
Parameters: |
- <uid> -- string
- <callback> -- string
|
The dispatch command is used to dispatch a callback of the 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 Analog Out Bricklet and exits
-
tinkerforge call 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 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 analog-out-bricklet <uid> set-voltage <voltage>
Parameters: |
|
Output: | no output
|
Sets the voltage in mV. The possible range is 0V to 5V (0-5000).
Calling this function will set the mode to 0 (see set-mode).
The default value is 0 (with mode 1).
-
tinkerforge call analog-out-bricklet <uid> get-voltage
-
Returns the voltage as set by set-voltage.
-
tinkerforge call analog-out-bricklet <uid> set-mode <mode>
Parameters: |
- <mode> -- int (has symbols)
|
Output: | no output
|
Sets the mode of the analog value. Possible modes:
- 0: Normal Mode (Analog value as set by set-voltage is applied)
- 1: 1k Ohm resistor to ground
- 2: 100k Ohm resistor to ground
- 3: 500k Ohm resistor to ground
Setting the mode to 0 will result in an output voltage of 0. You can jump
to a higher output voltage directly by calling set-voltage.
The default mode is 1.
The following symbols are available for this function:
- analog-value = 0, for <mode>
- 1k-to-ground = 1, for <mode>
- 100k-to-ground = 2, for <mode>
- 500k-to-ground = 3, for <mode>
-
tinkerforge call analog-out-bricklet <uid> get-mode
Output: |
- mode -- int (has symbols)
|
Returns the mode as set by set-mode.
The following symbols are available for this function:
- analog-value = 0, for mode
- 1k-to-ground = 1, for mode
- 100k-to-ground = 2, for mode
- 500k-to-ground = 3, for mode
Advanced Functions
-
tinkerforge call 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.