Shell - Analog Out Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

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

uid=XYZ # Change XYZ to the UID of your Analog Out Bricklet

# Set output voltage to 3.3V
tinkerforge call analog-out-bricklet $uid set-voltage 3300

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> – Type: String <function> – Type: 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> – Type: String <callback> – Type: 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> – Type: String <function> – Type: 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 sent and errors are silently ignored, because they cannot be detected.

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

Parameters:	<uid> – Type: String <callback> – Type: 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:	<voltage> – Type: Int, Unit: 1 mV, Range: [0 to 5000], Default: 0
Output:	no output

Sets the voltage. Calling this function will set the mode to 0 (see set-mode).

tinkerforge call analog-out-bricklet <uid> get-voltage¶

Output:	voltage – Type: Int, Unit: 1 mV, Range: [0 to 5000], Default: 0

Returns the voltage as set by set-voltage.

tinkerforge call analog-out-bricklet <uid> set-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols, Default: 1
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 V. You can jump to a higher output voltage directly by calling set-voltage.

The following symbols are available for this function:

For <mode>:

• mode-analog-value = 0
• mode-1k-to-ground = 1
• mode-100k-to-ground = 2
• mode-500k-to-ground = 3

tinkerforge call analog-out-bricklet <uid> get-mode¶

Output:	mode – Type: Int, Range: See symbols, Default: 1

Returns the mode as set by set-mode.

The following symbols are available for this function:

For mode:

• mode-analog-value = 0
• mode-1k-to-ground = 1
• mode-100k-to-ground = 2
• mode-500k-to-ground = 3

Advanced Functions¶

tinkerforge call analog-out-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here.