ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sonoff_d1::SonoffD1Output Class Reference

#include <sonoff_d1.h>

Inheritance diagram for esphome::sonoff_d1::SonoffD1Output:
esphome::light::LightOutput esphome::uart::UARTDevice esphome::Component

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
 
float get_setup_priority () const 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< LightTransformercreate_default_transition ()
 Return the default transformer used for transitions. More...
 
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. More...
 
- 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 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 ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

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
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

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::LightStatelight_state_ {nullptr}
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 

Detailed Description

Definition at line 45 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 51 of file sonoff_d1.cpp.

◆ control_dimmer_()

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

Definition at line 192 of file sonoff_d1.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 286 of file sonoff_d1.cpp.

◆ get_setup_priority()

float esphome::sonoff_d1::SonoffD1Output::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 56 of file sonoff_d1.h.

◆ get_traits()

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

Implements esphome::light::LightOutput.

Definition at line 250 of file sonoff_d1.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 293 of file sonoff_d1.cpp.

◆ populate_checksum_()

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

Definition at line 59 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 205 of file sonoff_d1.cpp.

◆ publish_state_()

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

Definition at line 232 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 126 of file sonoff_d1.cpp.

◆ read_command_()

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

Definition at line 79 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 61 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 60 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 59 of file sonoff_d1.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 53 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 49 of file sonoff_d1.h.

◆ skip_command_()

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

Definition at line 64 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 153 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 256 of file sonoff_d1.cpp.

Field Documentation

◆ last_binary_

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

Definition at line 67 of file sonoff_d1.h.

◆ last_brightness_

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

Definition at line 68 of file sonoff_d1.h.

◆ light_state_

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

Definition at line 71 of file sonoff_d1.h.

◆ max_value_

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

Definition at line 65 of file sonoff_d1.h.

◆ min_value_

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

Definition at line 64 of file sonoff_d1.h.

◆ read_count_

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

Definition at line 70 of file sonoff_d1.h.

◆ use_rm433_remote_

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

Definition at line 66 of file sonoff_d1.h.

◆ write_count_

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

Definition at line 69 of file sonoff_d1.h.


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