ESPHome
2026.1.4
Loading...
Searching...
No Matches
esphome
components
mqtt
mqtt_button.h
Go to the documentation of this file.
1
#pragma once
2
3
#include "
esphome/core/defines.h
"
4
5
#ifdef USE_MQTT
6
#ifdef USE_BUTTON
7
8
#include "
esphome/components/button/button.h
"
9
#include "
mqtt_component.h
"
10
11
namespace
esphome::mqtt
{
12
13
class
MQTTButtonComponent
:
public
mqtt::MQTTComponent
{
14
public
:
15
explicit
MQTTButtonComponent
(
button::Button
*button);
16
17
// ========== INTERNAL METHODS ==========
18
// (In most use cases you won't need these)
19
void
setup
()
override
;
20
void
dump_config
()
override
;
21
23
bool
send_initial_state
()
override
{
return
true
; }
24
25
void
send_discovery
(JsonObject root,
mqtt::SendDiscoveryConfig
&config)
override
;
26
27
protected
:
29
const
char
*
component_type
()
const override
;
30
const
EntityBase
*
get_entity
()
const override
;
31
32
button::Button
*
button_
;
33
};
34
35
}
// namespace esphome::mqtt
36
37
#endif
38
#endif
// USE_MQTT
button.h
esphome::EntityBase
Definition
entity_base.h:39
esphome::button::Button
Base class for all buttons.
Definition
button.h:25
esphome::mqtt::MQTTButtonComponent
Definition
mqtt_button.h:13
esphome::mqtt::MQTTButtonComponent::get_entity
const EntityBase * get_entity() const override
esphome::mqtt::MQTTButtonComponent::button_
button::Button * button_
Definition
mqtt_button.h:32
esphome::mqtt::MQTTButtonComponent::send_discovery
void send_discovery(JsonObject root, mqtt::SendDiscoveryConfig &config) override
Definition
mqtt_button.cpp:32
esphome::mqtt::MQTTButtonComponent::dump_config
void dump_config() override
Definition
mqtt_button.cpp:27
esphome::mqtt::MQTTButtonComponent::component_type
const char * component_type() const override
"button" component type.
esphome::mqtt::MQTTButtonComponent::send_initial_state
bool send_initial_state() override
Buttons do not send a state so just return true.
Definition
mqtt_button.h:23
esphome::mqtt::MQTTButtonComponent::MQTTButtonComponent
MQTTButtonComponent(button::Button *button)
Definition
mqtt_button.cpp:15
esphome::mqtt::MQTTButtonComponent::setup
void setup() override
Definition
mqtt_button.cpp:17
esphome::mqtt::MQTTComponent
MQTTComponent is the base class for all components that interact with MQTT to expose certain function...
Definition
mqtt_component.h:76
defines.h
mqtt_component.h
esphome::mqtt
Definition
custom_mqtt_device.cpp:7
esphome::mqtt::SendDiscoveryConfig
Simple Helper struct used for Home Assistant MQTT send_discovery().
Definition
mqtt_component.h:18
Generated by
1.12.0