ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mqtt::MQTTSensorComponent Class Reference

#include <mqtt_sensor.h>

Inheritance diagram for esphome::mqtt::MQTTSensorComponent:
esphome::mqtt::MQTTComponent esphome::Component

Public Member Functions

 MQTTSensorComponent (sensor::Sensor *sensor)
 Construct this MQTTSensorComponent instance with the provided friendly_name and sensor. More...
 
void set_expire_after (uint32_t expire_after)
 Setup an expiry, 0 disables it. More...
 
void disable_expire_after ()
 Disable Home Assistant value expiry. More...
 
void send_discovery (JsonObject root, mqtt::SendDiscoveryConfig &config) override
 
void setup () override
 Override setup. More...
 
void dump_config () override
 
uint32_t get_expire_after () const
 Get the expire_after in milliseconds used for Home Assistant discovery, first checks override. More...
 
bool publish_state (float value)
 
bool send_initial_state () override
 
- Public Member Functions inherited from esphome::mqtt::MQTTComponent
 MQTTComponent ()
 Constructs a MQTTComponent. More...
 
void call_setup () override
 Override setup_ so that we can call send_discovery() when needed. More...
 
void call_loop () override
 
void call_dump_config () override
 
virtual bool is_internal ()
 
void set_retain (bool retain)
 Set whether state message should be retained. More...
 
bool get_retain () const
 
void disable_discovery ()
 Disable discovery. Sets friendly name to "". More...
 
bool is_discovery_enabled () const
 
void set_custom_state_topic (const std::string &custom_state_topic)
 Set a custom state topic. Set to "" for default behavior. More...
 
void set_custom_command_topic (const std::string &custom_command_topic)
 Set a custom command topic. Set to "" for default behavior. More...
 
void set_command_retain (bool command_retain)
 Set whether command message should be retained. More...
 
float get_setup_priority () const override
 MQTT_COMPONENT setup priority. More...
 
void set_availability (std::string topic, std::string payload_available, std::string payload_not_available)
 Set the Home Assistant availability data. More...
 
void disable_availability ()
 
void schedule_resend_state ()
 Internal method for the MQTT client base to schedule a resend of the state on reconnect. More...
 
bool publish (const std::string &topic, const std::string &payload)
 Send a MQTT message. More...
 
bool publish_json (const std::string &topic, const json::json_build_t &f)
 Construct and send a JSON MQTT message. More...
 
void subscribe (const std::string &topic, mqtt_callback_t callback, uint8_t qos=0)
 Subscribe to a MQTT topic. More...
 
void subscribe_json (const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos=0)
 Subscribe to a MQTT topic and automatically parse JSON payload. 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
 
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

std::string component_type () const override
 Override for MQTTComponent, returns "sensor". More...
 
const EntityBaseget_entity () const override
 
std::string unique_id () override
 
- Protected Member Functions inherited from esphome::mqtt::MQTTComponent
std::string get_discovery_topic_ (const MQTTDiscoveryInfo &discovery_info) const
 Helper method to get the discovery topic for this component. More...
 
std::string get_default_topic_for_ (const std::string &suffix) const
 Get this components state/command/... More...
 
virtual std::string friendly_name () const
 Get the friendly name of this MQTT component. More...
 
virtual std::string get_icon () const
 Get the icon field of this component. More...
 
virtual bool is_disabled_by_default () const
 Get whether the underlying Entity is disabled by default. More...
 
std::string get_state_topic_ () const
 Get the MQTT topic that new states will be shared to. More...
 
std::string get_command_topic_ () const
 Get the MQTT topic for listening to commands. More...
 
bool is_connected_ () const
 
bool send_discovery_ ()
 Internal method to start sending discovery info, this will call send_discovery(). More...
 
std::string get_default_object_id_ () const
 Generate the Home Assistant MQTT discovery object id by automatically transforming the friendly name. More...
 
- Protected Member Functions inherited from esphome::Component
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

sensor::Sensorsensor_
 
optional< uint32_t > expire_after_
 
- Protected Attributes inherited from esphome::mqtt::MQTTComponent
std::string custom_state_topic_ {}
 
std::string custom_command_topic_ {}
 
bool command_retain_ {false}
 
bool retain_ {true}
 
bool discovery_enabled_ {true}
 
std::unique_ptr< Availabilityavailability_
 
bool resend_state_ {false}
 
- 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}
 

Detailed Description

Definition at line 14 of file mqtt_sensor.h.

Constructor & Destructor Documentation

◆ MQTTSensorComponent()

esphome::mqtt::MQTTSensorComponent::MQTTSensorComponent ( sensor::Sensor sensor)
explicit

Construct this MQTTSensorComponent instance with the provided friendly_name and sensor.

Note the sensor is never stored and is only used for initializing some values of this class. If sensor is nullptr, then automatic initialization of these fields is disabled.

Parameters
sensorThe sensor, this can be null to disable automatic setup.

Definition at line 20 of file mqtt_sensor.cpp.

Member Function Documentation

◆ component_type()

std::string esphome::mqtt::MQTTSensorComponent::component_type ( ) const
overrideprotectedvirtual

Override for MQTTComponent, returns "sensor".

Implements esphome::mqtt::MQTTComponent.

Definition at line 34 of file mqtt_sensor.cpp.

◆ disable_expire_after()

void esphome::mqtt::MQTTSensorComponent::disable_expire_after ( )

Disable Home Assistant value expiry.

Definition at line 43 of file mqtt_sensor.cpp.

◆ dump_config()

void esphome::mqtt::MQTTSensorComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file mqtt_sensor.cpp.

◆ get_entity()

const EntityBase * esphome::mqtt::MQTTSensorComponent::get_entity ( ) const
overrideprotectedvirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 35 of file mqtt_sensor.cpp.

◆ get_expire_after()

uint32_t esphome::mqtt::MQTTSensorComponent::get_expire_after ( ) const

Get the expire_after in milliseconds used for Home Assistant discovery, first checks override.

Definition at line 37 of file mqtt_sensor.cpp.

◆ publish_state()

bool esphome::mqtt::MQTTSensorComponent::publish_state ( float  value)

Definition at line 70 of file mqtt_sensor.cpp.

◆ send_discovery()

void esphome::mqtt::MQTTSensorComponent::send_discovery ( JsonObject  root,
mqtt::SendDiscoveryConfig config 
)
overridevirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 45 of file mqtt_sensor.cpp.

◆ send_initial_state()

bool esphome::mqtt::MQTTSensorComponent::send_initial_state ( )
overridevirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 63 of file mqtt_sensor.cpp.

◆ set_expire_after()

void esphome::mqtt::MQTTSensorComponent::set_expire_after ( uint32_t  expire_after)

Setup an expiry, 0 disables it.

Definition at line 42 of file mqtt_sensor.cpp.

◆ setup()

void esphome::mqtt::MQTTSensorComponent::setup ( )
overridevirtual

Override setup.

Reimplemented from esphome::Component.

Definition at line 22 of file mqtt_sensor.cpp.

◆ unique_id()

std::string esphome::mqtt::MQTTSensorComponent::unique_id ( )
overrideprotectedvirtual

Reimplemented from esphome::mqtt::MQTTComponent.

Definition at line 74 of file mqtt_sensor.cpp.

Field Documentation

◆ expire_after_

optional<uint32_t> esphome::mqtt::MQTTSensorComponent::expire_after_
protected

Definition at line 52 of file mqtt_sensor.h.

◆ sensor_

sensor::Sensor* esphome::mqtt::MQTTSensorComponent::sensor_
protected

Definition at line 51 of file mqtt_sensor.h.


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