ESPHome  2022.11.3
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::servo::Servo Class Reference

#include <servo.h>

Inheritance diagram for esphome::servo::Servo:
esphome::Component

Public Member Functions

void set_output (output::FloatOutput *output)
 
void loop () override
 
void write (float value)
 
void internal_write (float value)
 
void detach ()
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_min_level (float min_level)
 
void set_idle_level (float idle_level)
 
void set_max_level (float max_level)
 
void set_restore (bool restore)
 
void set_auto_detach_time (uint32_t auto_detach_time)
 
void set_transition_length (uint32_t transition_length)
 
- 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 Types

enum  State { STATE_ATTACHED = 0, STATE_DETACHED = 1, STATE_TARGET_REACHED = 2 }
 

Protected Member Functions

void save_level_ (float v)
 
- 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

output::FloatOutputoutput_
 
float min_level_ = 0.0300f
 
float idle_level_ = 0.0750f
 
float max_level_ = 0.1200f
 
bool restore_ {false}
 
uint32_t auto_detach_time_ = 0
 
uint32_t transition_length_ = 0
 
ESPPreferenceObject rtc_
 
uint8_t state_
 
float target_value_ = 0
 
float source_value_ = 0
 
float current_value_ = 0
 
uint32_t start_millis_ = 0
 
- 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 14 of file servo.h.

Member Enumeration Documentation

◆ State

Enumerator
STATE_ATTACHED 
STATE_DETACHED 
STATE_TARGET_REACHED 

Definition at line 61 of file servo.h.

Member Function Documentation

◆ detach()

void esphome::servo::Servo::detach ( )
inline

Definition at line 20 of file servo.h.

◆ dump_config()

void esphome::servo::Servo::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file servo.cpp.

◆ get_setup_priority()

float esphome::servo::Servo::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file servo.h.

◆ internal_write()

void esphome::servo::Servo::internal_write ( float  value)

Definition at line 65 of file servo.cpp.

◆ loop()

void esphome::servo::Servo::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file servo.cpp.

◆ save_level_()

void esphome::servo::Servo::save_level_ ( float  v)
inlineprotected

Definition at line 46 of file servo.h.

◆ set_auto_detach_time()

void esphome::servo::Servo::set_auto_detach_time ( uint32_t  auto_detach_time)
inline

Definition at line 42 of file servo.h.

◆ set_idle_level()

void esphome::servo::Servo::set_idle_level ( float  idle_level)
inline

Definition at line 39 of file servo.h.

◆ set_max_level()

void esphome::servo::Servo::set_max_level ( float  max_level)
inline

Definition at line 40 of file servo.h.

◆ set_min_level()

void esphome::servo::Servo::set_min_level ( float  min_level)
inline

Definition at line 38 of file servo.h.

◆ set_output()

void esphome::servo::Servo::set_output ( output::FloatOutput output)
inline

Definition at line 16 of file servo.h.

◆ set_restore()

void esphome::servo::Servo::set_restore ( bool  restore)
inline

Definition at line 41 of file servo.h.

◆ set_transition_length()

void esphome::servo::Servo::set_transition_length ( uint32_t  transition_length)
inline

Definition at line 43 of file servo.h.

◆ setup()

void esphome::servo::Servo::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file servo.h.

◆ write()

void esphome::servo::Servo::write ( float  value)

Definition at line 54 of file servo.cpp.

Field Documentation

◆ auto_detach_time_

uint32_t esphome::servo::Servo::auto_detach_time_ = 0
protected

Definition at line 53 of file servo.h.

◆ current_value_

float esphome::servo::Servo::current_value_ = 0
protected

Definition at line 59 of file servo.h.

◆ idle_level_

float esphome::servo::Servo::idle_level_ = 0.0750f
protected

Definition at line 50 of file servo.h.

◆ max_level_

float esphome::servo::Servo::max_level_ = 0.1200f
protected

Definition at line 51 of file servo.h.

◆ min_level_

float esphome::servo::Servo::min_level_ = 0.0300f
protected

Definition at line 49 of file servo.h.

◆ output_

output::FloatOutput* esphome::servo::Servo::output_
protected

Definition at line 48 of file servo.h.

◆ restore_

bool esphome::servo::Servo::restore_ {false}
protected

Definition at line 52 of file servo.h.

◆ rtc_

ESPPreferenceObject esphome::servo::Servo::rtc_
protected

Definition at line 55 of file servo.h.

◆ source_value_

float esphome::servo::Servo::source_value_ = 0
protected

Definition at line 58 of file servo.h.

◆ start_millis_

uint32_t esphome::servo::Servo::start_millis_ = 0
protected

Definition at line 60 of file servo.h.

◆ state_

uint8_t esphome::servo::Servo::state_
protected

Definition at line 56 of file servo.h.

◆ target_value_

float esphome::servo::Servo::target_value_ = 0
protected

Definition at line 57 of file servo.h.

◆ transition_length_

uint32_t esphome::servo::Servo::transition_length_ = 0
protected

Definition at line 54 of file servo.h.


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