Python - Distance IR Bricklet

This is the description of the Python API bindings for the Distance IR Bricklet. General information and technical specifications for the Distance IR Bricklet are summarized in its hardware description.

An installation guide for the Python API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Distance IR Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_distance_ir import BrickletDistanceIR

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    dir = BrickletDistanceIR(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get current distance
    distance = dir.get_distance()
    print("Distance: " + str(distance/10.0) + " cm")

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Distance IR Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_distance_ir import BrickletDistanceIR

# Callback function for distance callback
def cb_distance(distance):
    print("Distance: " + str(distance/10.0) + " cm")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    dir = BrickletDistanceIR(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register distance callback to function cb_distance
    dir.register_callback(dir.CALLBACK_DISTANCE, cb_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!
    dir.set_distance_callback_period(200)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Threshold

Download (example_threshold.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Distance IR Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_distance_ir import BrickletDistanceIR

# Callback function for distance reached callback
def cb_distance_reached(distance):
    print("Distance: " + str(distance/10.0) + " cm")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    dir = BrickletDistanceIR(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    dir.set_debounce_period(10000)

    # Register distance reached callback to function cb_distance_reached
    dir.register_callback(dir.CALLBACK_DISTANCE_REACHED, cb_distance_reached)

    # Configure threshold for distance "smaller than 30 cm"
    dir.set_distance_callback_threshold("<", 30*10, 0)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

Generally, every function of the Python bindings can throw an tinkerforge.ip_connection.Error exception that has a value and a description property. value can have different values:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (unused since Python bindings version 2.0.0)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14

All functions listed below are thread-safe.

Basic Functions

BrickletDistanceIR(uid, ipcon)
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • distance_ir – Type: BrickletDistanceIR

Creates an object with the unique device ID uid:

distance_ir = BrickletDistanceIR("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

BrickletDistanceIR.get_distance()
Returns:
  • 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 CALLBACK_DISTANCE callback and set the period with set_distance_callback_period().

Advanced Functions

BrickletDistanceIR.get_analog_value()
Returns:
  • value – Type: int, Range: [0 to 4095]

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 CALLBACK_ANALOG_VALUE callback and set the period with set_analog_value_callback_period().

BrickletDistanceIR.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]
Returns:
  • None

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.

BrickletDistanceIR.get_sampling_point(position)
Parameters:
  • position – Type: int, Range: [0 to 127]
Returns:
  • 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().

BrickletDistanceIR.get_identity()
Return Object:
  • uid – Type: str, Length: up to 8
  • connected_uid – Type: str, Length: up to 8
  • position – Type: chr, Range: ["a" to "h", "i", "z"]
  • hardware_version – Type: [int, ...], 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, ...], 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletDistanceIR.register_callback(callback_id, function)
Parameters:
  • callback_id – Type: int
  • function – Type: callable
Returns:
  • None

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletDistanceIR.set_distance_callback_period(period)
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • None

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

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

BrickletDistanceIR.get_distance_callback_period()
Returns:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_distance_callback_period().

BrickletDistanceIR.set_analog_value_callback_period(period)
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • None

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

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

BrickletDistanceIR.get_analog_value_callback_period()
Returns:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_analog_value_callback_period().

BrickletDistanceIR.set_distance_callback_threshold(option, min, max)
Parameters:
  • option – Type: chr, Range: See constants, 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:
  • None

Sets the thresholds for the CALLBACK_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 constants are available for this function:

For option:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"
BrickletDistanceIR.get_distance_callback_threshold()
Return Object:
  • option – Type: chr, Range: See constants, 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 constants are available for this function:

For option:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"
BrickletDistanceIR.set_analog_value_callback_threshold(option, min, max)
Parameters:
  • option – Type: chr, Range: See constants, Default: "x"
  • min – Type: int, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Range: [0 to 216 - 1], Default: 0
Returns:
  • None

Sets the thresholds for the CALLBACK_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 constants are available for this function:

For option:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"
BrickletDistanceIR.get_analog_value_callback_threshold()
Return Object:
  • option – Type: chr, Range: See constants, 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 constants are available for this function:

For option:

  • BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
  • BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"
BrickletDistanceIR.set_debounce_period(debounce)
Parameters:
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:
  • None

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

BrickletDistanceIR.get_debounce_period()
Returns:
  • 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 registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

def my_callback(param):
    print(param)

distance_ir.register_callback(BrickletDistanceIR.CALLBACK_EXAMPLE, my_callback)

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletDistanceIR.CALLBACK_DISTANCE
Callback Parameters:
  • 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 CALLBACK_DISTANCE callback is only triggered if the distance has changed since the last triggering.

BrickletDistanceIR.CALLBACK_ANALOG_VALUE
Callback Parameters:
  • value – Type: int, Range: [0 to 4095]

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 CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

BrickletDistanceIR.CALLBACK_DISTANCE_REACHED
Callback Parameters:
  • 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().

BrickletDistanceIR.CALLBACK_ANALOG_VALUE_REACHED
Callback Parameters:
  • value – Type: int, Range: [0 to 4095]

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().

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletDistanceIR.get_api_version()
Return Object:
  • api_version – Type: [int, ...], 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]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletDistanceIR.get_response_expected(function_id)
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletDistanceIR.set_response_expected(function_id, response_expected)
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool
Returns:
  • None

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletDistanceIR.set_response_expected_all(response_expected)
Parameters:
  • response_expected – Type: bool
Returns:
  • None

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

BrickletDistanceIR.DEVICE_IDENTIFIER

This constant is used to identify a Distance IR Bricklet.

The get_identity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletDistanceIR.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Distance IR Bricklet.