/ 
Tinkerforge-2.1.3
River stage zero No dependents
/ Tinkerforge::BrickletLine

NAME

Tinkerforge::BrickletLine - Device that measures reflectivity to allow following a line

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Line Bricklet.

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

CALLBACK_REFLECTIVITY

This constant is used with the register_callback() subroutine to specify the CALLBACK_REFLECTIVITY callback.

CALLBACK_REFLECTIVITY_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_REFLECTIVITY_REACHED callback.

FUNCTION_GET_REFLECTIVITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_REFLECTIVITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_REFLECTIVITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

get_reflectivity()

Returns the currently measured reflectivity. The reflectivity is a value between 0 (not reflective) and 4095 (very reflective).

Usually black has a low reflectivity while white has a high reflectivity.

If you want to get the reflectivity periodically, it is recommended to use the callback :func:`Reflectivity` and set the period with :func:`SetReflectivityCallbackPeriod`.

set_reflectivity_callback_period()

Sets the period in ms with which the :func:`Reflectivity` callback is triggered periodically. A value of 0 turns the callback off.

:func:`Reflectivity` is only triggered if the reflectivity has changed since the last triggering.

The default value is 0.

get_reflectivity_callback_period()

Returns the period as set by :func:`SetReflectivityCallbackPeriod`.

set_reflectivity_callback_threshold()

Sets the thresholds for the :func:`ReflectivityReached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the reflectivity is *outside* the min and max values"
"'i'",    "Callback is triggered when the reflectivity is *inside* the min and max values"
"'<'",    "Callback is triggered when the reflectivity is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the reflectivity is greater than the min value (max is ignored)"

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

get_reflectivity_callback_threshold()

Returns the threshold as set by :func:`SetReflectivityCallbackThreshold`.

set_debounce_period()

Sets the period in ms with which the threshold callback

* :func:`ReflectivityReached`

is triggered, if the threshold

* :func:`SetReflectivityCallbackThreshold`

keeps being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`SetDebouncePeriod`.

get_identity()

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 :ref:`here <device_identifier>`. |device_identifier_constant|