ESPHome  2022.1.1
Public Member Functions | Protected Types | Protected Attributes
esphome::hmc5883l::HMC5883LComponent Class Reference

#include <hmc5883l.h>

Inheritance diagram for esphome::hmc5883l::HMC5883LComponent:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
void set_oversampling (HMC5883LOversampling oversampling)
 
void set_datarate (HMC5883LDatarate datarate)
 
void set_range (HMC5883LRange range)
 
void set_x_sensor (sensor::Sensor *x_sensor)
 
void set_y_sensor (sensor::Sensor *y_sensor)
 
void set_z_sensor (sensor::Sensor *z_sensor)
 
void set_heading_sensor (sensor::Sensor *heading_sensor)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
- 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 ()
 
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...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 
ErrorCode write (const uint8_t *data, uint8_t len)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
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)
 
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 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 write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Types

enum  ErrorCode { NONE = 0, COMMUNICATION_FAILED, ID_REGISTERS }
 

Protected Attributes

HMC5883LOversampling oversampling_ {HMC5883L_OVERSAMPLING_1}
 
HMC5883LDatarate datarate_ {HMC5883L_DATARATE_15_0_HZ}
 
HMC5883LRange range_ {HMC5883L_RANGE_130_UT}
 
sensor::Sensorx_sensor_
 
sensor::Sensory_sensor_
 
sensor::Sensorz_sensor_
 
sensor::Sensorheading_sensor_
 
enum esphome::hmc5883l::HMC5883LComponent::ErrorCode error_code_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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}
 
I2CBusbus_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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 38 of file hmc5883l.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
NONE 
COMMUNICATION_FAILED 
ID_REGISTERS 

Definition at line 61 of file hmc5883l.h.

Member Function Documentation

◆ dump_config()

void esphome::hmc5883l::HMC5883LComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 67 of file hmc5883l.cpp.

◆ get_setup_priority()

float esphome::hmc5883l::HMC5883LComponent::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 82 of file hmc5883l.cpp.

◆ set_datarate()

void esphome::hmc5883l::HMC5883LComponent::set_datarate ( HMC5883LDatarate  datarate)
inline

Definition at line 46 of file hmc5883l.h.

◆ set_heading_sensor()

void esphome::hmc5883l::HMC5883LComponent::set_heading_sensor ( sensor::Sensor heading_sensor)
inline

Definition at line 51 of file hmc5883l.h.

◆ set_oversampling()

void esphome::hmc5883l::HMC5883LComponent::set_oversampling ( HMC5883LOversampling  oversampling)
inline

Definition at line 45 of file hmc5883l.h.

◆ set_range()

void esphome::hmc5883l::HMC5883LComponent::set_range ( HMC5883LRange  range)
inline

Definition at line 47 of file hmc5883l.h.

◆ set_x_sensor()

void esphome::hmc5883l::HMC5883LComponent::set_x_sensor ( sensor::Sensor x_sensor)
inline

Definition at line 48 of file hmc5883l.h.

◆ set_y_sensor()

void esphome::hmc5883l::HMC5883LComponent::set_y_sensor ( sensor::Sensor y_sensor)
inline

Definition at line 49 of file hmc5883l.h.

◆ set_z_sensor()

void esphome::hmc5883l::HMC5883LComponent::set_z_sensor ( sensor::Sensor z_sensor)
inline

Definition at line 50 of file hmc5883l.h.

◆ setup()

void esphome::hmc5883l::HMC5883LComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file hmc5883l.cpp.

◆ update()

void esphome::hmc5883l::HMC5883LComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 83 of file hmc5883l.cpp.

Field Documentation

◆ datarate_

HMC5883LDatarate esphome::hmc5883l::HMC5883LComponent::datarate_ {HMC5883L_DATARATE_15_0_HZ}
protected

Definition at line 55 of file hmc5883l.h.

◆ error_code_

enum esphome::hmc5883l::HMC5883LComponent::ErrorCode esphome::hmc5883l::HMC5883LComponent::error_code_
protected

◆ heading_sensor_

sensor::Sensor* esphome::hmc5883l::HMC5883LComponent::heading_sensor_
protected

Definition at line 60 of file hmc5883l.h.

◆ oversampling_

HMC5883LOversampling esphome::hmc5883l::HMC5883LComponent::oversampling_ {HMC5883L_OVERSAMPLING_1}
protected

Definition at line 54 of file hmc5883l.h.

◆ range_

HMC5883LRange esphome::hmc5883l::HMC5883LComponent::range_ {HMC5883L_RANGE_130_UT}
protected

Definition at line 56 of file hmc5883l.h.

◆ x_sensor_

sensor::Sensor* esphome::hmc5883l::HMC5883LComponent::x_sensor_
protected

Definition at line 57 of file hmc5883l.h.

◆ y_sensor_

sensor::Sensor* esphome::hmc5883l::HMC5883LComponent::y_sensor_
protected

Definition at line 58 of file hmc5883l.h.

◆ z_sensor_

sensor::Sensor* esphome::hmc5883l::HMC5883LComponent::z_sensor_
protected

Definition at line 59 of file hmc5883l.h.


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