tinkerforge_async::ambient_light_v2_bricklet

Struct AmbientLightV2Bricklet

pub struct AmbientLightV2Bricklet { /* private fields */ }

Expand description

Measures ambient light up to 64000lux

Implementations§

Source §

pub fn new(uid: Uid, connection: AsyncIpConnection) -> AmbientLightV2Bricklet

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

Source

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

Source

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 sent and errors are silently ignored, because they cannot be detected.

Source

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.

Source

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.

Source

pub async fn get_illuminance_callback_receiver( &mut self, ) -> impl Stream<Item = 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.

Source

pub async fn get_illuminance_reached_callback_receiver( &mut self, ) -> impl Stream<Item = 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].

Source

pub async fn get_illuminance(&mut self) -> Result<u32, TinkerforgeError>

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop.

.. versionchanged:: 2.0.2$nbsp;(Plugin) An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified ([set_configuration]) to better match the light conditions.

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

Source

pub async fn set_illuminance_callback_period( &mut self, period: u32, ) -> Result<(), TinkerforgeError>

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.

Source

pub async fn get_illuminance_callback_period( &mut self, ) -> Result<u32, TinkerforgeError>

Returns the period as set by [set_illuminance_callback_period].

Source

pub async fn set_illuminance_callback_threshold( &mut self, option: char, min: u32, max: u32, ) -> Result<(), TinkerforgeError>

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)

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

Source

pub async fn get_illuminance_callback_threshold( &mut self, ) -> Result<IlluminanceCallbackThreshold, TinkerforgeError>

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

Source

pub async fn set_debounce_period( &mut self, debounce: u32, ) -> Result<(), TinkerforgeError>

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.

Source

pub async fn get_debounce_period(&mut self) -> Result<u32, TinkerforgeError>

Returns the debounce period as set by [set_debounce_period].

Source

pub async fn set_configuration( &mut self, illuminance_range: u8, integration_time: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants: