Struct qwiic_button_led::ButtonLED

pub struct ButtonLED<I2C> { /* fields omitted */ }

This struct contains all the functions to interface with the Qwiic button LED.

Implementations

impl<I2C> ButtonLED<I2C> where
    I2C: Write + WriteRead, 

pub fn init(i2c: I2C, address: u8) -> Self

Initialize a ButtonLED struct

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

The button ID is read-only and always returns 0x5D.

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

The firmware version for this button LED.

pub fn button_status(&mut self) -> Result<ButtonStatus, Error>

Determine the status of this button.

pub fn set_button_status(
    &mut self,
    new_status: ButtonStatus
) -> Result<(), Error>

Set the button status, e.g. to clear events

pub fn interrupt_config(&mut self) -> Result<InterruptConfig, Error>

Query the interrupt configuration.

pub fn set_interrupt_config(
    &mut self,
    config: InterruptConfig
) -> Result<(), Error>

Manipulate the interrupt configuration.

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

Query the debounce time, a measurement of how long after the button is released that it requires to reset to the default state.

pub fn set_button_debounce_time(&mut self, time: u16) -> Result<(), Error>

Manipulate the debounce time.

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

Is the button pressed queue full.

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

Is the button pressed queue empty.

pub fn pressed_queue_status(&mut self) -> Result<PressedQueueStatus, Error>

Query the button pressed queue: empty / full.

pub fn newest_press_timestamp(&mut self) -> Result<u32, Error>

The timestamp in milliseconds since the most recent button press in the queue.

pub fn oldest_press_timestamp(&mut self) -> Result<u32, Error>

The timestamp in milliseconds since the first button press in the queue.

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

Is the button clicked queue full.

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

Is the button clicked queue empty.

pub fn clicked_queue_status(&mut self) -> Result<ClickedQueueStatus, Error>

Query the button pressed queue: empty / full.

pub fn newest_click_timestamp(&mut self) -> Result<u32, Error>

The timestamp in milliseconds since the most recent button click in the queue.

pub fn oldest_click_timestamp(&mut self) -> Result<u32, Error>

The timestamp in milliseconds since the first button click in the queue.

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

The LED brightness.

pub fn set_led_brightness(&mut self, brightness: u8) -> Result<(), Error>

Set LED brightness.

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

The number of steps the LED uses from one brightness setting another when updated.

pub fn set_led_pulse_granularity(&mut self, brightness: u8) -> Result<(), Error>

Set the LED update granularity.

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

When set, the LED pulses on for this value in milliseconds.

pub fn set_led_pulse_cycle_time(&mut self, cycle_time: u16) -> Result<(), Error>

Set the LED pulse on time in milliseconds (0 disables).

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

The duration in milliseconds the LED is off while pulsing.

pub fn set_led_pulse_off_time(&mut self, off_time: u16) -> Result<(), Error>

Set the LED off time in milliseconds (0 disables).

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

The address of this button LED.

pub fn set_device_address(&mut self, new_address: u8) -> Result<(), Error>

Set the address of this button LED (0x08 - 0x77).

Trait Implementations

impl<I2C: Debug> Debug for ButtonLED<I2C>

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

Formats the value using the given formatter.