ESPHome  2022.11.3
Public Member Functions | Protected Attributes
esphome::rdm6300::RDM6300Component Class Reference

#include <rdm6300.h>

Inheritance diagram for esphome::rdm6300::RDM6300Component:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

void loop () override
 
void register_card (RDM6300BinarySensor *obj)
 
void register_trigger (RDM6300Trigger *trig)
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
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...
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 

Protected Attributes

int8_t read_state_ {-1}
 
uint8_t buffer_ [6] {}
 
std::vector< RDM6300BinarySensor * > cards_
 
std::vector< RDM6300Trigger * > triggers_
 
uint32_t last_id_ {0}
 
- 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::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Additional Inherited Members

- 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...
 

Detailed Description

Definition at line 14 of file rdm6300.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::rdm6300::RDM6300Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file rdm6300.h.

◆ loop()

void esphome::rdm6300::RDM6300Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file rdm6300.cpp.

◆ register_card()

void esphome::rdm6300::RDM6300Component::register_card ( RDM6300BinarySensor obj)
inline

Definition at line 18 of file rdm6300.h.

◆ register_trigger()

void esphome::rdm6300::RDM6300Component::register_trigger ( RDM6300Trigger trig)
inline

Definition at line 19 of file rdm6300.h.

Field Documentation

◆ buffer_

uint8_t esphome::rdm6300::RDM6300Component::buffer_[6] {}
protected

Definition at line 25 of file rdm6300.h.

◆ cards_

std::vector<RDM6300BinarySensor *> esphome::rdm6300::RDM6300Component::cards_
protected

Definition at line 26 of file rdm6300.h.

◆ last_id_

uint32_t esphome::rdm6300::RDM6300Component::last_id_ {0}
protected

Definition at line 28 of file rdm6300.h.

◆ read_state_

int8_t esphome::rdm6300::RDM6300Component::read_state_ {-1}
protected

Definition at line 24 of file rdm6300.h.

◆ triggers_

std::vector<RDM6300Trigger *> esphome::rdm6300::RDM6300Component::triggers_
protected

Definition at line 27 of file rdm6300.h.


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