/ 
Tinkerforge-2.1.0-0
River stage zero No dependents
/ Tinkerforge::BrickletAmbientLight

NAME

Tinkerforge::BrickletAmbientLight - Device for sensing Ambient Light

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Ambient Light 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_ILLUMINANCE

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

CALLBACK_ANALOG_VALUE

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

CALLBACK_ILLUMINANCE_REACHED

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

CALLBACK_ANALOG_VALUE_REACHED

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

FUNCTION_GET_ILLUMINANCE

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

FUNCTION_GET_ANALOG_VALUE

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

FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD

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

FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD

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

FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD

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

FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD

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

FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD

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

FUNCTION_GET_ILLUMINANCE_CALLBACK_THRESHOLD

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

FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD

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

FUNCTION_GET_ANALOG_VALUE_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_illuminance()

Returns the illuminance of the ambient light sensor. The value has a range of 0 to 9000 and is given in Lux/10, i.e. a value of 4500 means that an illuminance of 450 Lux is measured.

If you want to get the illuminance periodically, it is recommended to use the callback :func:`Illuminance` and set the period with :func:`SetIlluminanceCallbackPeriod`.

get_analog_value()

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

.. note:: The value returned by :func:`GetIlluminance` is averaged over several samples to yield less noise, while :func:`GetAnalogValue` gives back raw unfiltered analog values. The only reason to use :func:`GetAnalogValue` is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are
set dynamically depending on the light intensity. It is impossible to
distinguish between these ranges with the analog value.

If you want the analog value periodically, it is recommended to use the callback :func:`AnalogValue` and set the period with :func:`SetAnalogValueCallbackPeriod`.

set_illuminance_callback_period()

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

:func:`Illuminance` is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

get_illuminance_callback_period()

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

set_analog_value_callback_period()

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

:func:`AnalogValue` is only triggered if the analog value has changed since the last triggering.

The default value is 0.

get_analog_value_callback_period()

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

set_illuminance_callback_threshold()

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

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

get_illuminance_callback_threshold()

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

set_analog_value_callback_threshold()

Sets the thresholds for the :func:`AnalogValueReached` 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 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 default value is ('x', 0, 0).

get_analog_value_callback_threshold()

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

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`IlluminanceReached`, * :func:`AnalogValueReached`

are triggered, if the thresholds

* :func:`SetIlluminanceCallbackThreshold`, * :func:`SetAnalogValueCallbackThreshold`

keep 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|