pub struct Apds9960<I2C> { /* private fields */ }Expand description
APDS9960 device driver.
Implementations
sourceimpl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E>,
impl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E>,
Common configuration.
sourcepub fn disable(&mut self) -> Result<(), Error<E>>
pub fn disable(&mut self) -> Result<(), Error<E>>
Deactivate everything and put the device to sleep.
sourcepub fn enable_wait(&mut self) -> Result<(), Error<E>>
pub fn enable_wait(&mut self) -> Result<(), Error<E>>
Enable the wait feature.
Enables delay between proximity and / or color and ambient light cycles.
The duration of the wait can be configured with
set_wait_time() and
enable_wait_long().
sourcepub fn disable_wait(&mut self) -> Result<(), Error<E>>
pub fn disable_wait(&mut self) -> Result<(), Error<E>>
Disable the wait feature.
sourcepub fn enable_wait_long(&mut self) -> Result<(), Error<E>>
pub fn enable_wait_long(&mut self) -> Result<(), Error<E>>
Enable long wait.
The wait time will be multiplied by 12 so that each cycle takes 0.03s.
See also: set_wait_time().
Wait must be enabled with enable_wait().
sourcepub fn disable_wait_long(&mut self) -> Result<(), Error<E>>
pub fn disable_wait_long(&mut self) -> Result<(), Error<E>>
Disable long wait.
sourcepub fn set_wait_time(&mut self, value: u8) -> Result<(), Error<E>>
pub fn set_wait_time(&mut self, value: u8) -> Result<(), Error<E>>
Set the waiting time between proximity and / or color and ambient light cycles.
The value parameter must be a 2’s complement of the number of cycles.
Per default this is set to 0xFF (1 cycle) and each cycle has a fixed duration of 2.78ms
except if long wait is enabled, then this time is multiplied by 12.
This must be set before enabling proximity and / or color and ambient light detection.
Waiting must be enabled with enable_wait().
Long wait can be enabled with enable_wait_long().
sourcepub fn force_interrupt(&mut self) -> Result<(), Error<E>>
pub fn force_interrupt(&mut self) -> Result<(), Error<E>>
Force an interrupt.
sourcepub fn clear_interrupts(&mut self) -> Result<(), Error<E>>
pub fn clear_interrupts(&mut self) -> Result<(), Error<E>>
Clear all non-gesture interrupts.
sourceimpl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E>,
impl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E>,
Gesture engine configuration.
sourcepub fn enable_gesture(&mut self) -> Result<(), Error<E>>
pub fn enable_gesture(&mut self) -> Result<(), Error<E>>
Enable gesture detection
sourcepub fn disable_gesture(&mut self) -> Result<(), Error<E>>
pub fn disable_gesture(&mut self) -> Result<(), Error<E>>
Disable gesture detection
sourcepub fn enable_gesture_mode(&mut self) -> Result<(), Error<E>>
pub fn enable_gesture_mode(&mut self) -> Result<(), Error<E>>
Enable gesture mode.
This can be automatically enabled (depending on proximity thresholds) and disabled (see GMODE on datasheet).
sourcepub fn disable_gesture_mode(&mut self) -> Result<(), Error<E>>
pub fn disable_gesture_mode(&mut self) -> Result<(), Error<E>>
Disable gesture mode.
This can be automatically enabled (depending on proximity thresholds) and disabled (see GMODE on datasheet).
sourcepub fn enable_gesture_interrupts(&mut self) -> Result<(), Error<E>>
pub fn enable_gesture_interrupts(&mut self) -> Result<(), Error<E>>
Enable gesture interrupt generation
sourcepub fn disable_gesture_interrupts(&mut self) -> Result<(), Error<E>>
pub fn disable_gesture_interrupts(&mut self) -> Result<(), Error<E>>
Disable gesture interrupt generation
sourcepub fn set_gesture_data_level_threshold(
&mut self,
threshold: GestureDataThreshold
) -> Result<(), Error<E>>
pub fn set_gesture_data_level_threshold(
&mut self,
threshold: GestureDataThreshold
) -> Result<(), Error<E>>
Set the threshold of amount of available data in the gesture FIFO registers.
sourcepub fn set_gesture_proximity_entry_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
pub fn set_gesture_proximity_entry_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
Set the gesture proximity entry threshold.
sourcepub fn set_gesture_proximity_exit_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
pub fn set_gesture_proximity_exit_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
Set the gesture proximity exit threshold.
sourcepub fn set_gesture_up_offset(&mut self, offset: i8) -> Result<(), Error<E>>
pub fn set_gesture_up_offset(&mut self, offset: i8) -> Result<(), Error<E>>
Set the gesture up offset.
sourcepub fn set_gesture_down_offset(&mut self, offset: i8) -> Result<(), Error<E>>
pub fn set_gesture_down_offset(&mut self, offset: i8) -> Result<(), Error<E>>
Set the gesture down offset.
sourcepub fn set_gesture_left_offset(&mut self, offset: i8) -> Result<(), Error<E>>
pub fn set_gesture_left_offset(&mut self, offset: i8) -> Result<(), Error<E>>
Set the gesture left offset.
sourceimpl<I2C, E> Apds9960<I2C>where
I2C: WriteRead<Error = E>,
impl<I2C, E> Apds9960<I2C>where
I2C: WriteRead<Error = E>,
Gesture data reading.
sourcepub fn read_gesture_data_level(&mut self) -> Result<u8, Error<E>>
pub fn read_gesture_data_level(&mut self) -> Result<u8, Error<E>>
Read the amount of available data in the gesture FIFO registers.
sourcepub fn is_gesture_data_valid(&mut self) -> Result<bool, Error<E>>
pub fn is_gesture_data_valid(&mut self) -> Result<bool, Error<E>>
Read whether there is valid gesture data available.
sourcepub fn has_gesture_data_overflown(&mut self) -> Result<bool, Error<E>>
pub fn has_gesture_data_overflown(&mut self) -> Result<bool, Error<E>>
Read whether the gesture data has overflown.
sourcepub fn read_gesture_data(&mut self, data: &mut [u8]) -> Result<(), Error<E>>
pub fn read_gesture_data(&mut self, data: &mut [u8]) -> Result<(), Error<E>>
Read gesture data.
Will read the gesture data up to the minimum of: gesture data level, array size.
Make sure to provide an array with at least the number of elements returned by the
read_gesture_data_level() method multiplied by 4.
The data contents will be organized as follows:
[up_dataset0, down_dataset0, left_dataset0, right_dataset0, up_dataset1, down_dataset1, left_dataset1, right_dataset1, ...]
Returns nb::Error::WouldBlock as long as not enough data is available.
sourceimpl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E> + WriteRead<Error = E>,
impl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E> + WriteRead<Error = E>,
Color and ambient light.
sourcepub fn enable_light(&mut self) -> Result<(), Error<E>>
pub fn enable_light(&mut self) -> Result<(), Error<E>>
Enable color and ambient light detection.
sourcepub fn disable_light(&mut self) -> Result<(), Error<E>>
pub fn disable_light(&mut self) -> Result<(), Error<E>>
Disable color and ambient light detection.
sourcepub fn set_light_integration_time(&mut self, value: u8) -> Result<(), Error<E>>
pub fn set_light_integration_time(&mut self, value: u8) -> Result<(), Error<E>>
Set the color and ambient light integration time.
The value parameter must be a 2’s complement of the number of cycles.
Per default this is set to 0xFF (1 cycle) and each cycle has a fixed duration of 2.78ms.
sourcepub fn enable_light_interrupts(&mut self) -> Result<(), Error<E>>
pub fn enable_light_interrupts(&mut self) -> Result<(), Error<E>>
Enable ambient light interrupt generation.
sourcepub fn disable_light_interrupts(&mut self) -> Result<(), Error<E>>
pub fn disable_light_interrupts(&mut self) -> Result<(), Error<E>>
Disable ambient light interrupt generation.
sourcepub fn enable_light_saturation_interrupts(&mut self) -> Result<(), Error<E>>
pub fn enable_light_saturation_interrupts(&mut self) -> Result<(), Error<E>>
Enable clear channel ambient light saturation interrupt generation.
sourcepub fn disable_light_saturation_interrupts(&mut self) -> Result<(), Error<E>>
pub fn disable_light_saturation_interrupts(&mut self) -> Result<(), Error<E>>
Disable clear channel ambient light saturation interrupt generation.
sourcepub fn set_light_low_threshold(&mut self, threshold: u16) -> Result<(), Error<E>>
pub fn set_light_low_threshold(&mut self, threshold: u16) -> Result<(), Error<E>>
Set the clear channel ambient light interrupt low threshold.
An interrupt will be generated if light interrupts are enabled and the clear data is less than this value.
sourcepub fn set_light_high_threshold(
&mut self,
threshold: u16
) -> Result<(), Error<E>>
pub fn set_light_high_threshold(
&mut self,
threshold: u16
) -> Result<(), Error<E>>
Set the clear channel ambient light interrupt high threshold.
An interrupt will be generated if light interrupts are enabled and the clear data is greater than this value.
sourcepub fn clear_light_interrupt(&mut self) -> Result<(), Error<E>>
pub fn clear_light_interrupt(&mut self) -> Result<(), Error<E>>
Clear ambient light interrupt.
sourcepub fn read_light(&mut self) -> Result<LightData, Error<E>>
pub fn read_light(&mut self) -> Result<LightData, Error<E>>
Read the color / ambient light sensor data.
Returns nb::Error::WouldBlock as long as the data is not ready.
This clears the data ready flag.
sourcepub fn read_light_clear(&mut self) -> Result<u16, Error<E>>
pub fn read_light_clear(&mut self) -> Result<u16, Error<E>>
Read the color / ambient light sensor clear channel data.
Returns nb::Error::WouldBlock as long as the data is not ready.
This clears the data ready flag.
sourcepub fn read_light_red(&mut self) -> Result<u16, Error<E>>
pub fn read_light_red(&mut self) -> Result<u16, Error<E>>
Read the color / ambient light sensor red channel data.
Returns nb::Error::WouldBlock as long as the data is not ready.
This clears the data ready flag.
sourcepub fn read_light_green(&mut self) -> Result<u16, Error<E>>
pub fn read_light_green(&mut self) -> Result<u16, Error<E>>
Read the color / ambient light sensor green channel data.
Returns nb::Error::WouldBlock as long as the data is not ready.
This clears the data ready flag.
sourcepub fn read_light_blue(&mut self) -> Result<u16, Error<E>>
pub fn read_light_blue(&mut self) -> Result<u16, Error<E>>
Read the color / ambient light sensor blue channel data.
Returns nb::Error::WouldBlock as long as the data is not ready.
This clears the data ready flag.
sourcepub fn is_light_data_valid(&mut self) -> Result<bool, Error<E>>
pub fn is_light_data_valid(&mut self) -> Result<bool, Error<E>>
Read whether the color and ambient light sensor data is valid.
This is checked internally in the read_light_*() methods as well.
sourceimpl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E> + WriteRead<Error = E>,
impl<I2C, E> Apds9960<I2C>where
I2C: Write<Error = E> + WriteRead<Error = E>,
Proximity.
sourcepub fn enable_proximity(&mut self) -> Result<(), Error<E>>
pub fn enable_proximity(&mut self) -> Result<(), Error<E>>
Enable proximity detection
sourcepub fn disable_proximity(&mut self) -> Result<(), Error<E>>
pub fn disable_proximity(&mut self) -> Result<(), Error<E>>
Disable proximity detection
sourcepub fn enable_proximity_interrupts(&mut self) -> Result<(), Error<E>>
pub fn enable_proximity_interrupts(&mut self) -> Result<(), Error<E>>
Enable proximity interrupt generation
sourcepub fn disable_proximity_interrupts(&mut self) -> Result<(), Error<E>>
pub fn disable_proximity_interrupts(&mut self) -> Result<(), Error<E>>
Disable proximity interrupt generation
sourcepub fn enable_proximity_saturation_interrupts(&mut self) -> Result<(), Error<E>>
pub fn enable_proximity_saturation_interrupts(&mut self) -> Result<(), Error<E>>
Enable proximity saturation interrupt generation
sourcepub fn disable_proximity_saturation_interrupts(
&mut self
) -> Result<(), Error<E>>
pub fn disable_proximity_saturation_interrupts(
&mut self
) -> Result<(), Error<E>>
Disable proximity saturation interrupt generation
sourcepub fn set_proximity_low_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
pub fn set_proximity_low_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
Set the proximity interrupt low threshold.
sourcepub fn set_proximity_high_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
pub fn set_proximity_high_threshold(
&mut self,
threshold: u8
) -> Result<(), Error<E>>
Set the proximity interrupt high threshold.
sourcepub fn set_proximity_up_right_offset(
&mut self,
offset: i8
) -> Result<(), Error<E>>
pub fn set_proximity_up_right_offset(
&mut self,
offset: i8
) -> Result<(), Error<E>>
Set the proximity up/right photodiode offset.
sourcepub fn set_proximity_down_left_offset(
&mut self,
offset: i8
) -> Result<(), Error<E>>
pub fn set_proximity_down_left_offset(
&mut self,
offset: i8
) -> Result<(), Error<E>>
Set the proximity down/left photodiode offset.
sourcepub fn set_proximity_offsets(
&mut self,
offset_up_right: i8,
offset_down_left: i8
) -> Result<(), Error<E>>
pub fn set_proximity_offsets(
&mut self,
offset_up_right: i8,
offset_down_left: i8
) -> Result<(), Error<E>>
Set the proximity up/right and down/left photodiode offset.
sourcepub fn clear_proximity_interrupt(&mut self) -> Result<(), Error<E>>
pub fn clear_proximity_interrupt(&mut self) -> Result<(), Error<E>>
Clear proximity interrupt.
sourcepub fn read_proximity(&mut self) -> Result<u8, Error<E>>
pub fn read_proximity(&mut self) -> Result<u8, Error<E>>
Read the proximity sensor data.
Returns nb::Error::WouldBlock as long as the data is not ready.
sourcepub fn is_proximity_data_valid(&mut self) -> Result<bool, Error<E>>
pub fn is_proximity_data_valid(&mut self) -> Result<bool, Error<E>>
Read whether the proximity sensor data is valid.
This is checked internally in read_proximity() as well.