ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::gcja5::GCJA5Component Class Reference

#include <gcja5.h>

Inheritance diagram for esphome::gcja5::GCJA5Component:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void set_pm_1_0_sensor (sensor::Sensor *pm_1_0)
 
void set_pm_2_5_sensor (sensor::Sensor *pm_2_5)
 
void set_pm_10_0_sensor (sensor::Sensor *pm_10_0)
 
void set_pmc_0_3_sensor (sensor::Sensor *pmc_0_3)
 
void set_pmc_0_5_sensor (sensor::Sensor *pmc_0_5)
 
void set_pmc_1_0_sensor (sensor::Sensor *pmc_1_0)
 
void set_pmc_2_5_sensor (sensor::Sensor *pmc_2_5)
 
void set_pmc_5_0_sensor (sensor::Sensor *pmc_5_0)
 
void set_pmc_10_0_sensor (sensor::Sensor *pmc_10_0)
 
- 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 ()
 
bool is_ready ()
 
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 Member Functions

void parse_data_ ()
 
bool calculate_checksum_ ()
 
uint32_t get_32_bit_uint_ (uint8_t start_index)
 
uint16_t get_16_bit_uint_ (uint8_t start_index)
 
- 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(uint8_t)> &&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(uint8_t)> &&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

uint32_t last_transmission_ {0}
 
std::vector< uint8_t > rx_message_
 
bool have_good_data_ {false}
 
bool first_status_log_ {false}
 
sensor::Sensorpm_1_0_sensor_ {nullptr}
 
sensor::Sensorpm_2_5_sensor_ {nullptr}
 
sensor::Sensorpm_10_0_sensor_ {nullptr}
 
sensor::Sensorpmc_0_3_sensor_ {nullptr}
 
sensor::Sensorpmc_0_5_sensor_ {nullptr}
 
sensor::Sensorpmc_1_0_sensor_ {nullptr}
 
sensor::Sensorpmc_2_5_sensor_ {nullptr}
 
sensor::Sensorpmc_5_0_sensor_ {nullptr}
 
sensor::Sensorpmc_10_0_sensor_ {nullptr}
 
- 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}
 

Detailed Description

Definition at line 10 of file gcja5.h.

Member Function Documentation

◆ calculate_checksum_()

bool esphome::gcja5::GCJA5Component::calculate_checksum_ ( )
protected

Definition at line 69 of file gcja5.cpp.

◆ dump_config()

void esphome::gcja5::GCJA5Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 116 of file gcja5.cpp.

◆ get_16_bit_uint_()

uint16_t esphome::gcja5::GCJA5Component::get_16_bit_uint_ ( uint8_t  start_index)
protected

Definition at line 86 of file gcja5.cpp.

◆ get_32_bit_uint_()

uint32_t esphome::gcja5::GCJA5Component::get_32_bit_uint_ ( uint8_t  start_index)
protected

Definition at line 80 of file gcja5.cpp.

◆ get_setup_priority()

float esphome::gcja5::GCJA5Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file gcja5.h.

◆ loop()

void esphome::gcja5::GCJA5Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file gcja5.cpp.

◆ parse_data_()

void esphome::gcja5::GCJA5Component::parse_data_ ( )
protected

Definition at line 90 of file gcja5.cpp.

◆ set_pm_10_0_sensor()

void esphome::gcja5::GCJA5Component::set_pm_10_0_sensor ( sensor::Sensor pm_10_0)
inline

Definition at line 19 of file gcja5.h.

◆ set_pm_1_0_sensor()

void esphome::gcja5::GCJA5Component::set_pm_1_0_sensor ( sensor::Sensor pm_1_0)
inline

Definition at line 17 of file gcja5.h.

◆ set_pm_2_5_sensor()

void esphome::gcja5::GCJA5Component::set_pm_2_5_sensor ( sensor::Sensor pm_2_5)
inline

Definition at line 18 of file gcja5.h.

◆ set_pmc_0_3_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_0_3_sensor ( sensor::Sensor pmc_0_3)
inline

Definition at line 21 of file gcja5.h.

◆ set_pmc_0_5_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_0_5_sensor ( sensor::Sensor pmc_0_5)
inline

Definition at line 22 of file gcja5.h.

◆ set_pmc_10_0_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_10_0_sensor ( sensor::Sensor pmc_10_0)
inline

Definition at line 26 of file gcja5.h.

◆ set_pmc_1_0_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_1_0_sensor ( sensor::Sensor pmc_1_0)
inline

Definition at line 23 of file gcja5.h.

◆ set_pmc_2_5_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_2_5_sensor ( sensor::Sensor pmc_2_5)
inline

Definition at line 24 of file gcja5.h.

◆ set_pmc_5_0_sensor()

void esphome::gcja5::GCJA5Component::set_pmc_5_0_sensor ( sensor::Sensor pmc_5_0)
inline

Definition at line 25 of file gcja5.h.

◆ setup()

void esphome::gcja5::GCJA5Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file gcja5.cpp.

Field Documentation

◆ first_status_log_

bool esphome::gcja5::GCJA5Component::first_status_log_ {false}
protected

Definition at line 38 of file gcja5.h.

◆ have_good_data_

bool esphome::gcja5::GCJA5Component::have_good_data_ {false}
protected

Definition at line 37 of file gcja5.h.

◆ last_transmission_

uint32_t esphome::gcja5::GCJA5Component::last_transmission_ {0}
protected

Definition at line 34 of file gcja5.h.

◆ pm_10_0_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pm_10_0_sensor_ {nullptr}
protected

Definition at line 41 of file gcja5.h.

◆ pm_1_0_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pm_1_0_sensor_ {nullptr}
protected

Definition at line 39 of file gcja5.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pm_2_5_sensor_ {nullptr}
protected

Definition at line 40 of file gcja5.h.

◆ pmc_0_3_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_0_3_sensor_ {nullptr}
protected

Definition at line 43 of file gcja5.h.

◆ pmc_0_5_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_0_5_sensor_ {nullptr}
protected

Definition at line 44 of file gcja5.h.

◆ pmc_10_0_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_10_0_sensor_ {nullptr}
protected

Definition at line 48 of file gcja5.h.

◆ pmc_1_0_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_1_0_sensor_ {nullptr}
protected

Definition at line 45 of file gcja5.h.

◆ pmc_2_5_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_2_5_sensor_ {nullptr}
protected

Definition at line 46 of file gcja5.h.

◆ pmc_5_0_sensor_

sensor::Sensor* esphome::gcja5::GCJA5Component::pmc_5_0_sensor_ {nullptr}
protected

Definition at line 47 of file gcja5.h.

◆ rx_message_

std::vector<uint8_t> esphome::gcja5::GCJA5Component::rx_message_
protected

Definition at line 35 of file gcja5.h.


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