ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::max7219::MAX7219Component Class Reference

#include <max7219.h>

Inheritance diagram for esphome::max7219::MAX7219Component:
esphome::PollingComponent esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ > esphome::Component

Public Member Functions

void set_writer (max7219_writer_t &&writer)
 
void setup () override
 
void dump_config () override
 
void update () override
 
float get_setup_priority () const override
 
void display ()
 
void set_intensity (uint8_t intensity)
 
void set_num_chips (uint8_t num_chips)
 
void set_reverse (bool reverse)
 
uint8_t printf (uint8_t pos, const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the result at the given position. More...
 
uint8_t uint8_t printf (const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the result at position 0. More...
 
uint8_t uint8_t uint8_t print (uint8_t pos, const char *str)
 Print str at the given position. More...
 
uint8_t print (const char *str)
 Print str at position 0. More...
 
uint8_t strftime (uint8_t pos, const char *format, time::ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the result at the given position. More...
 
uint8_t uint8_t strftime (const char *format, time::ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the result at position 0. More...
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
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::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ >
 SPIDevice ()=default
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs)
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void spi_setup ()
 
void enable ()
 
void disable ()
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
std::array< uint8_t, N > read_array ()
 
void write_byte (uint8_t data)
 
void write_byte16 (uint16_t data)
 
void write_array16 (const uint16_t *data, size_t length)
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 
void transfer_array (std::array< uint8_t, N > &data)
 

Protected Member Functions

void send_byte_ (uint8_t a_register, uint8_t data)
 
void send_to_all_ (uint8_t a_register, uint8_t data)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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

uint8_t intensity_ {15}
 
uint8_t num_chips_ {1}
 Intensity of the display from 0 to 15 (most) More...
 
uint8_t * buffer_
 
bool reverse_ {false}
 
optional< max7219_writer_twriter_ {}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ >
SPIComponentparent_
 
GPIOPincs_
 

Detailed Description

Definition at line 19 of file max7219.h.

Member Function Documentation

◆ display()

void esphome::max7219::MAX7219Component::display ( )

Definition at line 143 of file max7219.cpp.

◆ dump_config()

void esphome::max7219::MAX7219Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 135 of file max7219.cpp.

◆ get_setup_priority()

float esphome::max7219::MAX7219Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 117 of file max7219.cpp.

◆ print() [1/2]

uint8_t esphome::max7219::MAX7219Component::print ( uint8_t  pos,
const char *  str 
)

Print str at the given position.

Definition at line 173 of file max7219.cpp.

◆ print() [2/2]

uint8_t esphome::max7219::MAX7219Component::print ( const char *  str)

Print str at position 0.

Definition at line 198 of file max7219.cpp.

◆ printf() [1/2]

uint8_t esphome::max7219::MAX7219Component::printf ( uint8_t  pos,
const char *  format,
  ... 
)

Evaluate the printf-format and print the result at the given position.

Definition at line 199 of file max7219.cpp.

◆ printf() [2/2]

uint8_t esphome::max7219::MAX7219Component::printf ( const char *  format,
  ... 
)

Evaluate the printf-format and print the result at position 0.

Definition at line 209 of file max7219.cpp.

◆ send_byte_()

void esphome::max7219::MAX7219Component::send_byte_ ( uint8_t  a_register,
uint8_t  data 
)
protected

Definition at line 156 of file max7219.cpp.

◆ send_to_all_()

void esphome::max7219::MAX7219Component::send_to_all_ ( uint8_t  a_register,
uint8_t  data 
)
protected

Definition at line 160 of file max7219.cpp.

◆ set_intensity()

void esphome::max7219::MAX7219Component::set_intensity ( uint8_t  intensity)

Definition at line 220 of file max7219.cpp.

◆ set_num_chips()

void esphome::max7219::MAX7219Component::set_num_chips ( uint8_t  num_chips)

Definition at line 224 of file max7219.cpp.

◆ set_reverse()

void esphome::max7219::MAX7219Component::set_reverse ( bool  reverse)
inline

Definition at line 37 of file max7219.h.

◆ set_writer()

void esphome::max7219::MAX7219Component::set_writer ( max7219_writer_t &&  writer)

Definition at line 219 of file max7219.cpp.

◆ setup()

void esphome::max7219::MAX7219Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 118 of file max7219.cpp.

◆ strftime() [1/2]

uint8_t esphome::max7219::MAX7219Component::strftime ( uint8_t  pos,
const char *  format,
time::ESPTime  time 
)

Evaluate the strftime-format and print the result at the given position.

Definition at line 227 of file max7219.cpp.

◆ strftime() [2/2]

uint8_t esphome::max7219::MAX7219Component::strftime ( const char *  format,
time::ESPTime  time 
)

Evaluate the strftime-format and print the result at position 0.

Definition at line 234 of file max7219.cpp.

◆ update()

void esphome::max7219::MAX7219Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 166 of file max7219.cpp.

Field Documentation

◆ buffer_

uint8_t* esphome::max7219::MAX7219Component::buffer_
protected

Definition at line 63 of file max7219.h.

◆ intensity_

uint8_t esphome::max7219::MAX7219Component::intensity_ {15}
protected

Definition at line 61 of file max7219.h.

◆ num_chips_

uint8_t esphome::max7219::MAX7219Component::num_chips_ {1}
protected

Intensity of the display from 0 to 15 (most)

Definition at line 62 of file max7219.h.

◆ reverse_

bool esphome::max7219::MAX7219Component::reverse_ {false}
protected

Definition at line 64 of file max7219.h.

◆ writer_

optional<max7219_writer_t> esphome::max7219::MAX7219Component::writer_ {}
protected

Definition at line 65 of file max7219.h.


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