ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mcp4728::MCP4728Component Class Reference

MCP4728 float output component. More...

#include <mcp4728_output.h>

Inheritance diagram for esphome::mcp4728::MCP4728Component:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

 MCP4728Component (bool store_in_eeprom)
 
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, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
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, bool stop=true)
 
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 stop=true)
 
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 stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

void set_channel_value_ (MCP4728ChannelIdx channel, uint16_t value)
 
bool multi_write_ ()
 
bool seq_write_ ()
 
void select_vref_ (MCP4728ChannelIdx channel, MCP4728Vref vref)
 
void select_power_down_ (MCP4728ChannelIdx channel, MCP4728PwrDown pd)
 
void select_gain_ (MCP4728ChannelIdx channel, MCP4728Gain gain)
 
- 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_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
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 MCP4728Channel
 
- 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

MCP4728 float output component.

Definition at line 43 of file mcp4728_output.h.

Constructor & Destructor Documentation

◆ MCP4728Component()

esphome::mcp4728::MCP4728Component::MCP4728Component ( bool  store_in_eeprom)
inline

Definition at line 45 of file mcp4728_output.h.

Member Function Documentation

◆ dump_config()

void esphome::mcp4728::MCP4728Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file mcp4728_output.cpp.

◆ get_setup_priority()

float esphome::mcp4728::MCP4728Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 49 of file mcp4728_output.h.

◆ loop()

void esphome::mcp4728::MCP4728Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file mcp4728_output.cpp.

◆ multi_write_()

bool esphome::mcp4728::MCP4728Component::multi_write_ ( )
protected

Definition at line 63 of file mcp4728_output.cpp.

◆ select_gain_()

void esphome::mcp4728::MCP4728Component::select_gain_ ( MCP4728ChannelIdx  channel,
MCP4728Gain  gain 
)
protected

Definition at line 107 of file mcp4728_output.cpp.

◆ select_power_down_()

void esphome::mcp4728::MCP4728Component::select_power_down_ ( MCP4728ChannelIdx  channel,
MCP4728PwrDown  pd 
)
protected

Definition at line 101 of file mcp4728_output.cpp.

◆ select_vref_()

void esphome::mcp4728::MCP4728Component::select_vref_ ( MCP4728ChannelIdx  channel,
MCP4728Vref  vref 
)
protected

Definition at line 95 of file mcp4728_output.cpp.

◆ seq_write_()

bool esphome::mcp4728::MCP4728Component::seq_write_ ( )
protected

Definition at line 83 of file mcp4728_output.cpp.

◆ set_channel_value_()

void esphome::mcp4728::MCP4728Component::set_channel_value_ ( MCP4728ChannelIdx  channel,
uint16_t  value 
)
protected

Definition at line 47 of file mcp4728_output.cpp.

◆ setup()

void esphome::mcp4728::MCP4728Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file mcp4728_output.cpp.

Field Documentation

◆ MCP4728Channel

friend esphome::mcp4728::MCP4728Component::MCP4728Channel
protected

Definition at line 53 of file mcp4728_output.h.


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