Struct tinkerforge::ambient_light_v2_bricklet::AmbientLightV2Bricklet

pub struct AmbientLightV2Bricklet { /* fields omitted */ }

Measures ambient light up to 64000lux

Methods

impl AmbientLightV2Bricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(
    uid: &str,
    req_sender: T
) -> AmbientLightV2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(
    &mut self,
    fun: AmbientLightV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>

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.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: AmbientLightV2BrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

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.

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) 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.

pub fn get_illuminance_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u32>

This receiver is triggered periodically with the period that is set by set_illuminance_callback_period. The parameter is the illuminance of the ambient light sensor.

The get_illuminance_callback_receiver receiver is only triggered if the illuminance has changed since the last triggering.

pub fn get_illuminance_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u32>

This receiver is triggered when the threshold as set by set_illuminance_callback_threshold is reached. The parameter is the illuminance of the ambient light sensor.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by set_debounce_period.

pub fn get_illuminance(&self) -> ConvertingReceiver<u32>

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 set_configuration.

If you want to get the illuminance periodically, it is recommended to use the get_illuminance_callback_receiver receiver and set the period with set_illuminance_callback_period.

pub fn set_illuminance_callback_period(
    &self,
    period: u32
) -> ConvertingReceiver<()>

Sets the period with which the get_illuminance_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_illuminance_callback_receiver receiver is only triggered if the illuminance has changed since the last triggering.

pub fn get_illuminance_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_illuminance_callback_period.

pub fn set_illuminance_callback_threshold(
    &self,
    option: char,
    min: u32,
    max: u32
) -> ConvertingReceiver<()>

Sets the thresholds for the get_illuminance_reached_callback_receiver receiver.

The following options are possible:

Option	Description
'x'	Receiver is turned off
'o'	Receiver is triggered when the illuminance is outside the min and max values
'i'	Receiver is triggered when the illuminance is inside the min and max values
'<'	Receiver is triggered when the illuminance is smaller than the min value (max is ignored)
'>'	Receiver is triggered when the illuminance is greater than the min value (max is ignored)

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

Associated constants:

• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_illuminance_callback_threshold(
    &self
) -> ConvertingReceiver<IlluminanceCallbackThreshold>

Returns the threshold as set by set_illuminance_callback_threshold.

Associated constants:

• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
• AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period with which the threshold receivers

• get_illuminance_reached_callback_receiver,

are triggered, if the thresholds

• set_illuminance_callback_threshold,

keep being reached.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by set_debounce_period.

pub fn set_configuration(
    &self,
    illuminance_range: u8,
    integration_time: u8
) -> ConvertingReceiver<()>

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 get_illuminance and the get_illuminance_callback_receiver receiver. 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 get_illuminance and the get_illuminance_callback_receiver receiver.

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.

Associated constants:

• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS

pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>

Returns the configuration as set by set_configuration.

Associated constants:

• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX
• AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS
• AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS

pub fn get_identity(&self) -> ConvertingReceiver<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 here. |device_identifier_constant|

Trait Implementations

impl Clone for AmbientLightV2Bricklet

fn clone(&self) -> AmbientLightV2Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.