Shell - Analog In 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 In Bricklet

# Get current voltage
tinkerforge call analog-in-bricklet $uid get-voltage

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/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 In Bricklet

# Handle incoming voltage callbacks
tinkerforge dispatch analog-in-bricklet $uid voltage &

# Set period for voltage callback to 1s (1000ms)
# Note: The voltage callback is only called every second
#       if the voltage has changed since the last call!
tinkerforge call analog-in-bricklet $uid set-voltage-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/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 In Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call analog-in-bricklet $uid set-debounce-period 10000

# Handle incoming voltage reached callbacks
tinkerforge dispatch analog-in-bricklet $uid voltage-reached &

# Configure threshold for voltage "smaller than 5 V"
tinkerforge call analog-in-bricklet $uid set-voltage-callback-threshold threshold-option-smaller 5000 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

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

tinkerforge call analog-in-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

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

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

Parameters:	<uid> – Type: String <callback> – Type: String

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

tinkerforge call analog-in-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-in-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-in-bricklet <uid> get-voltage¶

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

Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.

If you want to get the voltage periodically, it is recommended to use the voltage callback and set the period with set-voltage-callback-period.

tinkerforge call analog-in-bricklet <uid> set-range <range>¶

Parameters:	<range> – Type: Int, Range: See symbols, Default: 0
Output:	no output

Sets the measurement range. Possible ranges:

• 0: Automatically switched
• 1: 0V - 6.05V, ~1.48mV resolution
• 2: 0V - 10.32V, ~2.52mV resolution
• 3: 0V - 36.30V, ~8.86mV resolution
• 4: 0V - 45.00V, ~11.25mV resolution
• 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3 (Plugin)

The following symbols are available for this function:

For <range>:

• range-automatic = 0
• range-up-to-6v = 1
• range-up-to-10v = 2
• range-up-to-36v = 3
• range-up-to-45v = 4
• range-up-to-3v = 5

New in version 2.0.1 (Plugin).

tinkerforge call analog-in-bricklet <uid> get-range¶

Output:	range – Type: Int, Range: See symbols, Default: 0

Returns the measurement range as set by set-range.

The following symbols are available for this function:

For range:

• range-automatic = 0
• range-up-to-6v = 1
• range-up-to-10v = 2
• range-up-to-36v = 3
• range-up-to-45v = 4
• range-up-to-3v = 5

New in version 2.0.1 (Plugin).

Advanced Functions¶

tinkerforge call analog-in-bricklet <uid> get-analog-value¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by get-voltage is averaged over several samples to yield less noise, while get-analog-value gives back raw unfiltered analog values. The only reason to use get-analog-value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the analog-value callback and set the period with set-analog-value-callback-period.

tinkerforge call analog-in-bricklet <uid> set-averaging <average>¶

Parameters:	<average> – Type: Int, Range: [0 to 255], Default: 50
Output:	no output

Set the length of a averaging for the voltage value.

Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

New in version 2.0.3 (Plugin).

tinkerforge call analog-in-bricklet <uid> get-averaging¶

Output:	average – Type: Int, Range: [0 to 255], Default: 50

Returns the averaging configuration as set by set-averaging.

New in version 2.0.3 (Plugin).

tinkerforge call analog-in-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. 

Callback Configuration Functions¶

tinkerforge call analog-in-bricklet <uid> set-voltage-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the voltage callback is triggered periodically. A value of 0 turns the callback off.

The voltage callback is only triggered if the voltage has changed since the last triggering.

tinkerforge call analog-in-bricklet <uid> get-voltage-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

tinkerforge call analog-in-bricklet <uid> set-analog-value-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the analog-value callback is triggered periodically. A value of 0 turns the callback off.

The analog-value callback is only triggered if the analog value has changed since the last triggering.

tinkerforge call analog-in-bricklet <uid> get-analog-value-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-analog-value-callback-period.

tinkerforge call analog-in-bricklet <uid> set-voltage-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0 <max> – Type: Int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
Output:	no output

Sets the thresholds for the voltage-reached callback.

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 following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call analog-in-bricklet <uid> get-voltage-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0 max – Type: Int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

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

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call analog-in-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Range: [0 to 216 - 1], Default: 0 <max> – Type: Int, Range: [0 to 216 - 1], Default: 0
Output:	no output

Sets the thresholds for the analog-value-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the analog value is outside the min and max values
'i'	Callback is triggered when the analog value is inside the min and max values
'<'	Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>'	Callback is triggered when the analog value is greater than the min value (max is ignored)

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call analog-in-bricklet <uid> get-analog-value-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Range: [0 to 216 - 1], Default: 0 max – Type: Int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by set-analog-value-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call analog-in-bricklet <uid> set-debounce-period <debounce>¶

Parameters:	<debounce> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Output:	no output

Sets the period with which the threshold callbacks

• voltage-reached,
• analog-value-reached

are triggered, if the thresholds

• set-voltage-callback-threshold,
• set-analog-value-callback-threshold

keep being reached.

tinkerforge call analog-in-bricklet <uid> get-debounce-period¶

Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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 analog-in-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch analog-in-bricklet <uid> voltage¶

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

This callback is triggered periodically with the period that is set by set-voltage-callback-period. The parameter is the voltage of the sensor.

The voltage callback is only triggered if the voltage has changed since the last triggering.

tinkerforge dispatch analog-in-bricklet <uid> analog-value¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by set-analog-value-callback-period. The parameter is the analog value of the sensor.

The analog-value callback is only triggered if the voltage has changed since the last triggering.

tinkerforge dispatch analog-in-bricklet <uid> voltage-reached¶

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

This callback is triggered when the threshold as set by set-voltage-callback-threshold is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.

tinkerforge dispatch analog-in-bricklet <uid> analog-value-reached¶

Output:	value – Type: Int, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by set-analog-value-callback-threshold is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.