Struct pca9685_lib::PCA9685

pub struct PCA9685 { /* fields omitted */ }

A Representation of a PCA9685 Chip

Methods

impl PCA9685

pub fn new(address: u8, bus: I2c) -> Result<PCA9685, Error>

Creates a new PCA9865

pub async fn begin<'_>(&'_ mut self, prescale: u8) -> Result<(), Error>

Restarts the deice and sets a prescale

Panics

If the prescale is less than the minium, or greater than the max, this function will panic.

pub async fn reset<'_>(&'_ mut self) -> Result<(), Error>

Send a reset command to the chip

pub async fn sleep<'_>(&'_ mut self) -> Result<(), Error>

Put the chip into sleep mode

pub async fn wakeup<'_>(&'_ mut self) -> Result<(), Error>

Awaken the chip out of sleep mode

pub fn write_micros(&mut self, channel: u8, micros: u16) -> Result<(), Error>

Sets the pwm output of a pin based on the input of microseconds

Imprecise: This function is not 100% accurate due to the nature of the chip.

pub async fn set_pwm_freq<'_>(&'_ mut self, freq: f32) -> Result<(), Error>

Sets the PWM frequency for the entire chip, up to ~1.6 KHz

Panics

This function will panic if the frequency is not within 1 < freq < 3052

Imprecise: This function is not 100% accurate due to the nature of the chip.

pub fn set_pin(
    &mut self,
    channel: u8,
    on_tick: u16,
    invert: bool
) -> Result<usize, Error>

Helper to set pin PWM Output. Sets pin wihtout having to deal with on/off tick placement and properly handles a zero value as completely off and 4095 as completely on

pub fn set_pwm(
    &mut self,
    channel: u8,
    on: u16,
    off: u16
) -> Result<usize, Error>

Set the PWM output of one of the pins on the chip

Panics

This function will panic if channel is > 15

pub fn get_osc_frequency(&self) -> u32

Getter for the internally tracked oscillator used for freq calculations

pub fn set_osc_frequency(&mut self, freq: u32)

Sets the internally tracked oscillator used for frequency calculations.

pub fn get_prescale(&mut self) -> (usize, Result<()>)

Just returns the private prescale value. (PCA9685 doesn't have introspection)

pub async fn set_ext_clock<'_>(&'_ mut self, prescale: u8) -> Result<(), Error>

Sets EXTCLK pin to use the external clock.

pub fn set_output_mode(&mut self, totempole: bool) -> Result<(), Error>

Sets the output mode of the PCA9685 to either open drain or push pull / totempole

Warning

LEDs with integrated zener diodes should only be driven in open drain mode.