#include <sonoff_d1.h>

Inheritance diagram for esphome::sonoff_d1::SonoffD1Output:

Public Member Functions
light::LightTraits	get_traits () override

void	setup_state (light::LightState *state) override

void	write_state (light::LightState *state) override

void	setup () override

void	loop () override

void	dump_config () override

void	set_use_rm433_remote (const bool use_rm433_remote)

void	set_min_value (const uint8_t min_value)

void	set_max_value (const uint8_t max_value)

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.

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

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)

Protected Member Functions
uint8_t	calc_checksum_ (const uint8_t *cmd, size_t len)

void	populate_checksum_ (uint8_t *cmd, size_t len)

void	skip_command_ ()

bool	read_command_ (uint8_t *cmd, size_t &len)

bool	read_ack_ (const uint8_t *cmd, size_t len)

bool	write_command_ (uint8_t *cmd, size_t len, bool needs_ack=true)

bool	control_dimmer_ (bool binary, uint8_t brightness)

void	process_command_ (const uint8_t *cmd, size_t len)

void	publish_state_ (bool is_on, uint8_t brightness)

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.

virtual void	call_setup ()

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
uint8_t	min_value_ {0}

uint8_t	max_value_ {100}

bool	use_rm433_remote_ {false}

bool	last_binary_ {false}

uint8_t	last_brightness_ {0}

int	write_count_ {0}

int	read_count_ {0}

light::LightState *	light_state_ {nullptr}

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

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_

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 44 of file sonoff_d1.h.

Member Function Documentation

◆ calc_checksum_()

uint8_t esphome::sonoff_d1::SonoffD1Output::calc_checksum_	(	const uint8_t *	cmd,
		size_t	len )

protected

Definition at line 55 of file sonoff_d1.cpp.

◆ control_dimmer_()

bool esphome::sonoff_d1::SonoffD1Output::control_dimmer_	(	bool	binary,
		uint8_t	brightness )

protected

Definition at line 206 of file sonoff_d1.cpp.

◆ dump_config()

void esphome::sonoff_d1::SonoffD1Output::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 300 of file sonoff_d1.cpp.

◆ get_traits()

light::LightTraits esphome::sonoff_d1::SonoffD1Output::get_traits ( )

overridevirtual

Implements esphome::light::LightOutput.

Definition at line 264 of file sonoff_d1.cpp.

◆ loop()

void esphome::sonoff_d1::SonoffD1Output::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 310 of file sonoff_d1.cpp.

◆ populate_checksum_()

void esphome::sonoff_d1::SonoffD1Output::populate_checksum_	(	uint8_t *	cmd,
		size_t	len )

protected

Definition at line 63 of file sonoff_d1.cpp.

◆ process_command_()

void esphome::sonoff_d1::SonoffD1Output::process_command_	(	const uint8_t *	cmd,
		size_t	len )

protected

Definition at line 219 of file sonoff_d1.cpp.

◆ publish_state_()

void esphome::sonoff_d1::SonoffD1Output::publish_state_	(	bool	is_on,
		uint8_t	brightness )

protected

Definition at line 246 of file sonoff_d1.cpp.

◆ read_ack_()

bool esphome::sonoff_d1::SonoffD1Output::read_ack_	(	const uint8_t *	cmd,
		size_t	len )

protected

Definition at line 136 of file sonoff_d1.cpp.

◆ read_command_()

bool esphome::sonoff_d1::SonoffD1Output::read_command_	(	uint8_t *	cmd,
		size_t &	len )

protected

Definition at line 84 of file sonoff_d1.cpp.

◆ set_max_value()

void esphome::sonoff_d1::SonoffD1Output::set_max_value ( const uint8_t max_value )

inline

Definition at line 59 of file sonoff_d1.h.

◆ set_min_value()

void esphome::sonoff_d1::SonoffD1Output::set_min_value ( const uint8_t min_value )

inline

Definition at line 58 of file sonoff_d1.h.

◆ set_use_rm433_remote()

void esphome::sonoff_d1::SonoffD1Output::set_use_rm433_remote ( const bool use_rm433_remote )

inline

Definition at line 57 of file sonoff_d1.h.

◆ setup()

void esphome::sonoff_d1::SonoffD1Output::setup ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 52 of file sonoff_d1.h.

◆ setup_state()

void esphome::sonoff_d1::SonoffD1Output::setup_state ( light::LightState * state )

inlineoverridevirtual

Reimplemented from esphome::light::LightOutput.

Definition at line 48 of file sonoff_d1.h.

◆ skip_command_()

void esphome::sonoff_d1::SonoffD1Output::skip_command_ ( )

protected

Definition at line 68 of file sonoff_d1.cpp.

◆ write_command_()

bool esphome::sonoff_d1::SonoffD1Output::write_command_	(	uint8_t *	cmd,
		size_t	len,
		bool	needs_ack = true )

protected

Definition at line 165 of file sonoff_d1.cpp.

◆ write_state()

void esphome::sonoff_d1::SonoffD1Output::write_state ( light::LightState * state )

overridevirtual

Implements esphome::light::LightOutput.

Definition at line 270 of file sonoff_d1.cpp.

Field Documentation

◆ last_binary_

bool esphome::sonoff_d1::SonoffD1Output::last_binary_ {false}

protected

Definition at line 65 of file sonoff_d1.h.

◆ last_brightness_

uint8_t esphome::sonoff_d1::SonoffD1Output::last_brightness_ {0}

protected

Definition at line 66 of file sonoff_d1.h.

◆ light_state_

light::LightState* esphome::sonoff_d1::SonoffD1Output::light_state_ {nullptr}

protected

Definition at line 69 of file sonoff_d1.h.

◆ max_value_

uint8_t esphome::sonoff_d1::SonoffD1Output::max_value_ {100}

protected

Definition at line 63 of file sonoff_d1.h.

◆ min_value_

uint8_t esphome::sonoff_d1::SonoffD1Output::min_value_ {0}

protected

Definition at line 62 of file sonoff_d1.h.

◆ read_count_

int esphome::sonoff_d1::SonoffD1Output::read_count_ {0}

protected

Definition at line 68 of file sonoff_d1.h.

◆ use_rm433_remote_

bool esphome::sonoff_d1::SonoffD1Output::use_rm433_remote_ {false}

protected

Definition at line 64 of file sonoff_d1.h.

◆ write_count_

int esphome::sonoff_d1::SonoffD1Output::write_count_ {0}

protected

Definition at line 67 of file sonoff_d1.h.

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

esphome/components/sonoff_d1/sonoff_d1.h
esphome/components/sonoff_d1/sonoff_d1.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calc_checksum_()

◆ control_dimmer_()

◆ dump_config()

◆ get_traits()

◆ loop()

◆ populate_checksum_()

◆ process_command_()

◆ publish_state_()

◆ read_ack_()

◆ read_command_()

◆ set_max_value()

◆ set_min_value()

◆ set_use_rm433_remote()

◆ setup()

◆ setup_state()

◆ skip_command_()

◆ write_command_()

◆ write_state()

Field Documentation

◆ last_binary_

◆ last_brightness_

◆ light_state_

◆ max_value_

◆ min_value_

◆ read_count_

◆ use_rm433_remote_

◆ write_count_