ESPHome  2024.11.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ezo::EZOSensor Class Reference

This class implements support for the EZO circuits in i2c mode. More...

#include <ezo.h>

Inheritance diagram for esphome::ezo::EZOSensor:
esphome::sensor::Sensor esphome::PollingComponent esphome::i2c::I2CDevice esphome::EntityBase esphome::EntityBase_DeviceClass esphome::EntityBase_UnitOfMeasurement esphome::Component

Public Member Functions

void loop () override
 
void dump_config () override
 
void update () override
 
float get_setup_priority () const override
 
void set_address (uint8_t address)
 
void get_device_information ()
 
void add_device_infomation_callback (std::function< void(std::string)> &&callback)
 
void set_sleep ()
 
void get_state ()
 
void get_slope ()
 
void add_slope_callback (std::function< void(std::string)> &&callback)
 
void get_t ()
 
void set_t (float value)
 
void set_tempcomp_value (float temp)
 
void add_t_callback (std::function< void(std::string)> &&callback)
 
void get_calibration ()
 
void set_calibration_point_low (float value)
 
void set_calibration_point_mid (float value)
 
void set_calibration_point_high (float value)
 
void set_calibration_generic (float value)
 
void clear_calibration ()
 
void add_calibration_callback (std::function< void(std::string)> &&callback)
 
void get_led_state ()
 
void set_led_state (bool on)
 
void add_led_state_callback (std::function< void(bool)> &&callback)
 
void send_custom (const std::string &to_send)
 
void add_custom_callback (std::function< void(std::string)> &&callback)
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals, using the manual override if set. More...
 
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals. More...
 
StateClass get_state_class ()
 Get the state class, using the manual override if set. More...
 
void set_state_class (StateClass state_class)
 Manually set the state class. More...
 
bool get_force_update () const
 Get whether force update mode is enabled. More...
 
void set_force_update (bool force_update)
 Set force update mode. More...
 
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back. More...
 
void add_filters (const std::vector< Filter *> &filters)
 Add a list of vectors to the back of the filter chain. More...
 
void set_filters (const std::vector< Filter *> &filters)
 Clear the filters and replace them by filters. More...
 
void clear_filters ()
 Clear the entire filter chain. More...
 
float get_state () const
 Getter-syntax for .state. More...
 
float get_raw_state () const
 Getter-syntax for .raw_state. More...
 
void publish_state (float state)
 Publish a new state to the front-end. More...
 
void add_on_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time a filtered value arrives. More...
 
void add_on_raw_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time the sensor sends a raw value. More...
 
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
 
virtual std::string unique_id ()
 Override this method to set the unique ID of this sensor. More...
 
void internal_send_state_to_frontend (float state)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 
- Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
 
void set_unit_of_measurement (const char *unit_of_measurement)
 Manually set the unit of measurement. 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...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. 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 () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

void add_command_ (const std::string &command, EzoCommandType command_type, uint16_t delay_ms=300)
 
void set_calibration_point_ (EzoCalibrationType type, float value)
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- 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(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

std::deque< std::unique_ptr< EzoCommand > > commands_
 
int new_address_
 
CallbackManager< void(std::string)> device_infomation_callback_ {}
 
CallbackManager< void(std::string)> calibration_callback_ {}
 
CallbackManager< void(std::string)> slope_callback_ {}
 
CallbackManager< void(std::string)> t_callback_ {}
 
CallbackManager< void(std::string)> custom_callback_ {}
 
CallbackManager< void(bool)> led_callback_ {}
 
uint32_t start_time_ = 0
 
- Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
 
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
 
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
 
bool force_update_ {false}
 Force update mode. More...
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 
- Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char * unit_of_measurement_ {nullptr}
 Unit of measurement override. More...
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Additional Inherited Members

- Data Fields inherited from esphome::sensor::Sensor
float state
 This member variable stores the last state that has passed through all filters. More...
 
float raw_state
 This member variable stores the current raw state of the sensor, without any filters applied. More...
 

Detailed Description

This class implements support for the EZO circuits in i2c mode.

Definition at line 36 of file ezo.h.

Member Function Documentation

◆ add_calibration_callback()

void esphome::ezo::EZOSensor::add_calibration_callback ( std::function< void(std::string)> &&  callback)
inline

Definition at line 77 of file ezo.h.

◆ add_command_()

void esphome::ezo::EZOSensor::add_command_ ( const std::string &  command,
EzoCommandType  command_type,
uint16_t  delay_ms = 300 
)
protected

Definition at line 175 of file ezo.cpp.

◆ add_custom_callback()

void esphome::ezo::EZOSensor::add_custom_callback ( std::function< void(std::string)> &&  callback)
inline

Definition at line 88 of file ezo.h.

◆ add_device_infomation_callback()

void esphome::ezo::EZOSensor::add_device_infomation_callback ( std::function< void(std::string)> &&  callback)
inline

Definition at line 48 of file ezo.h.

◆ add_led_state_callback()

void esphome::ezo::EZOSensor::add_led_state_callback ( std::function< void(bool)> &&  callback)
inline

Definition at line 84 of file ezo.h.

◆ add_slope_callback()

void esphome::ezo::EZOSensor::add_slope_callback ( std::function< void(std::string)> &&  callback)
inline

Definition at line 60 of file ezo.h.

◆ add_t_callback()

void esphome::ezo::EZOSensor::add_t_callback ( std::function< void(std::string)> &&  callback)
inline

Definition at line 68 of file ezo.h.

◆ clear_calibration()

void esphome::ezo::EZOSensor::clear_calibration ( )

Definition at line 234 of file ezo.cpp.

◆ dump_config()

void esphome::ezo::EZOSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file ezo.cpp.

◆ get_calibration()

void esphome::ezo::EZOSensor::get_calibration ( )

Definition at line 215 of file ezo.cpp.

◆ get_device_information()

void esphome::ezo::EZOSensor::get_device_information ( )

Definition at line 198 of file ezo.cpp.

◆ get_led_state()

void esphome::ezo::EZOSensor::get_led_state ( )

Definition at line 236 of file ezo.cpp.

◆ get_setup_priority()

float esphome::ezo::EZOSensor::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file ezo.h.

◆ get_slope()

void esphome::ezo::EZOSensor::get_slope ( )

Definition at line 204 of file ezo.cpp.

◆ get_state()

void esphome::ezo::EZOSensor::get_state ( )

Definition at line 202 of file ezo.cpp.

◆ get_t()

void esphome::ezo::EZOSensor::get_t ( )

Definition at line 206 of file ezo.cpp.

◆ loop()

void esphome::ezo::EZOSensor::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file ezo.cpp.

◆ send_custom()

void esphome::ezo::EZOSensor::send_custom ( const std::string &  to_send)

Definition at line 244 of file ezo.cpp.

◆ set_address()

void esphome::ezo::EZOSensor::set_address ( uint8_t  address)

Definition at line 188 of file ezo.cpp.

◆ set_calibration_generic()

void esphome::ezo::EZOSensor::set_calibration_generic ( float  value)

Definition at line 229 of file ezo.cpp.

◆ set_calibration_point_()

void esphome::ezo::EZOSensor::set_calibration_point_ ( EzoCalibrationType  type,
float  value 
)
protected

Definition at line 183 of file ezo.cpp.

◆ set_calibration_point_high()

void esphome::ezo::EZOSensor::set_calibration_point_high ( float  value)

Definition at line 225 of file ezo.cpp.

◆ set_calibration_point_low()

void esphome::ezo::EZOSensor::set_calibration_point_low ( float  value)

Definition at line 217 of file ezo.cpp.

◆ set_calibration_point_mid()

void esphome::ezo::EZOSensor::set_calibration_point_mid ( float  value)

Definition at line 221 of file ezo.cpp.

◆ set_led_state()

void esphome::ezo::EZOSensor::set_led_state ( bool  on)

Definition at line 238 of file ezo.cpp.

◆ set_sleep()

void esphome::ezo::EZOSensor::set_sleep ( )

Definition at line 200 of file ezo.cpp.

◆ set_t()

void esphome::ezo::EZOSensor::set_t ( float  value)

Definition at line 208 of file ezo.cpp.

◆ set_tempcomp_value()

void esphome::ezo::EZOSensor::set_tempcomp_value ( float  temp)

Definition at line 213 of file ezo.cpp.

◆ update()

void esphome::ezo::EZOSensor::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 23 of file ezo.cpp.

Field Documentation

◆ calibration_callback_

CallbackManager<void(std::string)> esphome::ezo::EZOSensor::calibration_callback_ {}
protected

Definition at line 101 of file ezo.h.

◆ commands_

std::deque<std::unique_ptr<EzoCommand> > esphome::ezo::EZOSensor::commands_
protected

Definition at line 93 of file ezo.h.

◆ custom_callback_

CallbackManager<void(std::string)> esphome::ezo::EZOSensor::custom_callback_ {}
protected

Definition at line 104 of file ezo.h.

◆ device_infomation_callback_

CallbackManager<void(std::string)> esphome::ezo::EZOSensor::device_infomation_callback_ {}
protected

Definition at line 100 of file ezo.h.

◆ led_callback_

CallbackManager<void(bool)> esphome::ezo::EZOSensor::led_callback_ {}
protected

Definition at line 105 of file ezo.h.

◆ new_address_

int esphome::ezo::EZOSensor::new_address_
protected

Definition at line 94 of file ezo.h.

◆ slope_callback_

CallbackManager<void(std::string)> esphome::ezo::EZOSensor::slope_callback_ {}
protected

Definition at line 102 of file ezo.h.

◆ start_time_

uint32_t esphome::ezo::EZOSensor::start_time_ = 0
protected

Definition at line 107 of file ezo.h.

◆ t_callback_

CallbackManager<void(std::string)> esphome::ezo::EZOSensor::t_callback_ {}
protected

Definition at line 103 of file ezo.h.


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