ESPHome  2021.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pca9685::PCA9685Output Class Reference

PCA9685 float output component. More...

#include <pca9685_output.h>

Inheritance diagram for esphome::pca9685::PCA9685Output:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

 PCA9685Output (float frequency, uint8_t mode=PCA9685_MODE_OUTPUT_ONACK|PCA9685_MODE_OUTPUT_TOTEM_POLE)
 
void register_channel (PCA9685Channel *channel)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 
ErrorCode write (const uint8_t *data, uint8_t len)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

void set_channel_value_ (uint8_t channel, uint16_t value)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

friend PCA9685Channel
 
float frequency_
 
uint8_t mode_
 
uint8_t min_channel_ {0xFF}
 
uint8_t max_channel_ {0x00}
 
uint16_t pwm_amounts_ [16]
 
bool update_ {true}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

PCA9685 float output component.

Definition at line 38 of file pca9685_output.h.

Constructor & Destructor Documentation

◆ PCA9685Output()

esphome::pca9685::PCA9685Output::PCA9685Output ( float  frequency,
uint8_t  mode = PCA9685_MODE_OUTPUT_ONACK | PCA9685_MODE_OUTPUT_TOTEM_POLE 
)
inline

Definition at line 40 of file pca9685_output.h.

Member Function Documentation

◆ dump_config()

void esphome::pca9685::PCA9685Output::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 77 of file pca9685_output.cpp.

◆ get_setup_priority()

float esphome::pca9685::PCA9685Output::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file pca9685_output.h.

◆ loop()

void esphome::pca9685::PCA9685Output::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 86 of file pca9685_output.cpp.

◆ register_channel()

void esphome::pca9685::PCA9685Output::register_channel ( PCA9685Channel channel)

Definition at line 126 of file pca9685_output.cpp.

◆ set_channel_value_()

void esphome::pca9685::PCA9685Output::set_channel_value_ ( uint8_t  channel,
uint16_t  value 
)
inlineprotected

Definition at line 53 of file pca9685_output.h.

◆ setup()

void esphome::pca9685::PCA9685Output::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file pca9685_output.cpp.

Field Documentation

◆ frequency_

float esphome::pca9685::PCA9685Output::frequency_
protected

Definition at line 59 of file pca9685_output.h.

◆ max_channel_

uint8_t esphome::pca9685::PCA9685Output::max_channel_ {0x00}
protected

Definition at line 63 of file pca9685_output.h.

◆ min_channel_

uint8_t esphome::pca9685::PCA9685Output::min_channel_ {0xFF}
protected

Definition at line 62 of file pca9685_output.h.

◆ mode_

uint8_t esphome::pca9685::PCA9685Output::mode_
protected

Definition at line 60 of file pca9685_output.h.

◆ PCA9685Channel

friend esphome::pca9685::PCA9685Output::PCA9685Channel
protected

Definition at line 51 of file pca9685_output.h.

◆ pwm_amounts_

uint16_t esphome::pca9685::PCA9685Output::pwm_amounts_[16]
protected
Initial value:
= {
0,
}

Definition at line 64 of file pca9685_output.h.

◆ update_

bool esphome::pca9685::PCA9685Output::update_ {true}
protected

Definition at line 67 of file pca9685_output.h.


The documentation for this class was generated from the following files: