/ 
Tinkerforge-2.1.10
River stage zero No dependents
/ Tinkerforge::BrickletAmbientLightV2

NAME

Tinkerforge::BrickletAmbientLightV2 - Measures ambient light up to 64000lux

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Ambient Light Bricklet 2.0.

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.

DEVICE_DISPLAY_NAME

This constant represents the display name of a Ambient Light Bricklet 2.0.

CALLBACK_ILLUMINANCE

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

CALLBACK_ILLUMINANCE_REACHED

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

FUNCTION_GET_ILLUMINANCE

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_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_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_CONFIGURATION

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

FUNCTION_GET_CONFIGURATION

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 measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop. The illuminance is given in lux/100, i.e. a value of 450000 means that an illuminance of 4500lux is measured.

.. versionchanged:: 2.0.2$nbsp;(Plugin) An illuminance of 0lux indicates that the sensor is saturated and the configuration should be modified, see :func:`SetConfiguration`.

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

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_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_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`IlluminanceReached`,

are triggered, if the thresholds

* :func:`SetIlluminanceCallbackThreshold`,

keep being reached.

The default value is 100.

get_debounce_period()

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

set_configuration()

Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

.. versionadded:: 2.0.2$nbsp;(Plugin) The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

.. versionchanged:: 2.0.2$nbsp;(Plugin) If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by :func:`GetIlluminance` and the :func:`Illuminance` callback. For example, 800001 for the 0-8000lux range.

.. versionchanged:: 2.0.2$nbsp;(Plugin) With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by :func:`GetIlluminance` and the :func:`Illuminance` callback.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

The default values are 0-8000lux illuminance range and 200ms integration time.

get_configuration()

Returns the configuration as set by :func:`SetConfiguration`.

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|