ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
shelly_dimmer.h
Go to the documentation of this file.
1#pragma once
2
3#ifdef USE_ESP8266
4
6#include "esphome/core/log.h"
10
11#include <array>
12
13namespace esphome::shelly_dimmer {
14
16 SUB_SENSOR(power)
17 SUB_SENSOR(voltage)
18 SUB_SENSOR(current)
19
20 private:
21 static constexpr uint16_t SHELLY_DIMMER_BUFFER_SIZE = 256;
22
23 public:
24 float get_setup_priority() const override { return setup_priority::LATE; }
25
27 void handle_firmware();
28 void setup() override;
29 void update() override;
30 void dump_config() override;
31
33 auto traits = light::LightTraits();
34 traits.set_supported_color_modes({light::ColorMode::BRIGHTNESS});
35 return traits;
36 }
37
38 void setup_state(light::LightState *state) override { this->state_ = state; }
39 void write_state(light::LightState *state) override;
40
41 void set_nrst_pin(GPIOPin *nrst_pin) { this->pin_nrst_ = nrst_pin; }
42 void set_boot0_pin(GPIOPin *boot0_pin) { this->pin_boot0_ = boot0_pin; }
43
44 void set_leading_edge(bool leading_edge) { this->leading_edge_ = leading_edge; }
45 void set_warmup_brightness(uint16_t warmup_brightness) { this->warmup_brightness_ = warmup_brightness; }
46 void set_warmup_time(uint16_t warmup_time) { this->warmup_time_ = warmup_time; }
47 void set_fade_rate(uint16_t fade_rate) { this->fade_rate_ = fade_rate; }
48 void set_min_brightness(uint16_t min_brightness) { this->min_brightness_ = min_brightness; }
49 void set_max_brightness(uint16_t max_brightness) { this->max_brightness_ = max_brightness; }
50
51 protected:
54
55 // Frame parser state.
56 uint8_t seq_{0};
57 std::array<uint8_t, SHELLY_DIMMER_BUFFER_SIZE> buffer_;
58 uint8_t buffer_pos_{0};
59
60 // Firmware version.
63
64 // Configuration.
65 bool leading_edge_{false};
66 uint16_t warmup_brightness_{100};
67 uint16_t warmup_time_{20};
68 uint16_t fade_rate_{0};
69 uint16_t min_brightness_{0};
70 uint16_t max_brightness_{1000};
71
73
74 bool ready_{false};
75 uint16_t brightness_;
76
78 uint16_t convert_brightness_(float brightness);
79
81 void send_brightness_(uint16_t brightness);
82
84 void send_settings_();
85
87 bool upgrade_firmware_();
88
90 bool send_command_(uint8_t cmd, const uint8_t *payload, uint8_t len);
91
93 size_t frame_command_(uint8_t *data, uint8_t cmd, const uint8_t *payload, size_t len);
94
98 int handle_byte_(uint8_t c);
99
101 bool read_frame_();
102
104 bool handle_frame_();
105
107 void reset_(bool boot0);
108
110 void reset_normal_boot_();
111
113 void reset_dfu_boot_();
114};
115
116} // namespace esphome::shelly_dimmer
117
118#endif // USE_ESP8266
This class simplifies creating components that periodically check a state.
Definition component.h:532
Interface to write LightStates to hardware.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:68
This class is used to represent the capabilities of a light.
Definition light_traits.h:9
void write_state(light::LightState *state) override
void set_fade_rate(uint16_t fade_rate)
float get_setup_priority() const override
light::LightTraits get_traits() override
void reset_dfu_boot_()
Reset STM32 to boot into DFU mode to enable firmware upgrades.
bool upgrade_firmware_()
Performs a firmware upgrade.
void set_min_brightness(uint16_t min_brightness)
void reset_normal_boot_()
Reset STM32 to boot the regular firmware.
bool handle_frame_()
Handles a complete frame.
void set_max_brightness(uint16_t max_brightness)
void send_brightness_(uint16_t brightness)
Sends the given brightness value.
void set_warmup_brightness(uint16_t warmup_brightness)
void send_settings_()
Sends dimmer configuration.
int handle_byte_(uint8_t c)
Handles a single byte as part of a protocol frame.
std::array< uint8_t, SHELLY_DIMMER_BUFFER_SIZE > buffer_
uint16_t convert_brightness_(float brightness)
Convert relative brightness into a dimmer brightness value.
void set_nrst_pin(GPIOPin *nrst_pin)
void set_boot0_pin(GPIOPin *boot0_pin)
void set_leading_edge(bool leading_edge)
void set_warmup_time(uint16_t warmup_time)
void setup_state(light::LightState *state) override
size_t frame_command_(uint8_t *data, uint8_t cmd, const uint8_t *payload, size_t len)
Frames a given command payload.
void reset_(bool boot0)
Reset STM32 with the BOOT0 pin set to the given value.
bool read_frame_()
Reads a response frame.
bool send_command_(uint8_t cmd, const uint8_t *payload, uint8_t len)
Sends a command and waits for an acknowledgement.
bool state
Definition fan.h:2
@ BRIGHTNESS
Dimmable light.
constexpr float LATE
For components that should be initialized at the very end of the setup process.
Definition component.h:59
const void size_t len
Definition hal.h:68