Struct embedded_ccs811::Ccs811Awake

pub struct Ccs811Awake<I2C, MODE> { /* fields omitted */ }

Already awake CCS811 device driver

This can be used when the nWAKE pin is connected directly to GND or when handling the device waking manually instead of using the Ccs811 wrapper type.

Methods

impl<I2C> Ccs811Awake<I2C, Boot>

pub fn new(i2c: I2C, address: SlaveAddr) -> Self

Create new instance of an already awake CCS811 device.

impl<I2C, E, MODE> Ccs811Awake<I2C, MODE> where
    I2C: Write<Error = E>, 

pub fn destroy(self) -> I2C

Destroy driver instance, return I²C bus instance.

Trait Implementations

impl<I2C, E> Ccs811AppMode for Ccs811Awake<I2C, App> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

type Error = ErrorAwake<E>

Error type

type ModeChangeError = ModeChangeError<ErrorAwake<E>, Self>

Boot/App mode change error

type BootModeType = Ccs811Awake<I2C, Boot>

Boot mode type

fn set_mode(&mut self, mode: MeasurementMode) -> Result<(), Self::Error>

Set the measurement mode

fn has_data_ready(&mut self) -> Result<bool, Self::Error>

Check if there is a new data sample ready.

fn raw_data(&mut self) -> Result<(u8, u16), Self::Error>

Get the raw sensor data.

fn data(&mut self) -> Result<AlgorithmResult, Self::Error>

Get the algorithm results data.

fn set_environment(
    &mut self,
    humidity_percentage: f32,
    temperature_celsius: f32
) -> Result<(), Self::Error>

Set the environment temperature and relative humidity.

fn baseline(&mut self) -> Result<[u8; 2], Self::Error>

Get the current baseline

fn set_baseline(&mut self, baseline: [u8; 2]) -> Result<(), Self::Error>

Set the baseline

fn set_eco2_thresholds(
    &mut self,
    low_to_medium: u16,
    medium_to_high: u16
) -> Result<(), Self::Error>

Set the eCO2 threshold values for interrupt generation (in ppm).

fn set_interrupt_mode(&mut self, mode: InterruptMode) -> Result<(), Self::Error>

Configure the interrupt generation.

fn software_reset(self) -> Result<Self::BootModeType, Self::ModeChangeError>

Restart the device in boot mode.

impl<I2C, E> Ccs811BootMode for Ccs811Awake<I2C, Boot> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

type Error = ErrorAwake<E>

Error type

type ModeChangeError = ModeChangeError<Self::Error, Self>

Boot/App mode change error

type TargetType = Ccs811Awake<I2C, App>

Application mode type

fn start_application(self) -> Result<Self::TargetType, Self::ModeChangeError>

Start application mode

fn verify_application(&mut self) -> Result<(), Self::Error>

Verify application.

fn erase_application(&mut self) -> Result<(), Self::Error>

Erase application.

fn download_application<D: DelayMs<u16>>(
    &mut self,
    bin: &[u8],
    delay: &mut D
) -> Result<(), Self::Error>

Download new application.

fn update_application<D: DelayMs<u16>>(
    &mut self,
    bin: &[u8],
    delay: &mut D
) -> Result<(), Self::Error>

Reset, erase, download new application and verify it in one step.

fn software_reset(&mut self) -> Result<(), Self::Error>

Restart the device in boot mode.

impl<I2C, E, MODE> Ccs811Device for Ccs811Awake<I2C, MODE> where
    I2C: Write<Error = E> + WriteRead<Error = E>, 

type Error = ErrorAwake<E>

Error type

fn firmware_mode(&mut self) -> Result<FirmwareMode, Self::Error>

Get the firmware mode.

fn has_valid_app(&mut self) -> Result<bool, Self::Error>

Check if a valid application firmware is loaded.

fn hardware_id(&mut self) -> Result<u8, Self::Error>

Get the hardware ID (0x81 for the CCS81x family of devices)

fn hardware_version(&mut self) -> Result<(u8, u8), Self::Error>

Get the hardware version (major, minor) ((1,X) for the CCS81x family of devices)

fn firmware_bootloader_version(&mut self) -> Result<(u8, u8, u8), Self::Error>

Get the firmware bootloader verion (major, minor, trivial)

fn firmware_application_version(&mut self) -> Result<(u8, u8, u8), Self::Error>

Get the firmware application verion (major, minor, trivial)

impl<I2C: Debug, MODE: Debug> Debug for Ccs811Awake<I2C, MODE>

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

Formats the value using the given formatter.