ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::lis3dh::LIS3DHComponent Class Reference

#include <lis3dh.h>

Inheritance diagram for esphome::lis3dh::LIS3DHComponent:
esphome::motion::MotionComponent esphome::i2c::I2CDevice esphome::PollingComponent esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
void on_shutdown () override
 
void set_range (LIS3DHRange range)
 
void set_data_rate (LIS3DHDataRate data_rate)
 
void set_operating_mode (LIS3DHOperatingMode mode)
 
void set_interrupt (LIS3DHInterruptPin pin, uint8_t threshold, uint8_t duration, uint8_t axes_cfg, bool latched, bool active_high, bool high_pass)
 
template<typename F >
void add_temperature_listener (F &&cb)
 
- Public Member Functions inherited from esphome::motion::MotionComponent
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_matrix (const std::array< float, 9 > &m)
 
void set_calibration_key (uint32_t key)
 
bool calibrate_level ()
 Calibrate the matrix so the current reading maps to [0, 0, 1] (device flat).
 
bool calibrate_heading ()
 Assuming Y-axis rotation only, correct the heading so X/Y align correctly.
 
bool save_calibration ()
 Save the current matrix to NVS.
 
void clear_calibration (bool save=false)
 Restore the build-time (axis_map / transform_matrix) base, discarding calibration, and persist that base when save is set.
 
template<typename F >
void add_listener (F &&cb)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus.
 
uint8_t get_i2c_address () const
 Returns the I2C address of the object.
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor
 
ErrorCode read (uint8_t *data, size_t len) const
 reads an array of bytes from the device using an I2CBus
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode write (const uint8_t *data, size_t len) const
 writes an array of bytes to a device using an I2CBus
 
ErrorCode write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const
 writes an array of bytes to a device, then reads an array, as a single transaction
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len) const
 writes an array of bytes to a specific register in the I²C device
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
 write an array of bytes to a specific register in the I²C device
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons.
 
bool read_bytes_raw (uint8_t *data, uint8_t len) const
 
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) const
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const
 
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) const
 
bool write_byte (uint8_t a_register, uint8_t data) const
 
bool write_byte_16 (uint8_t a_register, uint16_t data) const
 

Protected Member Functions

bool update_data (motion::MotionData &data) override
 
bool setup_accelerometer_ ()
 
bool setup_temperature_ ()
 
bool setup_interrupt_ ()
 
bool publish_temperature_ ()
 
- Protected Member Functions inherited from esphome::motion::MotionComponent
void map_axes_ (float output[3], const float input[3]) const
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

LIS3DHRange range_ {LIS3DH_RANGE_2G}
 
LIS3DHDataRate data_rate_ {LIS3DH_DATA_RATE_100HZ}
 
LIS3DHOperatingMode operating_mode_ {LIS3DH_MODE_HIGH_RESOLUTION}
 
LIS3DHInterruptPin interrupt_pin_ {LIS3DH_INT_PIN_INT1}
 
uint8_t interrupt_threshold_ {0}
 
uint8_t interrupt_duration_ {0}
 
uint8_t interrupt_axes_cfg_ {0}
 
bool interrupt_latched_ {false}
 
bool interrupt_active_high_ {true}
 
bool interrupt_high_pass_ {false}
 
LazyCallbackManager< void(float)> temperature_callback_ {}
 
- Protected Attributes inherited from esphome::motion::MotionComponent
float matrix_ [9]
 
float base_matrix_ [9]
 
LazyCallbackManager< void(MotionData const &)> motion_data_callback_ {}
 
uint32_t pref_key_ {0}
 
uint32_t base_hash_ {0}
 
ESPPreferenceObject pref_ {}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus
 
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 89 of file lis3dh.h.

Member Function Documentation

◆ add_temperature_listener()

template<typename F >
void esphome::lis3dh::LIS3DHComponent::add_temperature_listener ( F && cb)
inline

Definition at line 110 of file lis3dh.h.

◆ dump_config()

void esphome::lis3dh::LIS3DHComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 117 of file lis3dh.cpp.

◆ on_shutdown()

void esphome::lis3dh::LIS3DHComponent::on_shutdown ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 143 of file lis3dh.cpp.

◆ publish_temperature_()

bool esphome::lis3dh::LIS3DHComponent::publish_temperature_ ( )
protected

Definition at line 178 of file lis3dh.cpp.

◆ set_data_rate()

void esphome::lis3dh::LIS3DHComponent::set_data_rate ( LIS3DHDataRate data_rate)
inline

Definition at line 96 of file lis3dh.h.

◆ set_interrupt()

void esphome::lis3dh::LIS3DHComponent::set_interrupt ( LIS3DHInterruptPin pin,
uint8_t threshold,
uint8_t duration,
uint8_t axes_cfg,
bool latched,
bool active_high,
bool high_pass )
inline

Definition at line 99 of file lis3dh.h.

◆ set_operating_mode()

void esphome::lis3dh::LIS3DHComponent::set_operating_mode ( LIS3DHOperatingMode mode)
inline

Definition at line 97 of file lis3dh.h.

◆ set_range()

void esphome::lis3dh::LIS3DHComponent::set_range ( LIS3DHRange range)
inline

Definition at line 95 of file lis3dh.h.

◆ setup()

void esphome::lis3dh::LIS3DHComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 27 of file lis3dh.cpp.

◆ setup_accelerometer_()

bool esphome::lis3dh::LIS3DHComponent::setup_accelerometer_ ( )
protected

Definition at line 47 of file lis3dh.cpp.

◆ setup_interrupt_()

bool esphome::lis3dh::LIS3DHComponent::setup_interrupt_ ( )
protected

Definition at line 69 of file lis3dh.cpp.

◆ setup_temperature_()

bool esphome::lis3dh::LIS3DHComponent::setup_temperature_ ( )
protected

Definition at line 62 of file lis3dh.cpp.

◆ update_data()

bool esphome::lis3dh::LIS3DHComponent::update_data ( motion::MotionData & data)
overrideprotectedvirtual

Implements esphome::motion::MotionComponent.

Definition at line 151 of file lis3dh.cpp.

Field Documentation

◆ data_rate_

LIS3DHDataRate esphome::lis3dh::LIS3DHComponent::data_rate_ {LIS3DH_DATA_RATE_100HZ}
protected

Definition at line 120 of file lis3dh.h.

◆ interrupt_active_high_

bool esphome::lis3dh::LIS3DHComponent::interrupt_active_high_ {true}
protected

Definition at line 129 of file lis3dh.h.

◆ interrupt_axes_cfg_

uint8_t esphome::lis3dh::LIS3DHComponent::interrupt_axes_cfg_ {0}
protected

Definition at line 127 of file lis3dh.h.

◆ interrupt_duration_

uint8_t esphome::lis3dh::LIS3DHComponent::interrupt_duration_ {0}
protected

Definition at line 126 of file lis3dh.h.

◆ interrupt_high_pass_

bool esphome::lis3dh::LIS3DHComponent::interrupt_high_pass_ {false}
protected

Definition at line 130 of file lis3dh.h.

◆ interrupt_latched_

bool esphome::lis3dh::LIS3DHComponent::interrupt_latched_ {false}
protected

Definition at line 128 of file lis3dh.h.

◆ interrupt_pin_

LIS3DHInterruptPin esphome::lis3dh::LIS3DHComponent::interrupt_pin_ {LIS3DH_INT_PIN_INT1}
protected

Definition at line 124 of file lis3dh.h.

◆ interrupt_threshold_

uint8_t esphome::lis3dh::LIS3DHComponent::interrupt_threshold_ {0}
protected

Definition at line 125 of file lis3dh.h.

◆ operating_mode_

LIS3DHOperatingMode esphome::lis3dh::LIS3DHComponent::operating_mode_ {LIS3DH_MODE_HIGH_RESOLUTION}
protected

Definition at line 121 of file lis3dh.h.

◆ range_

LIS3DHRange esphome::lis3dh::LIS3DHComponent::range_ {LIS3DH_RANGE_2G}
protected

Definition at line 119 of file lis3dh.h.

◆ temperature_callback_

LazyCallbackManager<void(float)> esphome::lis3dh::LIS3DHComponent::temperature_callback_ {}
protected

Definition at line 132 of file lis3dh.h.


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