ESPHome  2022.1.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::e131::E131Component Class Reference

#include <e131.h>

Inheritance diagram for esphome::e131::E131Component:
esphome::Component

Public Member Functions

 E131Component ()
 
 ~E131Component ()
 
void setup () override
 
void loop () override
 
float get_setup_priority () const override
 
void add_effect (E131AddressableLightEffect *light_effect)
 
void remove_effect (E131AddressableLightEffect *light_effect)
 
void set_method (E131ListenMethod listen_method)
 
- Public Member Functions inherited from esphome::Component
virtual void dump_config ()
 
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

bool packet_ (const std::vector< uint8_t > &data, int &universe, E131Packet &packet)
 
bool process_ (int universe, const E131Packet &packet)
 
bool join_igmp_groups_ ()
 
void join_ (int universe)
 
void leave_ (int universe)
 
- 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

E131ListenMethod listen_method_ {E131_MULTICAST}
 
std::unique_ptr< UDP > udp_
 
std::set< E131AddressableLightEffect * > light_effects_
 
std::map< int, int > universe_consumers_
 
std::map< int, E131Packetuniverse_packets_
 
- 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

Definition at line 27 of file e131.h.

Constructor & Destructor Documentation

◆ E131Component()

esphome::e131::E131Component::E131Component ( )

Definition at line 22 of file e131.cpp.

◆ ~E131Component()

esphome::e131::E131Component::~E131Component ( )

Definition at line 24 of file e131.cpp.

Member Function Documentation

◆ add_effect()

void esphome::e131::E131Component::add_effect ( E131AddressableLightEffect light_effect)

Definition at line 65 of file e131.cpp.

◆ get_setup_priority()

float esphome::e131::E131Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 34 of file e131.h.

◆ join_()

void esphome::e131::E131Component::join_ ( int  universe)
protected

Definition at line 85 of file e131_packet.cpp.

◆ join_igmp_groups_()

bool esphome::e131::E131Component::join_igmp_groups_ ( )
protected

Definition at line 62 of file e131_packet.cpp.

◆ leave_()

void esphome::e131::E131Component::leave_ ( int  universe)
protected

Definition at line 98 of file e131_packet.cpp.

◆ loop()

void esphome::e131::E131Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file e131.cpp.

◆ packet_()

bool esphome::e131::E131Component::packet_ ( const std::vector< uint8_t > &  data,
int &  universe,
E131Packet packet 
)
protected

Definition at line 115 of file e131_packet.cpp.

◆ process_()

bool esphome::e131::E131Component::process_ ( int  universe,
const E131Packet packet 
)
protected

Definition at line 95 of file e131.cpp.

◆ remove_effect()

void esphome::e131::E131Component::remove_effect ( E131AddressableLightEffect light_effect)

Definition at line 80 of file e131.cpp.

◆ set_method()

void esphome::e131::E131Component::set_method ( E131ListenMethod  listen_method)
inline

Definition at line 41 of file e131.h.

◆ setup()

void esphome::e131::E131Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file e131.cpp.

Field Documentation

◆ light_effects_

std::set<E131AddressableLightEffect *> esphome::e131::E131Component::light_effects_
protected

Definition at line 53 of file e131.h.

◆ listen_method_

E131ListenMethod esphome::e131::E131Component::listen_method_ {E131_MULTICAST}
protected

Definition at line 51 of file e131.h.

◆ udp_

std::unique_ptr<UDP> esphome::e131::E131Component::udp_
protected

Definition at line 52 of file e131.h.

◆ universe_consumers_

std::map<int, int> esphome::e131::E131Component::universe_consumers_
protected

Definition at line 54 of file e131.h.

◆ universe_packets_

std::map<int, E131Packet> esphome::e131::E131Component::universe_packets_
protected

Definition at line 55 of file e131.h.


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