#include <shelly_dimmer.h>

Inheritance diagram for esphome::shelly_dimmer::ShellyDimmer:

Public Member Functions
float	get_setup_priority () const override

bool	is_running_configured_version () const

void	handle_firmware ()

void	setup () override

void	update () override

void	dump_config () override

light::LightTraits	get_traits () override

void	setup_state (light::LightState *state) override

void	write_state (light::LightState *state) override

void	set_nrst_pin (GPIOPin *nrst_pin)

void	set_boot0_pin (GPIOPin *boot0_pin)

void	set_leading_edge (bool leading_edge)

void	set_warmup_brightness (uint16_t warmup_brightness)

void	set_warmup_time (uint16_t warmup_time)

void	set_fade_rate (uint16_t fade_rate)

void	set_min_brightness (uint16_t min_brightness)

void	set_max_brightness (uint16_t max_brightness)

void	set_power_sensor (sensor::Sensor *power_sensor)

void	set_voltage_sensor (sensor::Sensor *voltage_sensor)

void	set_current_sensor (sensor::Sensor *current_sensor)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Public Member Functions inherited from esphome::light::LightOutput
virtual std::unique_ptr< LightTransformer >	create_default_transition ()
	Return the default transformer used for transitions.

virtual void	update_state (LightState *state)
	Called on every update of the current values of the associated LightState, can optionally be used to do processing of this change.

Public Member Functions inherited from esphome::uart::UARTDevice
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	set_rx_full_threshold (size_t rx_full_threshold)

void	set_rx_full_threshold_ms (size_t time)

size_t	get_rx_full_threshold ()

void	set_rx_timeout (size_t rx_timeout)

size_t	get_rx_timeout ()

void	write_array (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

size_t	available ()

UARTFlushResult	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

	ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning.

Protected Member Functions
uint16_t	convert_brightness_ (float brightness)
	Convert relative brightness into a dimmer brightness value.

void	send_brightness_ (uint16_t brightness)
	Sends the given brightness value.

void	send_settings_ ()
	Sends dimmer configuration.

bool	upgrade_firmware_ ()
	Performs a firmware upgrade.

bool	send_command_ (uint8_t cmd, const uint8_t *payload, uint8_t len)
	Sends a command and waits for an acknowledgement.

size_t	frame_command_ (uint8_t data, uint8_t cmd, const uint8_t payload, size_t len)
	Frames a given command payload.

int	handle_byte_ (uint8_t c)
	Handles a single byte as part of a protocol frame.

bool	read_frame_ ()
	Reads a response frame.

bool	handle_frame_ ()
	Handles a complete frame.

void	reset_ (bool boot0)
	Reset STM32 with the BOOT0 pin set to the given value.

void	reset_normal_boot_ ()
	Reset STM32 to boot the regular firmware.

void	reset_dfu_boot_ ()
	Reset STM32 to boot into DFU mode to enable firmware upgrades.

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
GPIOPin *	pin_nrst_

GPIOPin *	pin_boot0_

uint8_t	seq_ {0}

std::array< uint8_t, SHELLY_DIMMER_BUFFER_SIZE >	buffer_

uint8_t	buffer_pos_ {0}

uint8_t	version_major_

uint8_t	version_minor_

bool	leading_edge_ {false}

uint16_t	warmup_brightness_ {100}

uint16_t	warmup_time_ {20}

uint16_t	fade_rate_ {0}

uint16_t	min_brightness_ {0}

uint16_t	max_brightness_ {1000}

light::LightState *	state_ {nullptr}

sensor::Sensor *	power_sensor_ {nullptr}

sensor::Sensor *	voltage_sensor_ {nullptr}

sensor::Sensor *	current_sensor_ {nullptr}

bool	ready_ {false}

uint16_t	brightness_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Additional Inherited Members
Data Fields inherited from esphome::uart::UARTDevice
uint8_t	stop_bits = 1

uint8_t UARTParityOptions	parity = UART_CONFIG_PARITY_NONE

uint8_t UARTParityOptions uint8_t	data_bits = 8)

Detailed Description

Definition at line 15 of file shelly_dimmer.h.

Member Function Documentation

◆ convert_brightness_()

uint16_t esphome::shelly_dimmer::ShellyDimmer::convert_brightness_ ( float brightness )

protected

Convert relative brightness into a dimmer brightness value.

Definition at line 208 of file shelly_dimmer.cpp.

◆ dump_config()

void esphome::shelly_dimmer::ShellyDimmer::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 114 of file shelly_dimmer.cpp.

◆ frame_command_()

size_t esphome::shelly_dimmer::ShellyDimmer::frame_command_	(	uint8_t *	data,
		uint8_t	cmd,
		const uint8_t *	payload,
		size_t	len )

protected

Frames a given command payload.

Definition at line 295 of file shelly_dimmer.cpp.

◆ get_setup_priority()

float esphome::shelly_dimmer::ShellyDimmer::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file shelly_dimmer.h.

◆ get_traits()

light::LightTraits esphome::shelly_dimmer::ShellyDimmer::get_traits ( )

inlineoverridevirtual

Implements esphome::light::LightOutput.

Definition at line 28 of file shelly_dimmer.h.

◆ handle_byte_()

int esphome::shelly_dimmer::ShellyDimmer::handle_byte_ ( uint8_t c )

protected

Handles a single byte as part of a protocol frame.

Returns -1 on failure, 0 when finished and 1 when more bytes needed.

Definition at line 318 of file shelly_dimmer.cpp.

◆ handle_firmware()

void esphome::shelly_dimmer::ShellyDimmer::handle_firmware ( )

Definition at line 71 of file shelly_dimmer.cpp.

◆ handle_frame_()

bool esphome::shelly_dimmer::ShellyDimmer::handle_frame_ ( )

protected

Handles a complete frame.

Definition at line 386 of file shelly_dimmer.cpp.

◆ is_running_configured_version()

bool esphome::shelly_dimmer::ShellyDimmer::is_running_configured_version ( ) const

Definition at line 66 of file shelly_dimmer.cpp.

◆ read_frame_()

bool esphome::shelly_dimmer::ShellyDimmer::read_frame_ ( )

protected

Reads a response frame.

Definition at line 357 of file shelly_dimmer.cpp.

◆ reset_()

void esphome::shelly_dimmer::ShellyDimmer::reset_ ( bool boot0 )

protected

Reset STM32 with the BOOT0 pin set to the given value.

Definition at line 477 of file shelly_dimmer.cpp.

◆ reset_dfu_boot_()

void esphome::shelly_dimmer::ShellyDimmer::reset_dfu_boot_ ( )

protected

Reset STM32 to boot into DFU mode to enable firmware upgrades.

Definition at line 511 of file shelly_dimmer.cpp.

◆ reset_normal_boot_()

void esphome::shelly_dimmer::ShellyDimmer::reset_normal_boot_ ( )

protected

Reset STM32 to boot the regular firmware.

Definition at line 498 of file shelly_dimmer.cpp.

◆ send_brightness_()

void esphome::shelly_dimmer::ShellyDimmer::send_brightness_ ( uint16_t brightness )

protected

Sends the given brightness value.

Definition at line 217 of file shelly_dimmer.cpp.

◆ send_command_()

bool esphome::shelly_dimmer::ShellyDimmer::send_command_	(	uint8_t	cmd,
		const uint8_t *	payload,
		uint8_t	len )

protected

Sends a command and waits for an acknowledgement.

Definition at line 265 of file shelly_dimmer.cpp.

◆ send_settings_()

void esphome::shelly_dimmer::ShellyDimmer::send_settings_ ( )

protected

Sends dimmer configuration.

Definition at line 230 of file shelly_dimmer.cpp.

◆ set_boot0_pin()

void esphome::shelly_dimmer::ShellyDimmer::set_boot0_pin ( GPIOPin * boot0_pin )

inline

Definition at line 38 of file shelly_dimmer.h.

◆ set_current_sensor()

void esphome::shelly_dimmer::ShellyDimmer::set_current_sensor ( sensor::Sensor * current_sensor )

inline

Definition at line 49 of file shelly_dimmer.h.

◆ set_fade_rate()

void esphome::shelly_dimmer::ShellyDimmer::set_fade_rate ( uint16_t fade_rate )

inline

Definition at line 43 of file shelly_dimmer.h.

◆ set_leading_edge()

void esphome::shelly_dimmer::ShellyDimmer::set_leading_edge ( bool leading_edge )

inline

Definition at line 40 of file shelly_dimmer.h.

◆ set_max_brightness()

void esphome::shelly_dimmer::ShellyDimmer::set_max_brightness ( uint16_t max_brightness )

inline

Definition at line 45 of file shelly_dimmer.h.

◆ set_min_brightness()

void esphome::shelly_dimmer::ShellyDimmer::set_min_brightness ( uint16_t min_brightness )

inline

Definition at line 44 of file shelly_dimmer.h.

◆ set_nrst_pin()

void esphome::shelly_dimmer::ShellyDimmer::set_nrst_pin ( GPIOPin * nrst_pin )

inline

Definition at line 37 of file shelly_dimmer.h.

◆ set_power_sensor()

void esphome::shelly_dimmer::ShellyDimmer::set_power_sensor ( sensor::Sensor * power_sensor )

inline

Definition at line 47 of file shelly_dimmer.h.

◆ set_voltage_sensor()

void esphome::shelly_dimmer::ShellyDimmer::set_voltage_sensor ( sensor::Sensor * voltage_sensor )

inline

Definition at line 48 of file shelly_dimmer.h.

◆ set_warmup_brightness()

void esphome::shelly_dimmer::ShellyDimmer::set_warmup_brightness ( uint16_t warmup_brightness )

inline

Definition at line 41 of file shelly_dimmer.h.

◆ set_warmup_time()

void esphome::shelly_dimmer::ShellyDimmer::set_warmup_time ( uint16_t warmup_time )

inline

Definition at line 42 of file shelly_dimmer.h.

◆ setup()

void esphome::shelly_dimmer::ShellyDimmer::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 99 of file shelly_dimmer.cpp.

◆ setup_state()

void esphome::shelly_dimmer::ShellyDimmer::setup_state ( light::LightState * state )

inlineoverridevirtual

Reimplemented from esphome::light::LightOutput.

Definition at line 34 of file shelly_dimmer.h.

◆ update()

void esphome::shelly_dimmer::ShellyDimmer::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 112 of file shelly_dimmer.cpp.

◆ upgrade_firmware_()

bool esphome::shelly_dimmer::ShellyDimmer::upgrade_firmware_ ( )

protected

Performs a firmware upgrade.

Definition at line 154 of file shelly_dimmer.cpp.

◆ write_state()

void esphome::shelly_dimmer::ShellyDimmer::write_state ( light::LightState * state )

overridevirtual

Implements esphome::light::LightOutput.

Definition at line 136 of file shelly_dimmer.cpp.

Field Documentation

◆ brightness_

uint16_t esphome::shelly_dimmer::ShellyDimmer::brightness_

protected

Definition at line 78 of file shelly_dimmer.h.

◆ buffer_

std::array<uint8_t, SHELLY_DIMMER_BUFFER_SIZE> esphome::shelly_dimmer::ShellyDimmer::buffer_

protected

Definition at line 57 of file shelly_dimmer.h.

◆ buffer_pos_

uint8_t esphome::shelly_dimmer::ShellyDimmer::buffer_pos_ {0}

protected

Definition at line 58 of file shelly_dimmer.h.

◆ current_sensor_

sensor::Sensor* esphome::shelly_dimmer::ShellyDimmer::current_sensor_ {nullptr}

protected

Definition at line 75 of file shelly_dimmer.h.

◆ fade_rate_

uint16_t esphome::shelly_dimmer::ShellyDimmer::fade_rate_ {0}

protected

Definition at line 68 of file shelly_dimmer.h.

◆ leading_edge_

bool esphome::shelly_dimmer::ShellyDimmer::leading_edge_ {false}

protected

Definition at line 65 of file shelly_dimmer.h.

◆ max_brightness_

uint16_t esphome::shelly_dimmer::ShellyDimmer::max_brightness_ {1000}

protected

Definition at line 70 of file shelly_dimmer.h.

◆ min_brightness_

uint16_t esphome::shelly_dimmer::ShellyDimmer::min_brightness_ {0}

protected

Definition at line 69 of file shelly_dimmer.h.

◆ pin_boot0_

GPIOPin* esphome::shelly_dimmer::ShellyDimmer::pin_boot0_

protected

Definition at line 53 of file shelly_dimmer.h.

◆ pin_nrst_

GPIOPin* esphome::shelly_dimmer::ShellyDimmer::pin_nrst_

protected

Definition at line 52 of file shelly_dimmer.h.

◆ power_sensor_

sensor::Sensor* esphome::shelly_dimmer::ShellyDimmer::power_sensor_ {nullptr}

protected

Definition at line 73 of file shelly_dimmer.h.

◆ ready_

bool esphome::shelly_dimmer::ShellyDimmer::ready_ {false}

protected

Definition at line 77 of file shelly_dimmer.h.

◆ seq_

uint8_t esphome::shelly_dimmer::ShellyDimmer::seq_ {0}

protected

Definition at line 56 of file shelly_dimmer.h.

◆ state_

light::LightState* esphome::shelly_dimmer::ShellyDimmer::state_ {nullptr}

protected

Definition at line 72 of file shelly_dimmer.h.

◆ version_major_

uint8_t esphome::shelly_dimmer::ShellyDimmer::version_major_

protected

Definition at line 61 of file shelly_dimmer.h.

◆ version_minor_

uint8_t esphome::shelly_dimmer::ShellyDimmer::version_minor_

protected

Definition at line 62 of file shelly_dimmer.h.

◆ voltage_sensor_

sensor::Sensor* esphome::shelly_dimmer::ShellyDimmer::voltage_sensor_ {nullptr}

protected

Definition at line 74 of file shelly_dimmer.h.

◆ warmup_brightness_

uint16_t esphome::shelly_dimmer::ShellyDimmer::warmup_brightness_ {100}

protected

Definition at line 66 of file shelly_dimmer.h.

◆ warmup_time_

uint16_t esphome::shelly_dimmer::ShellyDimmer::warmup_time_ {20}

protected

Definition at line 67 of file shelly_dimmer.h.

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

esphome/components/shelly_dimmer/shelly_dimmer.h
esphome/components/shelly_dimmer/shelly_dimmer.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ convert_brightness_()

◆ dump_config()

◆ frame_command_()

◆ get_setup_priority()

◆ get_traits()

◆ handle_byte_()

◆ handle_firmware()

◆ handle_frame_()

◆ is_running_configured_version()

◆ read_frame_()

◆ reset_()

◆ reset_dfu_boot_()

◆ reset_normal_boot_()

◆ send_brightness_()

◆ send_command_()

◆ send_settings_()

◆ set_boot0_pin()

◆ set_current_sensor()

◆ set_fade_rate()

◆ set_leading_edge()

◆ set_max_brightness()

◆ set_min_brightness()

◆ set_nrst_pin()

◆ set_power_sensor()

◆ set_voltage_sensor()

◆ set_warmup_brightness()

◆ set_warmup_time()

◆ setup()

◆ setup_state()

◆ update()

◆ upgrade_firmware_()

◆ write_state()

Field Documentation

◆ brightness_

◆ buffer_

◆ buffer_pos_

◆ current_sensor_

◆ fade_rate_

◆ leading_edge_

◆ max_brightness_

◆ min_brightness_

◆ pin_boot0_

◆ pin_nrst_

◆ power_sensor_

◆ ready_

◆ seq_

◆ state_

◆ version_major_

◆ version_minor_

◆ voltage_sensor_

◆ warmup_brightness_

◆ warmup_time_