ESPHome 2026.1.0-dev
Loading...
Searching...
No Matches
mqtt_light.cpp
Go to the documentation of this file.
1#include "mqtt_light.h"
2#include "esphome/core/log.h"
3
4#include "mqtt_const.h"
5
6#ifdef USE_JSON
7#ifdef USE_MQTT
8#ifdef USE_LIGHT
9
11namespace esphome {
12namespace mqtt {
13
14static const char *const TAG = "mqtt.light";
15
16using namespace esphome::light;
17
18std::string MQTTJSONLightComponent::component_type() const { return "light"; }
20
22 this->subscribe_json(this->get_command_topic_(), [this](const std::string &topic, JsonObject root) {
23 LightCall call = this->state_->make_call();
24 LightJSONSchema::parse_json(*this->state_, call, root);
25 call.perform();
26 });
27
29}
30
32 this->defer("send", [this]() { this->publish_state_(); });
33}
34
36
38 return this->publish_json(this->get_state_topic_(), [this](JsonObject root) {
39 // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
41 });
42}
44
46 // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
47 root["schema"] = "json";
48 auto traits = this->state_->get_traits();
49
50 root[MQTT_COLOR_MODE] = true;
51 // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
52 JsonArray color_modes = root["supported_color_modes"].to<JsonArray>();
53 if (traits.supports_color_mode(ColorMode::ON_OFF))
54 color_modes.add("onoff");
55 if (traits.supports_color_mode(ColorMode::BRIGHTNESS))
56 color_modes.add("brightness");
57 if (traits.supports_color_mode(ColorMode::WHITE))
58 color_modes.add("white");
59 if (traits.supports_color_mode(ColorMode::COLOR_TEMPERATURE) ||
60 traits.supports_color_mode(ColorMode::COLD_WARM_WHITE))
61 color_modes.add("color_temp");
62 if (traits.supports_color_mode(ColorMode::RGB))
63 color_modes.add("rgb");
64 if (traits.supports_color_mode(ColorMode::RGB_WHITE) ||
65 // HA doesn't support RGBCT, and there's no CWWW->CT emulation in ESPHome yet, so ignore CT control for now
66 traits.supports_color_mode(ColorMode::RGB_COLOR_TEMPERATURE))
67 color_modes.add("rgbw");
68 if (traits.supports_color_mode(ColorMode::RGB_COLD_WARM_WHITE))
69 color_modes.add("rgbww");
70
71 // legacy API
72 if (traits.supports_color_capability(ColorCapability::BRIGHTNESS))
73 root["brightness"] = true;
74
75 if (traits.supports_color_mode(ColorMode::COLOR_TEMPERATURE) ||
76 traits.supports_color_mode(ColorMode::COLD_WARM_WHITE)) {
77 root[MQTT_MIN_MIREDS] = traits.get_min_mireds();
78 root[MQTT_MAX_MIREDS] = traits.get_max_mireds();
79 }
80
81 if (this->state_->supports_effects()) {
82 root["effect"] = true;
83 JsonArray effect_list = root[MQTT_EFFECT_LIST].to<JsonArray>();
84 for (auto *effect : this->state_->get_effects())
85 effect_list.add(effect->get_name());
86 effect_list.add("None");
87 }
88}
91 ESP_LOGCONFIG(TAG, "MQTT Light '%s':", this->state_->get_name().c_str());
92 LOG_MQTT_COMPONENT(true, true)
93}
94
95} // namespace mqtt
96} // namespace esphome
97
98#endif
99#endif // USE_MQTT
100#endif // USE_JSON
void defer(const std::string &name, std::function< void()> &&f)
Defer a callback to the next loop() call.
const StringRef & get_name() const
constexpr const char * c_str() const
Definition string_ref.h:69
This class represents a requested change in a light state.
Definition light_call.h:21
static void parse_json(LightState &state, LightCall &call, JsonObject root)
Parse the JSON state of a light to a LightCall.
static void dump_json(LightState &state, JsonObject root)
Dump the state of a light as JSON.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:91
void add_remote_values_listener(LightRemoteValuesListener *listener)
Add a listener for remote values changes.
const FixedVector< LightEffect * > & get_effects() const
Get all effects for this light state.
bool supports_effects()
Return whether the light has any effects that meet the trait requirements.
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.
bool publish_json(const std::string &topic, const json::json_build_t &f)
Construct and send a JSON MQTT message.
std::string get_state_topic_() const
Get the MQTT topic that new states will be shared to.
std::string get_command_topic_() const
Get the MQTT topic for listening to commands.
MQTTJSONLightComponent(light::LightState *state)
const EntityBase * get_entity() const override
void send_discovery(JsonObject root, mqtt::SendDiscoveryConfig &config) override
light::LightState * get_state() const
std::string component_type() const override
bool state
Definition fan.h:0
constexpr const char *const MQTT_COLOR_MODE
Definition mqtt_const.h:38
constexpr const char *const MQTT_EFFECT_LIST
Definition mqtt_const.h:72
constexpr const char *const MQTT_MIN_MIREDS
Definition mqtt_const.h:114
constexpr const char *const MQTT_MAX_MIREDS
Definition mqtt_const.h:110
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
Simple Helper struct used for Home Assistant MQTT send_discovery().