ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::rotary_encoder::RotaryEncoderSensor Class Reference

#include <rotary_encoder.h>

Inheritance diagram for esphome::rotary_encoder::RotaryEncoderSensor:
esphome::sensor::Sensor esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass esphome::EntityBase_UnitOfMeasurement

Public Member Functions

void set_pin_a (InternalGPIOPin *pin_a)
 
void set_pin_b (InternalGPIOPin *pin_b)
 
void set_restore_mode (RotaryEncoderRestoreMode restore_mode)
 Set the restore mode of the rotary encoder. More...
 
void set_resolution (RotaryEncoderResolution mode)
 Set the resolution of the rotary encoder. More...
 
void set_value (int value)
 Manually set the value of the counter. More...
 
void set_reset_pin (GPIOPin *pin_i)
 
void set_min_value (int32_t min_value)
 
void set_max_value (int32_t max_value)
 
void set_publish_initial_value (bool publish_initial_value)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void add_on_clockwise_callback (std::function< void()> callback)
 
void add_on_anticlockwise_callback (std::function< void()> callback)
 
void register_listener (std::function< void(uint32_t)> listener)
 
- 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::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 () 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...
 

Protected Attributes

InternalGPIOPinpin_a_
 
InternalGPIOPinpin_b_
 
GPIOPinpin_i_ {nullptr}
 
bool publish_initial_value_
 Index pin, if this is not nullptr, the counter will reset to 0 once this pin is HIGH. More...
 
ESPPreferenceObject rtc_
 
RotaryEncoderRestoreMode restore_mode_ {ROTARY_ENCODER_RESTORE_DEFAULT_ZERO}
 
RotaryEncoderSensorStore store_ {}
 
CallbackManager< void()> on_clockwise_callback_ {}
 
CallbackManager< void()> on_anticlockwise_callback_ {}
 
CallbackManager< void(int32_t)> listeners_ {}
 
- 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::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...
 
- 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_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...
 

Detailed Description

Definition at line 45 of file rotary_encoder.h.

Member Function Documentation

◆ add_on_anticlockwise_callback()

void esphome::rotary_encoder::RotaryEncoderSensor::add_on_anticlockwise_callback ( std::function< void()>  callback)
inline

Definition at line 91 of file rotary_encoder.h.

◆ add_on_clockwise_callback()

void esphome::rotary_encoder::RotaryEncoderSensor::add_on_clockwise_callback ( std::function< void()>  callback)
inline

Definition at line 87 of file rotary_encoder.h.

◆ dump_config()

void esphome::rotary_encoder::RotaryEncoderSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 159 of file rotary_encoder.cpp.

◆ get_setup_priority()

float esphome::rotary_encoder::RotaryEncoderSensor::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 234 of file rotary_encoder.cpp.

◆ loop()

void esphome::rotary_encoder::RotaryEncoderSensor::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 188 of file rotary_encoder.cpp.

◆ register_listener()

void esphome::rotary_encoder::RotaryEncoderSensor::register_listener ( std::function< void(uint32_t)>  listener)
inline

Definition at line 95 of file rotary_encoder.h.

◆ set_max_value()

void esphome::rotary_encoder::RotaryEncoderSensor::set_max_value ( int32_t  max_value)

Definition at line 240 of file rotary_encoder.cpp.

◆ set_min_value()

void esphome::rotary_encoder::RotaryEncoderSensor::set_min_value ( int32_t  min_value)

Definition at line 239 of file rotary_encoder.cpp.

◆ set_pin_a()

void esphome::rotary_encoder::RotaryEncoderSensor::set_pin_a ( InternalGPIOPin pin_a)
inline

Definition at line 47 of file rotary_encoder.h.

◆ set_pin_b()

void esphome::rotary_encoder::RotaryEncoderSensor::set_pin_b ( InternalGPIOPin pin_b)
inline

Definition at line 48 of file rotary_encoder.h.

◆ set_publish_initial_value()

void esphome::rotary_encoder::RotaryEncoderSensor::set_publish_initial_value ( bool  publish_initial_value)
inline

Definition at line 77 of file rotary_encoder.h.

◆ set_reset_pin()

void esphome::rotary_encoder::RotaryEncoderSensor::set_reset_pin ( GPIOPin pin_i)
inline

Definition at line 74 of file rotary_encoder.h.

◆ set_resolution()

void esphome::rotary_encoder::RotaryEncoderSensor::set_resolution ( RotaryEncoderResolution  mode)

Set the resolution of the rotary encoder.

By default, this component will increment the counter by 1 with every A-B input cycle. You can however change this behavior to have more coarse resolutions like 4 counter increases per A-B cycle.

Parameters
modeThe new mode of the encoder.

Definition at line 238 of file rotary_encoder.cpp.

◆ set_restore_mode()

void esphome::rotary_encoder::RotaryEncoderSensor::set_restore_mode ( RotaryEncoderRestoreMode  restore_mode)

Set the restore mode of the rotary encoder.

By default (if possible) the last known counter state is restored. Otherwise the value 0 is used. Restoring the state can also be turned off.

Parameters
restore_modeThe restore mode to use.

Definition at line 235 of file rotary_encoder.cpp.

◆ set_value()

void esphome::rotary_encoder::RotaryEncoderSensor::set_value ( int  value)
inline

Manually set the value of the counter.

Definition at line 69 of file rotary_encoder.h.

◆ setup()

void esphome::rotary_encoder::RotaryEncoderSensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file rotary_encoder.cpp.

Field Documentation

◆ listeners_

CallbackManager<void(int32_t)> esphome::rotary_encoder::RotaryEncoderSensor::listeners_ {}
protected

Definition at line 109 of file rotary_encoder.h.

◆ on_anticlockwise_callback_

CallbackManager<void()> esphome::rotary_encoder::RotaryEncoderSensor::on_anticlockwise_callback_ {}
protected

Definition at line 108 of file rotary_encoder.h.

◆ on_clockwise_callback_

CallbackManager<void()> esphome::rotary_encoder::RotaryEncoderSensor::on_clockwise_callback_ {}
protected

Definition at line 107 of file rotary_encoder.h.

◆ pin_a_

InternalGPIOPin* esphome::rotary_encoder::RotaryEncoderSensor::pin_a_
protected

Definition at line 98 of file rotary_encoder.h.

◆ pin_b_

InternalGPIOPin* esphome::rotary_encoder::RotaryEncoderSensor::pin_b_
protected

Definition at line 99 of file rotary_encoder.h.

◆ pin_i_

GPIOPin* esphome::rotary_encoder::RotaryEncoderSensor::pin_i_ {nullptr}
protected

Definition at line 100 of file rotary_encoder.h.

◆ publish_initial_value_

bool esphome::rotary_encoder::RotaryEncoderSensor::publish_initial_value_
protected

Index pin, if this is not nullptr, the counter will reset to 0 once this pin is HIGH.

Definition at line 101 of file rotary_encoder.h.

◆ restore_mode_

RotaryEncoderRestoreMode esphome::rotary_encoder::RotaryEncoderSensor::restore_mode_ {ROTARY_ENCODER_RESTORE_DEFAULT_ZERO}
protected

Definition at line 103 of file rotary_encoder.h.

◆ rtc_

ESPPreferenceObject esphome::rotary_encoder::RotaryEncoderSensor::rtc_
protected

Definition at line 102 of file rotary_encoder.h.

◆ store_

RotaryEncoderSensorStore esphome::rotary_encoder::RotaryEncoderSensor::store_ {}
protected

Definition at line 105 of file rotary_encoder.h.


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