ESPHome  2022.6.2
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::my9231::MY9231OutputComponent Class Reference

MY9231 float output component. More...

#include <my9231.h>

Inheritance diagram for esphome::my9231::MY9231OutputComponent:
esphome::Component

Data Structures

class  Channel
 

Public Member Functions

void set_pin_di (GPIOPin *pin_di)
 
void set_pin_dcki (GPIOPin *pin_dcki)
 
void set_num_channels (uint16_t num_channels)
 
void set_num_chips (uint8_t num_chips)
 
void set_bit_depth (uint8_t bit_depth)
 
void setup () override
 Setup the MY9231. More...
 
void dump_config () override
 
float get_setup_priority () const override
 HARDWARE setup_priority. More...
 
void loop () override
 Send new values if they were updated. More...
 
- 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...
 

Protected Member Functions

uint16_t get_max_amount_ () const
 
void set_channel_value_ (uint8_t channel, uint16_t value)
 
void init_chips_ (uint8_t command)
 
void write_word_ (uint16_t value, uint8_t bits)
 
void send_di_pulses_ (uint8_t count)
 
- 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

GPIOPinpin_di_
 
GPIOPinpin_dcki_
 
uint8_t bit_depth_
 
uint16_t num_channels_
 
uint8_t num_chips_
 
std::vector< uint16_t > pwm_amounts_
 
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
 

Detailed Description

MY9231 float output component.

Definition at line 12 of file my9231.h.

Member Function Documentation

◆ dump_config()

void esphome::my9231::MY9231OutputComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 57 of file my9231.cpp.

◆ get_max_amount_()

uint16_t esphome::my9231::MY9231OutputComponent::get_max_amount_ ( ) const
inlineprotected

Definition at line 46 of file my9231.h.

◆ get_setup_priority()

float esphome::my9231::MY9231OutputComponent::get_setup_priority ( ) const
inlineoverridevirtual

HARDWARE setup_priority.

Reimplemented from esphome::Component.

Definition at line 26 of file my9231.h.

◆ init_chips_()

void esphome::my9231::MY9231OutputComponent::init_chips_ ( uint8_t  command)
protected

Definition at line 84 of file my9231.cpp.

◆ loop()

void esphome::my9231::MY9231OutputComponent::loop ( )
overridevirtual

Send new values if they were updated.

Reimplemented from esphome::Component.

Definition at line 65 of file my9231.cpp.

◆ send_di_pulses_()

void esphome::my9231::MY9231OutputComponent::send_di_pulses_ ( uint8_t  count)
protected

Definition at line 102 of file my9231.cpp.

◆ set_bit_depth()

void esphome::my9231::MY9231OutputComponent::set_bit_depth ( uint8_t  bit_depth)
inline

Definition at line 20 of file my9231.h.

◆ set_channel_value_()

void esphome::my9231::MY9231OutputComponent::set_channel_value_ ( uint8_t  channel,
uint16_t  value 
)
protected

Definition at line 76 of file my9231.cpp.

◆ set_num_channels()

void esphome::my9231::MY9231OutputComponent::set_num_channels ( uint16_t  num_channels)
inline

Definition at line 18 of file my9231.h.

◆ set_num_chips()

void esphome::my9231::MY9231OutputComponent::set_num_chips ( uint8_t  num_chips)
inline

Definition at line 19 of file my9231.h.

◆ set_pin_dcki()

void esphome::my9231::MY9231OutputComponent::set_pin_dcki ( GPIOPin pin_dcki)
inline

Definition at line 16 of file my9231.h.

◆ set_pin_di()

void esphome::my9231::MY9231OutputComponent::set_pin_di ( GPIOPin pin_di)
inline

Definition at line 15 of file my9231.h.

◆ setup()

void esphome::my9231::MY9231OutputComponent::setup ( )
overridevirtual

Setup the MY9231.

Reimplemented from esphome::Component.

Definition at line 29 of file my9231.cpp.

◆ write_word_()

void esphome::my9231::MY9231OutputComponent::write_word_ ( uint16_t  value,
uint8_t  bits 
)
protected

Definition at line 96 of file my9231.cpp.

Field Documentation

◆ bit_depth_

uint8_t esphome::my9231::MY9231OutputComponent::bit_depth_
protected

Definition at line 55 of file my9231.h.

◆ num_channels_

uint16_t esphome::my9231::MY9231OutputComponent::num_channels_
protected

Definition at line 56 of file my9231.h.

◆ num_chips_

uint8_t esphome::my9231::MY9231OutputComponent::num_chips_
protected

Definition at line 57 of file my9231.h.

◆ pin_dcki_

GPIOPin* esphome::my9231::MY9231OutputComponent::pin_dcki_
protected

Definition at line 54 of file my9231.h.

◆ pin_di_

GPIOPin* esphome::my9231::MY9231OutputComponent::pin_di_
protected

Definition at line 53 of file my9231.h.

◆ pwm_amounts_

std::vector<uint16_t> esphome::my9231::MY9231OutputComponent::pwm_amounts_
protected

Definition at line 58 of file my9231.h.

◆ update_

bool esphome::my9231::MY9231OutputComponent::update_ {true}
protected

Definition at line 59 of file my9231.h.


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