Shell - Distance IR Bricklet 2.0¶

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 2.0

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

Callback¶

Download (example-callback.sh)

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

#!/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 2.0

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

# Set period for distance callback to 1s (1000ms) without a threshold
tinkerforge call distance-ir-v2-bricklet $uid set-distance-callback-configuration 1000 false threshold-option-off 0 0

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

#!/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 2.0

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

# Configure threshold for distance "smaller than 30 cm"
# with a debounce period of 1s (1000ms)
tinkerforge call distance-ir-v2-bricklet $uid set-distance-callback-configuration 1000 false 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-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> -- string <function> -- string

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

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

Parameters:	<uid> -- string <callback> -- string

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

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

Output:	distance -- int

Returns the distance measured by the sensor. The value is in mm and 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 value periodically, it is recommended to use the distance callback. You can set the callback configuration with set-distance-callback-configuration.

tinkerforge call distance-ir-v2-bricklet <uid> get-analog-value¶

Output:	analog-value -- int

Returns the analog value as read by a analog-to-digital converter. The value has 21 bit with a range of 0 to 2097151.

This is unfiltered raw data. We made sure that the integration time of the ADC is shorter then the measurement interval of the sensor (10ms vs 16.5ms). So there is no information lost.

If you want to do your own calibration or create your own lookup table you can use this value.

If you want to get the value periodically, it is recommended to use the analog-value callback. You can set the callback configuration with set-analog-value-callback-configuration.

tinkerforge call distance-ir-v2-bricklet <uid> set-moving-average-configuration <moving-average-length>¶

Parameters:	<moving-average-length> -- int
Output:	no output

Sets the length of a moving averaging for the distance.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

The range for the averaging is 1-1000.

New data is gathered every ~10ms. With a moving average of length 1000 the resulting averaging window has a length of approximately 10s. If you want to do long term measurements the longest moving average will give the cleanest results.

The default value is 25.

tinkerforge call distance-ir-v2-bricklet <uid> get-moving-average-configuration¶

Output:	moving-average-length -- int

Returns the moving average configuration as set by set-moving-average-configuration.

tinkerforge call distance-ir-v2-bricklet <uid> set-distance-led-config <config>¶

Parameters:	<config> -- int (has symbols)
Output:	no output

Configures the distance LED to be either turned off, turned on, blink in heartbeat mode or show the distance (brighter = object is nearer).

The default value is 3 (show distance).

The following symbols are available for this function:

• distance-led-config-off = 0, for <config>
• distance-led-config-on = 1, for <config>
• distance-led-config-show-heartbeat = 2, for <config>
• distance-led-config-show-distance = 3, for <config>

tinkerforge call distance-ir-v2-bricklet <uid> get-distance-led-config¶

Output:	config -- int (has symbols)

Returns the LED configuration as set by set-distance-led-config

The following symbols are available for this function:

• distance-led-config-off = 0, for config
• distance-led-config-on = 1, for config
• distance-led-config-show-heartbeat = 2, for config
• distance-led-config-show-distance = 3, for config

tinkerforge call distance-ir-v2-bricklet <uid> set-sensor-type <sensor>¶

Parameters:	<sensor> -- int (has symbols)
Output:	no output

Sets the sensor type.

The Bricklet comes configured with the correct sensor type and the type is saved in flash (i.e. the Bricklet retains the information if power is lost).

If you want to change the sensor you can set the type in Brick Viewer, you will likely never need to call this function from your program.

The following symbols are available for this function:

• sensor-type-2y0a41 = 0, for <sensor>
• sensor-type-2y0a21 = 1, for <sensor>
• sensor-type-2y0a02 = 2, for <sensor>

tinkerforge call distance-ir-v2-bricklet <uid> get-sensor-type¶

Output:	sensor -- int (has symbols)

Returns the sensor type as set by set-sensor-type.

The following symbols are available for this function:

• sensor-type-2y0a41 = 0, for sensor
• sensor-type-2y0a21 = 1, for sensor
• sensor-type-2y0a02 = 2, for sensor

Advanced Functions¶

tinkerforge call distance-ir-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum -- int error-count-message-checksum -- int error-count-frame -- int error-count-overflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call distance-ir-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> -- int (has symbols)
Output:	status -- int (has symbols)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

• bootloader-mode-bootloader = 0, for <mode>
• bootloader-mode-firmware = 1, for <mode>
• bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
• bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
• bootloader-status-ok = 0, for status
• bootloader-status-invalid-mode = 1, for status
• bootloader-status-no-change = 2, for status
• bootloader-status-entry-function-not-present = 3, for status
• bootloader-status-device-identifier-incorrect = 4, for status
• bootloader-status-crc-mismatch = 5, for status

tinkerforge call distance-ir-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

• bootloader-mode-bootloader = 0, for mode
• bootloader-mode-firmware = 1, for mode
• bootloader-mode-bootloader-wait-for-reboot = 2, for mode
• bootloader-mode-firmware-wait-for-reboot = 3, for mode
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode

tinkerforge call distance-ir-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> -- int
Output:	no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call distance-ir-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> -- int,int,..61x..,int
Output:	status -- int

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call distance-ir-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> -- int (has symbols)
Output:	no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

• status-led-config-off = 0, for <config>
• status-led-config-on = 1, for <config>
• status-led-config-show-heartbeat = 2, for <config>
• status-led-config-show-status = 3, for <config>

tinkerforge call distance-ir-v2-bricklet <uid> get-status-led-config¶

Output:	config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

• status-led-config-off = 0, for config
• status-led-config-on = 1, for config
• status-led-config-show-heartbeat = 2, for config
• status-led-config-show-status = 3, for config

tinkerforge call distance-ir-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call distance-ir-v2-bricklet <uid> reset¶

Output:	no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call distance-ir-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> -- int
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call distance-ir-v2-bricklet <uid> read-uid¶

Output:	uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call distance-ir-v2-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. 

Callback Configuration Functions¶

tinkerforge call distance-ir-v2-bricklet <uid> set-distance-callback-configuration <period> <value-has-to-change> <option> <min> <max>¶

Parameters:	<period> -- int <value-has-to-change> -- bool <option> -- char (has symbols) <min> -- int <max> -- int
Output:	no output

The period in ms is the period with which the distance callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the distance callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following symbols are available for this function:

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

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

Output:	period -- int value-has-to-change -- bool option -- char (has symbols) min -- int max -- int

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

The following symbols are available for this function:

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

tinkerforge call distance-ir-v2-bricklet <uid> set-analog-value-callback-configuration <period> <value-has-to-change> <option> <min> <max>¶

Parameters:	<period> -- int <value-has-to-change> -- bool <option> -- char (has symbols) <min> -- int <max> -- int
Output:	no output

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the analog-value callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following symbols are available for this function:

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

tinkerforge call distance-ir-v2-bricklet <uid> get-analog-value-callback-configuration¶

Output:	period -- int value-has-to-change -- bool option -- char (has symbols) min -- int max -- int

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

The following symbols are available for this function:

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

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch distance-ir-v2-bricklet <uid> example

The available callbacks are described below.

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

Output:	distance -- int

This callback is triggered periodically according to the configuration set by set-distance-callback-configuration.

The parameter is the same as get-distance.

tinkerforge dispatch distance-ir-v2-bricklet <uid> analog-value¶

Output:	analog-value -- int

This callback is triggered periodically according to the configuration set by set-analog-value-callback-configuration.

The parameter is the same as get-analog-value.