ESPHome  2022.1.2
Public Member Functions | Protected Attributes
esphome::a4988::A4988 Class Reference

#include <a4988.h>

Inheritance diagram for esphome::a4988::A4988:
esphome::stepper::Stepper esphome::Component

Public Member Functions

void set_step_pin (GPIOPin *step_pin)
 
void set_dir_pin (GPIOPin *dir_pin)
 
void set_sleep_pin (GPIOPin *sleep_pin)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::stepper::Stepper
void set_target (int32_t steps)
 
void report_position (int32_t steps)
 
void set_acceleration (float acceleration)
 
void set_deceleration (float deceleration)
 
void set_max_speed (float max_speed)
 
virtual void on_update_speed ()
 
bool has_reached_target ()
 
- 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 Attributes

GPIOPinstep_pin_
 
GPIOPindir_pin_
 
GPIOPinsleep_pin_ {nullptr}
 
bool sleep_pin_state_
 
HighFrequencyLoopRequester high_freq_
 
- Protected Attributes inherited from esphome::stepper::Stepper
float acceleration_ {1e6f}
 
float deceleration_ {1e6f}
 
float current_speed_ {0.0f}
 
float max_speed_ {1e6f}
 
uint32_t last_calculation_ {0}
 
uint32_t last_step_ {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
 

Additional Inherited Members

- Data Fields inherited from esphome::stepper::Stepper
int32_t current_position {0}
 
int32_t target_position {0}
 
- Protected Member Functions inherited from esphome::stepper::Stepper
void calculate_speed_ (uint32_t now)
 
int32_t should_step_ ()
 
- 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...
 

Detailed Description

Definition at line 10 of file a4988.h.

Member Function Documentation

◆ dump_config()

void esphome::a4988::A4988::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file a4988.cpp.

◆ get_setup_priority()

float esphome::a4988::A4988::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file a4988.h.

◆ loop()

void esphome::a4988::A4988::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file a4988.cpp.

◆ set_dir_pin()

void esphome::a4988::A4988::set_dir_pin ( GPIOPin dir_pin)
inline

Definition at line 13 of file a4988.h.

◆ set_sleep_pin()

void esphome::a4988::A4988::set_sleep_pin ( GPIOPin sleep_pin)
inline

Definition at line 14 of file a4988.h.

◆ set_step_pin()

void esphome::a4988::A4988::set_step_pin ( GPIOPin step_pin)
inline

Definition at line 12 of file a4988.h.

◆ setup()

void esphome::a4988::A4988::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file a4988.cpp.

Field Documentation

◆ dir_pin_

GPIOPin* esphome::a4988::A4988::dir_pin_
protected

Definition at line 22 of file a4988.h.

◆ high_freq_

HighFrequencyLoopRequester esphome::a4988::A4988::high_freq_
protected

Definition at line 25 of file a4988.h.

◆ sleep_pin_

GPIOPin* esphome::a4988::A4988::sleep_pin_ {nullptr}
protected

Definition at line 23 of file a4988.h.

◆ sleep_pin_state_

bool esphome::a4988::A4988::sleep_pin_state_
protected

Definition at line 24 of file a4988.h.

◆ step_pin_

GPIOPin* esphome::a4988::A4988::step_pin_
protected

Definition at line 21 of file a4988.h.


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