ESPHome  1.17.2
Public Member Functions | Protected Attributes
esphome::mcp3008::MCP3008Sensor Class Reference

#include <mcp3008.h>

Inheritance diagram for esphome::mcp3008::MCP3008Sensor:
esphome::PollingComponent esphome::sensor::Sensor esphome::voltage_sampler::VoltageSampler esphome::Component esphome::Nameable

Public Member Functions

 MCP3008Sensor (MCP3008 *parent, std::string name, uint8_t pin, float reference_voltage)
 
void set_reference_voltage (float reference_voltage)
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
float sample () override
 
- 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 loop ()
 This method will be called repeatedly. 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
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
 Sensor (const std::string &name)
 
void set_unit_of_measurement (const std::string &unit_of_measurement)
 Manually set the unit of measurement of this sensor. More...
 
void set_icon (const std::string &icon)
 Manually set the icon of this sensor. More...
 
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals for this sensor. 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_value () const ESPDEPRECATED(".value is deprecated
 Getter-syntax for .value. Please use .state instead. More...
 
float get_state () const
 Getter-syntax for .state. More...
 
float get_raw_value () const ESPDEPRECATED(".raw_value is deprecated
 Getter-syntax for .raw_value. Please use .raw_state instead. More...
 
float get_raw_state () const
 Getter-syntax for .raw_state. More...
 
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals. Uses the manual override if specified or the default value instead. More...
 
std::string get_unit_of_measurement ()
 Get the unit of measurement. Uses the manual override if specified or the default value instead. More...
 
std::string get_icon ()
 Get the Home Assistant Icon. Uses the manual override if specified or the default value instead. More...
 
void publish_state (float state)
 Publish a new state to the front-end. More...
 
void push_new_value (float state) ESPDEPRECATED("push_new_value is deprecated. Please use .publish_state instead")
 Push a new value to the MQTT 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...
 
void set_device_class (const std::string &device_class)
 Manually set the Home Assistant device class (see sensor::device_class) More...
 
std::string get_device_class ()
 Get the device class for this sensor, using the manual override if specified. More...
 
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
 
virtual std::string device_class ()
 Override this to set the Home Assistant device class for this sensor. More...
 
virtual std::string unique_id ()
 A unique ID for this sensor, empty for no unique id. More...
 
virtual uint32_t update_interval ()
 Return with which interval the sensor is polled. Return 0 for non-polling mode. More...
 
uint32_t calculate_expected_filter_update_interval ()
 Calculate the expected update interval for values that pass through all filters. More...
 
void internal_send_state_to_frontend (float state)
 
bool get_force_update () const
 
void set_force_update (bool force_update)
 Set this sensor's force_update mode. More...
 
- Public Member Functions inherited from esphome::Nameable
 Nameable ()
 
 Nameable (const std::string &name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_object_id ()
 Get the sanitized name of this nameable as an ID. Caching it internally. More...
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 

Protected Attributes

MCP3008parent_
 
uint8_t pin_
 
float reference_voltage_
 
- 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}
 
- Protected Attributes inherited from esphome::sensor::Sensor
optional< std::string > device_class_ {}
 Stores the override of the device class. More...
 
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
 
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
 
optional< std::string > unit_of_measurement_
 Override the unit of measurement. More...
 
optional< std::string > icon_
 Override the icon advertised to Home Assistant, otherwise sensor's icon will be used. More...
 
optional< int8_t > accuracy_decimals_
 Override the accuracy in decimals, otherwise the sensor's values will be used. More...
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
bool has_state_ {false}
 
bool force_update_ {false}
 
- Protected Attributes inherited from esphome::Nameable
std::string name_
 
std::string object_id_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 

Additional Inherited Members

- Data Fields inherited from esphome::sensor::Sensor
float please use state
 
float please use raw_state
 
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. More...
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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 Member Functions inherited from esphome::sensor::Sensor
virtual std::string unit_of_measurement ()
 Override this to set the Home Assistant unit of measurement for this sensor. More...
 
virtual std::string icon ()
 Override this to set the Home Assistant icon for this sensor. More...
 
virtual int8_t accuracy_decimals ()
 Return the accuracy in decimals for this sensor. More...
 
uint32_t hash_base () override
 
- Protected Member Functions inherited from esphome::Nameable
void calc_object_id_ ()
 

Detailed Description

Definition at line 27 of file mcp3008.h.

Constructor & Destructor Documentation

◆ MCP3008Sensor()

esphome::mcp3008::MCP3008Sensor::MCP3008Sensor ( MCP3008 parent,
std::string  name,
uint8_t  pin,
float  reference_voltage 
)

Definition at line 40 of file mcp3008.cpp.

Member Function Documentation

◆ dump_config()

void esphome::mcp3008::MCP3008Sensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 49 of file mcp3008.cpp.

◆ get_setup_priority()

float esphome::mcp3008::MCP3008Sensor::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 46 of file mcp3008.cpp.

◆ sample()

float esphome::mcp3008::MCP3008Sensor::sample ( )
overridevirtual

Implements esphome::voltage_sampler::VoltageSampler.

Definition at line 54 of file mcp3008.cpp.

◆ set_reference_voltage()

void esphome::mcp3008::MCP3008Sensor::set_reference_voltage ( float  reference_voltage)
inline

Definition at line 31 of file mcp3008.h.

◆ setup()

void esphome::mcp3008::MCP3008Sensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 48 of file mcp3008.cpp.

◆ update()

void esphome::mcp3008::MCP3008Sensor::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 59 of file mcp3008.cpp.

Field Documentation

◆ parent_

MCP3008* esphome::mcp3008::MCP3008Sensor::parent_
protected

Definition at line 39 of file mcp3008.h.

◆ pin_

uint8_t esphome::mcp3008::MCP3008Sensor::pin_
protected

Definition at line 40 of file mcp3008.h.

◆ reference_voltage_

float esphome::mcp3008::MCP3008Sensor::reference_voltage_
protected

Definition at line 41 of file mcp3008.h.


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