Shell - Industrial Analog Out Bricklet¶

Simple Current¶

Download (example-simple-current.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

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

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

# Set output current to 4.5mA
tinkerforge call industrial-analog-out-bricklet $uid set-current 4500
tinkerforge call industrial-analog-out-bricklet $uid enable

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-bricklet $uid disable

Simple Voltage¶

Download (example-simple-voltage.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

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

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

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

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-bricklet $uid disable

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> – Type: String <function> – Type: 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> – Type: String <callback> – Type: 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> – 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 industrial-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 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 – Type: Bool, Default: false

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

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

Parameters:	<voltage> – Type: Int, Unit: 1 mV, Range: [0 to 10000]
Output:	no output

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

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

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

Returns the voltage as set by set-voltage.

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

Parameters:	<current> – Type: Int, Unit: 1 µA, Range: [0 to 24000]
Output:	no output

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

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

Output:	current – Type: Int, Unit: 1 µA, Range: [0 to 24000]

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> – Type: Int, Range: See symbols, Default: 1 <current-range> – Type: Int, Range: See symbols, Default: 0
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:

For <voltage-range>:

• voltage-range-0-to-5v = 0
• voltage-range-0-to-10v = 1

For <current-range>:

• current-range-4-to-20ma = 0
• current-range-0-to-20ma = 1
• current-range-0-to-24ma = 2

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

Output:	voltage-range – Type: Int, Range: See symbols, Default: 1 current-range – Type: Int, Range: See symbols, Default: 0

Returns the configuration as set by set-configuration.

The following symbols are available for this function:

For voltage-range:

• voltage-range-0-to-5v = 0
• voltage-range-0-to-10v = 1

For current-range:

• current-range-4-to-20ma = 0
• current-range-0-to-20ma = 1
• current-range-0-to-24ma = 2

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