ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::as5600::AS5600Component Class Reference

#include <as5600.h>

Inheritance diagram for esphome::as5600::AS5600Component:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void setup () override
 Set up the internal sensor array. More...
 
void dump_config () override
 
float get_setup_priority () const override
 HARDWARE_LATE setup priority. More...
 
void set_dir_pin (InternalGPIOPin *pin)
 
void set_direction (uint8_t direction)
 
void set_fast_filter (uint8_t fast_filter)
 
void set_hysteresis (uint8_t hysteresis)
 
void set_power_mode (uint8_t power_mode)
 
void set_slow_filter (uint8_t slow_filter)
 
void set_watchdog (bool watchdog)
 
bool get_watchdog ()
 
void set_start_position (uint16_t start_position)
 
void set_end_position (uint16_t end_position)
 
void set_range (uint16_t range)
 
float get_range_scale ()
 
bool in_range (uint16_t raw_position)
 
AS5600MagnetStatus read_magnet_status ()
 
optional< uint16_t > read_position ()
 
optional< uint16_t > read_raw_position ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
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 ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Attributes

InternalGPIOPindir_pin_ {nullptr}
 
uint8_t direction_
 
uint8_t fast_filter_
 
uint8_t hysteresis_
 
uint8_t power_mode_
 
uint8_t slow_filter_
 
uint8_t pwm_frequency_ {0}
 
uint8_t output_mode_ {0}
 
bool watchdog_
 
uint16_t start_position_
 
uint16_t end_position_ {0}
 
uint16_t raw_max_
 
EndPositionMode end_mode_ {END_MODE_RANGE}
 
float range_scale_ {1.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}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Additional Inherited Members

- 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(uint8_t)> &&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(uint8_t)> &&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 47 of file as5600.h.

Member Function Documentation

◆ dump_config()

void esphome::as5600::AS5600Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 89 of file as5600.cpp.

◆ get_range_scale()

float esphome::as5600::AS5600Component::get_range_scale ( )
inline

Definition at line 78 of file as5600.h.

◆ get_setup_priority()

float esphome::as5600::AS5600Component::get_setup_priority ( ) const
inlineoverridevirtual

HARDWARE_LATE setup priority.

Reimplemented from esphome::Component.

Definition at line 53 of file as5600.h.

◆ get_watchdog()

bool esphome::as5600::AS5600Component::get_watchdog ( )
inline

Definition at line 63 of file as5600.h.

◆ in_range()

bool esphome::as5600::AS5600Component::in_range ( uint16_t  raw_position)

Definition at line 110 of file as5600.cpp.

◆ read_magnet_status()

AS5600MagnetStatus esphome::as5600::AS5600Component::read_magnet_status ( )

Definition at line 116 of file as5600.cpp.

◆ read_position()

optional< uint16_t > esphome::as5600::AS5600Component::read_position ( )

Definition at line 121 of file as5600.cpp.

◆ read_raw_position()

optional< uint16_t > esphome::as5600::AS5600Component::read_raw_position ( )

Definition at line 129 of file as5600.cpp.

◆ set_dir_pin()

void esphome::as5600::AS5600Component::set_dir_pin ( InternalGPIOPin pin)
inline

Definition at line 56 of file as5600.h.

◆ set_direction()

void esphome::as5600::AS5600Component::set_direction ( uint8_t  direction)
inline

Definition at line 57 of file as5600.h.

◆ set_end_position()

void esphome::as5600::AS5600Component::set_end_position ( uint16_t  end_position)
inline

Definition at line 65 of file as5600.h.

◆ set_fast_filter()

void esphome::as5600::AS5600Component::set_fast_filter ( uint8_t  fast_filter)
inline

Definition at line 58 of file as5600.h.

◆ set_hysteresis()

void esphome::as5600::AS5600Component::set_hysteresis ( uint8_t  hysteresis)
inline

Definition at line 59 of file as5600.h.

◆ set_power_mode()

void esphome::as5600::AS5600Component::set_power_mode ( uint8_t  power_mode)
inline

Definition at line 60 of file as5600.h.

◆ set_range()

void esphome::as5600::AS5600Component::set_range ( uint16_t  range)
inline

Definition at line 69 of file as5600.h.

◆ set_slow_filter()

void esphome::as5600::AS5600Component::set_slow_filter ( uint8_t  slow_filter)
inline

Definition at line 61 of file as5600.h.

◆ set_start_position()

void esphome::as5600::AS5600Component::set_start_position ( uint16_t  start_position)
inline

Definition at line 64 of file as5600.h.

◆ set_watchdog()

void esphome::as5600::AS5600Component::set_watchdog ( bool  watchdog)
inline

Definition at line 62 of file as5600.h.

◆ setup()

void esphome::as5600::AS5600Component::setup ( )
overridevirtual

Set up the internal sensor array.

Reimplemented from esphome::Component.

Definition at line 25 of file as5600.cpp.

Field Documentation

◆ dir_pin_

InternalGPIOPin* esphome::as5600::AS5600Component::dir_pin_ {nullptr}
protected

Definition at line 88 of file as5600.h.

◆ direction_

uint8_t esphome::as5600::AS5600Component::direction_
protected

Definition at line 89 of file as5600.h.

◆ end_mode_

EndPositionMode esphome::as5600::AS5600Component::end_mode_ {END_MODE_RANGE}
protected

Definition at line 100 of file as5600.h.

◆ end_position_

uint16_t esphome::as5600::AS5600Component::end_position_ {0}
protected

Definition at line 98 of file as5600.h.

◆ fast_filter_

uint8_t esphome::as5600::AS5600Component::fast_filter_
protected

Definition at line 90 of file as5600.h.

◆ hysteresis_

uint8_t esphome::as5600::AS5600Component::hysteresis_
protected

Definition at line 91 of file as5600.h.

◆ output_mode_

uint8_t esphome::as5600::AS5600Component::output_mode_ {0}
protected

Definition at line 95 of file as5600.h.

◆ power_mode_

uint8_t esphome::as5600::AS5600Component::power_mode_
protected

Definition at line 92 of file as5600.h.

◆ pwm_frequency_

uint8_t esphome::as5600::AS5600Component::pwm_frequency_ {0}
protected

Definition at line 94 of file as5600.h.

◆ range_scale_

float esphome::as5600::AS5600Component::range_scale_ {1.0}
protected

Definition at line 101 of file as5600.h.

◆ raw_max_

uint16_t esphome::as5600::AS5600Component::raw_max_
protected

Definition at line 99 of file as5600.h.

◆ slow_filter_

uint8_t esphome::as5600::AS5600Component::slow_filter_
protected

Definition at line 93 of file as5600.h.

◆ start_position_

uint16_t esphome::as5600::AS5600Component::start_position_
protected

Definition at line 97 of file as5600.h.

◆ watchdog_

bool esphome::as5600::AS5600Component::watchdog_
protected

Definition at line 96 of file as5600.h.


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