Shell - Distance IR 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 Distance IR Bricklet

# Get current distance
tinkerforge call distance-ir-bricklet $uid get-distance

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 Distance IR Bricklet

# Handle incoming distance callbacks
tinkerforge dispatch distance-ir-bricklet $uid distance &

# Set period for distance callback to 0.2s (200ms)
# Note: The distance callback is only called every 0.2 seconds
#       if the distance has changed since the last call!
tinkerforge call distance-ir-bricklet $uid set-distance-callback-period 200

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 Distance IR Bricklet

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

# Handle incoming distance reached callbacks
tinkerforge dispatch distance-ir-bricklet $uid distance-reached &

# Configure threshold for distance "smaller than 30 cm"
tinkerforge call distance-ir-bricklet $uid set-distance-callback-threshold threshold-option-smaller 300 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 distance-ir-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

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

tinkerforge dispatch distance-ir-bricklet [<option>..] <uid> <callback>¶

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

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

tinkerforge call distance-ir-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 distance-ir-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 distance-ir-bricklet <uid> get-distance¶

Output:	distance – Type: Int, Unit: 1 mm, Range: [0 to 216 - 1]

Returns the distance measured by the sensor. Possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

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

Advanced Functions¶

tinkerforge call distance-ir-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-distance 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 distance-ir-bricklet <uid> set-sampling-point <position> <distance>¶

Parameters:	<position> – Type: Int, Range: [0 to 127] <distance> – Type: Int, Unit: 1/10 mm, Range: [0 to 216 - 1]
Output:	no output

Sets a sampling point value to a specific position of the lookup table. The lookup table comprises 128 equidistant analog values with corresponding distances.

If you measure a distance of 50cm at the analog value 2048, you should call this function with (64, 5000). The utilized analog-to-digital converter has a resolution of 12 bit. With 128 sampling points on the whole range, this means that every sampling point has a size of 32 analog values. Thus the analog value 2048 has the corresponding sampling point 64 = 2048/32.

Sampling points are saved on the EEPROM of the Distance IR Bricklet and loaded again on startup.

Note

An easy way to calibrate the sampling points of the Distance IR Bricklet is implemented in the Brick Viewer. If you want to calibrate your Bricklet it is highly recommended to use this implementation.

tinkerforge call distance-ir-bricklet <uid> get-sampling-point <position>¶

Parameters:	<position> – Type: Int, Range: [0 to 127]
Output:	distance – Type: Int, Unit: 1/10 mm, Range: [0 to 216 - 1]

Returns the distance to a sampling point position as set by set-sampling-point.

tinkerforge call distance-ir-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 distance-ir-bricklet <uid> set-distance-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 distance callback is triggered periodically. A value of 0 turns the callback off.

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

tinkerforge call distance-ir-bricklet <uid> get-distance-callback-period¶

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

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

tinkerforge call distance-ir-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 distance-ir-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 distance-ir-bricklet <uid> set-distance-callback-threshold <option> <min> <max>¶

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

Sets the thresholds for the distance-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the distance is outside the min and max values
'i'	Callback is triggered when the distance is inside the min and max values
'<'	Callback is triggered when the distance is smaller than the min value (max is ignored)
'>'	Callback is triggered when the distance 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 distance-ir-bricklet <uid> get-distance-callback-threshold¶

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

Returns the threshold as set by set-distance-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 distance-ir-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 distance-ir-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 distance-ir-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

• distance-reached,
• analog-value-reached

are triggered, if the thresholds

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

keep being reached.

tinkerforge call distance-ir-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 distance-ir-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch distance-ir-bricklet <uid> distance¶

Output:	distance – Type: Int, Unit: 1 mm, Range: [0 to 216 - 1]

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

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

tinkerforge dispatch distance-ir-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 analog value has changed since the last triggering.

tinkerforge dispatch distance-ir-bricklet <uid> distance-reached¶

Output:	distance – Type: Int, Unit: 1 mm, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by set-distance-callback-threshold is reached. The parameter is the distance 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 distance-ir-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.