ESPHome  2022.1.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::nextion::NextionSensor Class Reference

#include <nextion_sensor.h>

Inheritance diagram for esphome::nextion::NextionSensor:
esphome::nextion::NextionComponent esphome::sensor::Sensor esphome::PollingComponent esphome::nextion::NextionComponentBase esphome::EntityBase esphome::Component

Public Member Functions

 NextionSensor (NextionBase *nextion)
 
void send_state_to_nextion () override
 
void update_component () override
 
void update () override
 
void add_to_wave_buffer (float state)
 
void set_precision (uint8_t precision)
 
void set_component_id (uint8_t component_id)
 
void set_wave_channel_id (uint8_t wave_chan_id)
 
void set_wave_max_value (uint32_t wave_maxvalue)
 
void process_sensor (const std::string &variable_name, int state) override
 
void set_state (float state) override
 
void set_state (float state, bool publish) override
 
void set_state (float state, bool publish, bool send_to_nextion) override
 
void set_waveform_send_last_value (bool send_last_value)
 
uint8_t get_wave_chan_id ()
 
void set_wave_max_length (int wave_max_length)
 
NextionQueueType get_queue_type () override
 
void set_state_from_string (const std::string &state_value, bool publish, bool send_to_nextion) override
 
void set_state_from_int (int state_value, bool publish, bool send_to_nextion) override
 
- Public Member Functions inherited from esphome::nextion::NextionComponent
void update_component_settings () override
 
void update_component_settings (bool force_update) override
 
void set_background_color (Color bco)
 
void set_background_pressed_color (Color bco2)
 
void set_foreground_color (Color pco)
 
void set_foreground_pressed_color (Color pco2)
 
void set_font_id (uint8_t font_id)
 
void set_visible (bool visible)
 
- Public Member Functions inherited from esphome::nextion::NextionComponentBase
virtual ~NextionComponentBase ()=default
 
void set_variable_name (const std::string &variable_name, const std::string &variable_name_to_send="")
 
virtual void process_touch (uint8_t page_id, uint8_t component_id, bool on)
 
virtual void process_text (const std::string &variable_name, const std::string &text_value)
 
virtual void process_bool (const std::string &variable_name, bool on)
 
virtual void set_state (bool state)
 
virtual void set_state (bool state, bool publish)
 
virtual void set_state (bool state, bool publish, bool send_to_nextion)
 
virtual void set_state (const std::string &state)
 
virtual void set_state (const std::string &state, bool publish)
 
virtual void set_state (const std::string &state, bool publish, bool send_to_nextion)
 
uint8_t get_component_id ()
 
void set_component_id (uint8_t component_id)
 
uint8_t get_wave_channel_id ()
 
void set_wave_channel_id (uint8_t wave_chan_id)
 
std::vector< uint8_t > get_wave_buffer ()
 
size_t get_wave_buffer_size ()
 
std::string get_variable_name ()
 
std::string get_variable_name_to_send ()
 
virtual std::string get_queue_type_string ()
 
bool get_needs_to_send_update ()
 
uint8_t get_wave_chan_id ()
 
void set_wave_max_length (int wave_max_length)
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
 Sensor (const std::string &name)
 
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
 
void set_unit_of_measurement (const std::string &unit_of_measurement)
 Manually set the unit of measurement. More...
 
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...
 
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const std::string &device_class)
 Manually set the device class. 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 ()
 A unique ID for this sensor, empty for no unique id. More...
 
void internal_send_state_to_frontend (float state)
 
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_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)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- 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 setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). 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...
 

Protected Member Functions

void wave_update_ ()
 
- Protected Member Functions inherited from esphome::sensor::Sensor
virtual std::string unit_of_measurement ()
 Override this to set the default unit of measurement. More...
 
virtual int8_t accuracy_decimals ()
 Override this to set the default accuracy in decimals. More...
 
virtual std::string device_class ()
 Override this to set the default device class. More...
 
virtual StateClass state_class ()
 Override this to set the default state class. More...
 
uint32_t hash_base () override
 
- Protected Member Functions inherited from esphome::EntityBase
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()> &&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 precision_ = 0
 
uint32_t wave_maxvalue_ = 255
 
float last_value_ = 0
 
bool send_last_value_ = true
 
- Protected Attributes inherited from esphome::nextion::NextionComponent
NextionBasenextion_
 
bool bco_needs_update_ = false
 
bool bco_is_set_ = false
 
Color bco_
 
bool bco2_needs_update_ = false
 
bool bco2_is_set_ = false
 
Color bco2_
 
bool pco_needs_update_ = false
 
bool pco_is_set_ = false
 
Color pco_
 
bool pco2_needs_update_ = false
 
bool pco2_is_set_ = false
 
Color pco2_
 
uint8_t font_id_ = 0
 
bool font_id_needs_update_ = false
 
bool font_id_is_set_ = false
 
bool visible_ = true
 
bool visible_needs_update_ = false
 
bool visible_is_set_ = false
 
- Protected Attributes inherited from esphome::nextion::NextionComponentBase
std::string variable_name_
 
std::string variable_name_to_send_
 
uint8_t component_id_ = 0
 
uint8_t wave_chan_id_ = UINT8_MAX
 
std::vector< uint8_t > wave_buffer_
 
int wave_max_length_ = 255
 
bool needs_to_send_update_
 
- 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...
 
bool has_state_ {false}
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
optional< std::string > unit_of_measurement_
 Unit of measurement override. More...
 
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
 
optional< std::string > device_class_
 Device class override. More...
 
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
 
bool force_update_ {false}
 Force update mode. More...
 
- Protected Attributes inherited from esphome::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- 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
 

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

Definition at line 11 of file nextion_sensor.h.

Constructor & Destructor Documentation

◆ NextionSensor()

esphome::nextion::NextionSensor::NextionSensor ( NextionBase nextion)
inline

Definition at line 13 of file nextion_sensor.h.

Member Function Documentation

◆ add_to_wave_buffer()

void esphome::nextion::NextionSensor::add_to_wave_buffer ( float  state)

Definition at line 20 of file nextion_sensor.cpp.

◆ get_queue_type()

NextionQueueType esphome::nextion::NextionSensor::get_queue_type ( )
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 32 of file nextion_sensor.h.

◆ get_wave_chan_id()

uint8_t esphome::nextion::NextionSensor::get_wave_chan_id ( )
inline

Definition at line 30 of file nextion_sensor.h.

◆ process_sensor()

void esphome::nextion::NextionSensor::process_sensor ( const std::string &  variable_name,
int  state 
)
overridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 10 of file nextion_sensor.cpp.

◆ send_state_to_nextion()

void esphome::nextion::NextionSensor::send_state_to_nextion ( )
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 14 of file nextion_sensor.h.

◆ set_component_id()

void esphome::nextion::NextionSensor::set_component_id ( uint8_t  component_id)
inline

Definition at line 20 of file nextion_sensor.h.

◆ set_precision()

void esphome::nextion::NextionSensor::set_precision ( uint8_t  precision)
inline

Definition at line 19 of file nextion_sensor.h.

◆ set_state() [1/3]

void esphome::nextion::NextionSensor::set_state ( float  state)
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 25 of file nextion_sensor.h.

◆ set_state() [2/3]

void esphome::nextion::NextionSensor::set_state ( float  state,
bool  publish 
)
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 26 of file nextion_sensor.h.

◆ set_state() [3/3]

void esphome::nextion::NextionSensor::set_state ( float  state,
bool  publish,
bool  send_to_nextion 
)
overridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 47 of file nextion_sensor.cpp.

◆ set_state_from_int()

void esphome::nextion::NextionSensor::set_state_from_int ( int  state_value,
bool  publish,
bool  send_to_nextion 
)
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 36 of file nextion_sensor.h.

◆ set_state_from_string()

void esphome::nextion::NextionSensor::set_state_from_string ( const std::string &  state_value,
bool  publish,
bool  send_to_nextion 
)
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 35 of file nextion_sensor.h.

◆ set_wave_channel_id()

void esphome::nextion::NextionSensor::set_wave_channel_id ( uint8_t  wave_chan_id)
inline

Definition at line 21 of file nextion_sensor.h.

◆ set_wave_max_length()

void esphome::nextion::NextionSensor::set_wave_max_length ( int  wave_max_length)
inline

Definition at line 31 of file nextion_sensor.h.

◆ set_wave_max_value()

void esphome::nextion::NextionSensor::set_wave_max_value ( uint32_t  wave_maxvalue)
inline

Definition at line 22 of file nextion_sensor.h.

◆ set_waveform_send_last_value()

void esphome::nextion::NextionSensor::set_waveform_send_last_value ( bool  send_last_value)
inline

Definition at line 29 of file nextion_sensor.h.

◆ update()

void esphome::nextion::NextionSensor::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 32 of file nextion_sensor.cpp.

◆ update_component()

void esphome::nextion::NextionSensor::update_component ( )
inlineoverridevirtual

Reimplemented from esphome::nextion::NextionComponentBase.

Definition at line 16 of file nextion_sensor.h.

◆ wave_update_()

void esphome::nextion::NextionSensor::wave_update_ ( )
protected

Definition at line 93 of file nextion_sensor.cpp.

Field Documentation

◆ last_value_

float esphome::nextion::NextionSensor::last_value_ = 0
protected

Definition at line 44 of file nextion_sensor.h.

◆ precision_

uint8_t esphome::nextion::NextionSensor::precision_ = 0
protected

Definition at line 41 of file nextion_sensor.h.

◆ send_last_value_

bool esphome::nextion::NextionSensor::send_last_value_ = true
protected

Definition at line 45 of file nextion_sensor.h.

◆ wave_maxvalue_

uint32_t esphome::nextion::NextionSensor::wave_maxvalue_ = 255
protected

Definition at line 42 of file nextion_sensor.h.


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