ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
mqtt_lock.cpp
Go to the documentation of this file.
1#include "mqtt_lock.h"
2#include "esphome/core/log.h"
4
5#include "mqtt_const.h"
6
7#ifdef USE_MQTT
8#ifdef USE_LOCK
9
10namespace esphome::mqtt {
11
12ESPHOME_LOG_TAG(TAG, "mqtt.lock");
13
14using namespace esphome::lock;
15
17
19 this->subscribe(this->command_topic_source_(), [this](const std::string &topic, const std::string &payload) {
20 if (ESPHOME_strcasecmp_P(payload.c_str(), ESPHOME_PSTR("LOCK")) == 0) {
21 this->lock_->lock();
22 } else if (ESPHOME_strcasecmp_P(payload.c_str(), ESPHOME_PSTR("UNLOCK")) == 0) {
23 this->lock_->unlock();
24 } else if (ESPHOME_strcasecmp_P(payload.c_str(), ESPHOME_PSTR("OPEN")) == 0) {
25 this->lock_->open();
26 } else {
27 ESP_LOGW(TAG, "'%s': Received unknown status payload: %s", LOG_STR_ARG(this->log_name_()), payload.c_str());
28 this->status_momentary_warning(5000);
29 }
30 });
32 [this](LockState /*state*/) { this->defer(SEND_DEFER_ID, [this]() { this->publish_state(); }); });
33}
34void MQTTLockComponent::dump_config() { LOG_MQTT_COMPONENT(true, true); }
35
37const EntityBase *MQTTLockComponent::get_entity() const { return this->lock_; }
39 // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
40 if (this->lock_->traits.get_assumed_state()) {
41 root[MQTT_OPTIMISTIC] = true;
42 }
43 if (this->lock_->traits.get_supports_open())
44 root[MQTT_PAYLOAD_OPEN] = "OPEN";
45}
47
49 char topic_buf[MQTT_DEFAULT_TOPIC_MAX_LEN];
50 return this->publish(this->get_state_topic_to_(topic_buf),
51 reinterpret_cast<ProgmemStr>(lock_state_to_string(this->lock_->state)));
52}
53
54} // namespace esphome::mqtt
55
56#endif
57#endif // USE_MQTT
void status_momentary_warning(uint32_t length=5000)
Set warning status flag and clear it after length ms.
void defer(const char *name, std::function< void()> &&f)
Defer a callback to the next loop() call with a const char* name.
Base class for all locks.
Definition lock.h:112
void lock()
Turn this lock on.
Definition lock.cpp:29
LockTraits traits
Definition lock.h:133
LockState state
The current reported state of the lock.
Definition lock.h:131
void unlock()
Turn this lock off.
Definition lock.cpp:30
void open()
Open (unlatch) this lock.
Definition lock.cpp:31
void add_on_state_callback(F &&callback)
Set callback for state changes.
Definition lock.h:155
bool get_assumed_state() const
Definition lock.h:42
bool get_supports_open() const
Definition lock.h:38
static constexpr uint32_t SEND_DEFER_ID
const LogString * log_name_() const
Entity name for a "%s" log argument.
void subscribe(T &&topic, F &&callback, uint8_t qos=0)
Subscribe to a MQTT topic.
MQTTTopicSource command_topic_source_() const
The command topic as a subscription source. A lambda topic is read once and copied,...
bool publish(const std::string &topic, const std::string &payload)
Send a MQTT message.
StringRef get_state_topic_to_(std::span< char, MQTT_DEFAULT_TOPIC_MAX_LEN > buf) const
Get the MQTT state topic into a buffer (no heap allocation for non-lambda custom topics).
MQTTLockComponent(lock::Lock *a_lock)
Definition mqtt_lock.cpp:16
void send_discovery(JsonObject root, mqtt::SendDiscoveryConfig &config) override
ESPHOME_LOG_TAG(TAG, "alarm_control_panel")
const LogString * lock_state_to_string(LockState state)
Definition lock.cpp:16
LockState
Enum for all states a lock can be in.
Definition lock.h:22
MQTT_COMPONENT_TYPE(MQTTAlarmControlPanelComponent, "alarm_control_panel") const EntityBase *MQTTAlarmControlPanelComponent
const __FlashStringHelper * ProgmemStr
Definition progmem.h:31
Simple Helper struct used for Home Assistant MQTT send_discovery().