/ 
Tinkerforge-2.1.4
River stage zero No dependents
/ Tinkerforge::BrickletDistanceUS

NAME

Tinkerforge::BrickletDistanceUS - Device for sensing distance via ultrasound

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Distance US 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_DISTANCE

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

CALLBACK_DISTANCE_REACHED

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

FUNCTION_GET_DISTANCE_VALUE

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

FUNCTION_SET_DISTANCE_CALLBACK_PERIOD

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

FUNCTION_GET_DISTANCE_CALLBACK_PERIOD

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

FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD

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

FUNCTION_GET_DISTANCE_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_SET_MOVING_AVERAGE

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

FUNCTION_GET_MOVING_AVERAGE

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

Returns the current distance value measured by the sensor. The value has a range of 0 to 4095. A small value corresponds to a small distance, a big value corresponds to a big distance. The relation between the measured distance value and the actual distance is affected by the 5V supply voltage (deviations in the supply voltage result in deviations in the distance values) and is non-linear (resolution is bigger at close range).

If you want to get the distance value periodically, it is recommended to use the callback :func:`Distance` and set the period with :func:`SetDistanceCallbackPeriod`.

set_distance_callback_period()

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

:func:`Distance` is only triggered if the distance value has changed since the last triggering.

The default value is 0.

get_distance_callback_period()

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

set_distance_callback_threshold()

Sets the thresholds for the :func:`DistanceReached` 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 distance value is *outside* the min and max values"
"'i'",    "Callback is triggered when the distance value is *inside* the min and max values"
"'<'",    "Callback is triggered when the distance value is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the distance value is greater than the min value (max is ignored)"

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

get_distance_callback_threshold()

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

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`DistanceReached`,

are triggered, if the thresholds

* :func:`SetDistanceCallbackThreshold`,

keep being reached.

The default value is 100.

get_debounce_period()

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

set_moving_average()

Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__ for the distance value.

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

The range for the averaging is 0-100.

The default value is 20.

get_moving_average()

Returns the length moving average as set by :func:`SetMovingAverage`.

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|