Struct tcs3400::Tcs3400

pub struct Tcs3400<I2C> { /* private fields */ }

TCS3400 device driver.

Implementations

impl<I2C, E> Tcs3400<I2C>where
    I2C: Write<Error = E>,

pub fn enable(&mut self) -> Result<(), Error<E>>

Enable the device (Power ON).

The device goes to idle state.

pub fn disable(&mut self) -> Result<(), Error<E>>

Disable the device (sleep).

pub fn enable_rgbc(&mut self) -> Result<(), Error<E>>

Enable the RGB converter.

pub fn disable_rgbc(&mut self) -> Result<(), Error<E>>

Disable the RGB converter.

pub fn enable_rgbc_interrupts(&mut self) -> Result<(), Error<E>>

Enable the RGB converter interrupt generation.

pub fn disable_rgbc_interrupts(&mut self) -> Result<(), Error<E>>

Disable the RGB converter interrupt generation.

pub fn enable_wait(&mut self) -> Result<(), Error<E>>

Enable the wait feature (wait timer).

pub fn disable_wait(&mut self) -> Result<(), Error<E>>

Disable the wait feature (wait timer).

pub fn set_wait_cycles(&mut self, cycles: u16) -> Result<(), Error<E>>

Set the number of wait time cycles (1-256).

The actual wait time depends on the “wait long” setting.

• If wait long is disabled, then the wait time corresponds to: number_of_cycles * 2.78ms.
• If wait long is enabled, then the wait time is increased by a factor of 12 and therefore corresponds to aproximately: number_of_cycles * 0.03s. See enable_wait_long() and disable_wait_long().

pub fn enable_wait_long(&mut self) -> Result<(), Error<E>>

Enable the wait long setting.

The wait time configured with set_wait_cycles() is increased by a factor of 12. See set_wait_cycles().

pub fn disable_wait_long(&mut self) -> Result<(), Error<E>>

Disable the wait long setting.

The wait time configured with set_wait_cycles() is used without multiplication factor. See set_wait_cycles().

pub fn set_rgbc_gain(&mut self, gain: RgbCGain) -> Result<(), Error<E>>

Set the RGB converter gain.

pub fn set_integration_cycles(&mut self, cycles: u16) -> Result<(), Error<E>>

Set the number of integration cycles (1-256).

The actual integration time corresponds to: number_of_cycles * 2.78ms.

pub fn set_rgbc_interrupt_low_threshold(
    &mut self,
    threshold: u16
) -> Result<(), Error<E>>

Set the RGB converter interrupt clear channel low threshold.

pub fn set_rgbc_interrupt_high_threshold(
    &mut self,
    threshold: u16
) -> Result<(), Error<E>>

Set the RGB converter interrupt clear channel high threshold.

pub fn set_rgbc_interrupt_persistence(
    &mut self,
    persistence: RgbCInterruptPersistence
) -> Result<(), Error<E>>

Set the RGB converter interrupt persistence.

This controls the RGB converter interrupt generation rate.

impl<I2C, E> Tcs3400<I2C>where
    I2C: WriteRead<Error = E>,

pub fn is_rgbc_status_valid(&mut self) -> Result<bool, Error<E>>

Check whether the RGB converter status is valid.

Indicates that the RGBC channels have completed an integration cycle.

pub fn read_clear_channel(&mut self) -> Result<u16, Error<E>>

Read the clear (unfiltered) channel measurement data.

pub fn read_red_channel(&mut self) -> Result<u16, Error<E>>

Read the red channel measurement data.

pub fn read_green_channel(&mut self) -> Result<u16, Error<E>>

Read the green channel measurement data.

pub fn read_blue_channel(&mut self) -> Result<u16, Error<E>>

Read the blue channel measurement data.

pub fn read_all_channels(&mut self) -> Result<AllChannelMeasurement, Error<E>>

Read the measurement data of all channels at once.

pub fn read_device_id(&mut self) -> Result<u8, Error<E>>

Read the device ID.

The value returned corresponds to the part number identification:

• 0x90 => TCS34001 & TCS34005
• 0x93 => TCS34003 & TCS34007

impl<I2C, E> Tcs3400<I2C>where
    I2C: Write<Error = E>,

pub fn new(i2c: I2C) -> Self

Create new instance of the TCS3400 device.

pub fn destroy(self) -> I2C

Destroy driver instance, return I²C bus instance.

Trait Implementations

impl<I2C: Debug> Debug for Tcs3400<I2C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.