pub struct AmbientLightV2Bricklet { /* private fields */ }
Expand description
Measures ambient light up to 64000lux
Implementations
sourceimpl AmbientLightV2Bricklet
impl AmbientLightV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 259u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Ambient Light Bricklet 2.0"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> AmbientLightV2Bricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> AmbientLightV2Bricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: AmbientLightV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>
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.
sourcepub fn set_response_expected(
&mut self,
fun: AmbientLightV2BrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
sourcepub fn get_illuminance_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u32>
pub fn get_illuminance_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u32>
This receiver is triggered periodically with the period that is set by
Set Illuminance Receiver 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.
sourcepub fn get_illuminance_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u32>
pub fn get_illuminance_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u32>
This receiver is triggered when the threshold as set by
Set Illuminance Receiver 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
.
sourcepub fn get_illuminance(&self) -> ConvertingReceiver<u32>
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 Receiver Period
.
sourcepub fn set_illuminance_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
pub fn set_illuminance_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms 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.
The default value is 0.
sourcepub fn get_illuminance_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_illuminance_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Illuminance Receiver Period
.
sourcepub fn set_illuminance_callback_threshold(
&self,
option: char,
min: u32,
max: u32
) -> ConvertingReceiver<()>
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_V2BRICKLET_THRESHOLD_OPTION_OFF
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_illuminance_callback_threshold(
&self
) -> ConvertingReceiver<IlluminanceCallbackThreshold>
pub fn get_illuminance_callback_threshold(
&self
) -> ConvertingReceiver<IlluminanceCallbackThreshold>
Returns the threshold as set by Set Illuminance Receiver Threshold
.
Associated constants:
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
- AMBIENT_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the threshold receivers
are triggered, if the thresholds
Set Illuminance Receiver Threshold
,
keep being reached.
The default value is 100.
sourcepub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
Returns the debounce period as set by Set Debounce Period
.
sourcepub fn set_configuration(
&self,
illuminance_range: u8,
integration_time: u8
) -> ConvertingReceiver<()>
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_V2BRICKLET_ILLUMINANCE_RANGE_UNLIMITED
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_64000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_32000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_16000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_8000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_1300LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_600LUX
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_50MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_100MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_150MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_200MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_250MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_300MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_350MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_400MS
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by Set Configuration
.
Associated constants:
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_UNLIMITED
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_64000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_32000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_16000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_8000LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_1300LUX
- AMBIENT_LIGHT_V2BRICKLET_ILLUMINANCE_RANGE_600LUX
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_50MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_100MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_150MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_200MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_250MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_300MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_350MS
- AMBIENT_LIGHT_V2BRICKLET_INTEGRATION_TIME_400MS
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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
sourceimpl Clone for AmbientLightV2Bricklet
impl Clone for AmbientLightV2Bricklet
sourcefn clone(&self) -> AmbientLightV2Bricklet
fn clone(&self) -> AmbientLightV2Bricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more