ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mqtt::MQTTBinarySensorComponent Class Reference

#include <mqtt_binary_sensor.h>

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

Public Member Functions

 MQTTBinarySensorComponent (binary_sensor::BinarySensor *binary_sensor)
 Construct a MQTTBinarySensorComponent. More...
 
void setup () override
 
void dump_config () override
 
void send_discovery (JsonObject root, mqtt::SendDiscoveryConfig &config) override
 
void set_is_status (bool status)
 
bool send_initial_state () override
 
bool publish_state (bool state)
 
- 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
 
const EntityBaseget_entity () const 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 unique_id ()
 A unique ID for this MQTT component, empty for no unique id. 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

binary_sensor::BinarySensorbinary_sensor_
 
- 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 13 of file mqtt_binary_sensor.h.

Constructor & Destructor Documentation

◆ MQTTBinarySensorComponent()

esphome::mqtt::MQTTBinarySensorComponent::MQTTBinarySensorComponent ( binary_sensor::BinarySensor binary_sensor)
explicit

Construct a MQTTBinarySensorComponent.

Parameters
binary_sensorThe binary sensor.

Definition at line 25 of file mqtt_binary_sensor.cpp.

Member Function Documentation

◆ component_type()

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

Implements esphome::mqtt::MQTTComponent.

Definition at line 14 of file mqtt_binary_sensor.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 21 of file mqtt_binary_sensor.cpp.

◆ get_entity()

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

Implements esphome::mqtt::MQTTComponent.

Definition at line 15 of file mqtt_binary_sensor.cpp.

◆ publish_state()

bool esphome::mqtt::MQTTBinarySensorComponent::publish_state ( bool  state)

Definition at line 48 of file mqtt_binary_sensor.cpp.

◆ send_discovery()

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

Implements esphome::mqtt::MQTTComponent.

Definition at line 32 of file mqtt_binary_sensor.cpp.

◆ send_initial_state()

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

Implements esphome::mqtt::MQTTComponent.

Definition at line 41 of file mqtt_binary_sensor.cpp.

◆ set_is_status()

void esphome::mqtt::MQTTBinarySensorComponent::set_is_status ( bool  status)

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 17 of file mqtt_binary_sensor.cpp.

Field Documentation

◆ binary_sensor_

binary_sensor::BinarySensor* esphome::mqtt::MQTTBinarySensorComponent::binary_sensor_
protected

Definition at line 36 of file mqtt_binary_sensor.h.


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