#include <lis2dw12.h>

Inheritance diagram for esphome::lis2dw12::LIS2DW12Component:

Public Member Functions
void	setup () override

void	dump_config () override

void	loop () override

void	update () override

void	set_power_mode (PowerMode mode)

void	set_low_noise (bool low_noise)

void	set_output_data_rate (DataRate rate)

void	set_range (Range range)

void	set_filter_bandwidth (FilterBandwidth bw)

void	set_offset (float offset_x, float offset_y, float offset_z)

void	set_transform (bool mirror_x, bool mirror_y, bool mirror_z, bool swap_xy)

bool	read_byte (uint8_t a_register, uint8_t *data)

virtual bool	write_byte (uint8_t a_register, uint8_t data)=0

virtual bool	read_bytes (uint8_t a_register, uint8_t *data, size_t len)=0

void	set_tap_binary_sensor (binary_sensor::BinarySensor *s)

void	set_double_tap_binary_sensor (binary_sensor::BinarySensor *s)

void	set_freefall_binary_sensor (binary_sensor::BinarySensor *s)

void	set_active_binary_sensor (binary_sensor::BinarySensor *s)

	SUB_SENSOR (acceleration_x) SUB_SENSOR(acceleration_y) SUB_SENSOR(acceleration_z) SUB_TEXT_SENSOR(orientation) template< typename F > void add_on_tap_callback(F &&callback)

template<typename F >
void	add_on_double_tap_callback (F &&callback)

template<typename F >
void	add_on_freefall_callback (F &&callback)

template<typename F >
void	add_on_active_callback (F &&callback)

template<typename F >
void	add_on_orientation_callback (F &&callback)

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 float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

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)

Protected Member Functions
bool	write_reg_ (RegisterMap reg, uint8_t value)

bool	configure_registers_ ()

bool	read_acceleration_data_ (float &x, float &y, float &z)

void	handle_event_ (Event event, bool active, uint32_t now, LazyCallbackManager< void()> &callback)

void	publish_orientation_ (RegSixdSrc sixd)

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
float	offset_x_ {0}

float	offset_y_ {0}

float	offset_z_ {0}

float	scale_ {0}

uint32_t	last_event_ms_ [EVENT_COUNT] {}

uint32_t	last_poll_ms_ {0}

binary_sensor::BinarySensor *	event_binary_sensors_ [EVENT_COUNT] {}

LazyCallbackManager< void()>	tap_callback_

LazyCallbackManager< void()>	double_tap_callback_

LazyCallbackManager< void()>	freefall_callback_

LazyCallbackManager< void()>	active_callback_

LazyCallbackManager< void()>	orientation_callback_

PowerMode	power_mode_ {PowerMode::HIGH_PERF}

DataRate	data_rate_ {DataRate::RATE_100HZ}

Range	range_ {Range::RANGE_2G}

FilterBandwidth	filter_bandwidth_ {FilterBandwidth::BW_ODR_DIV_2}

bool	low_noise_ {false}

bool	mirror_x_ {false}

bool	mirror_y_ {false}

bool	mirror_z_ {false}

bool	swap_xy_ {false}

uint8_t	shift_ {2}

uint8_t	events_on_ {0}

uint8_t	sixd_last_ {0xFF}

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_

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Detailed Description

Definition at line 111 of file lis2dw12.h.

Member Function Documentation

◆ add_on_active_callback()

template<typename F >

void esphome::lis2dw12::LIS2DW12Component::add_on_active_callback ( F && callback )

inline

Definition at line 156 of file lis2dw12.h.

◆ add_on_double_tap_callback()

template<typename F >

void esphome::lis2dw12::LIS2DW12Component::add_on_double_tap_callback ( F && callback )

inline

Definition at line 150 of file lis2dw12.h.

◆ add_on_freefall_callback()

template<typename F >

void esphome::lis2dw12::LIS2DW12Component::add_on_freefall_callback ( F && callback )

inline

Definition at line 153 of file lis2dw12.h.

◆ add_on_orientation_callback()

template<typename F >

void esphome::lis2dw12::LIS2DW12Component::add_on_orientation_callback ( F && callback )

inline

Definition at line 159 of file lis2dw12.h.

◆ configure_registers_()

bool esphome::lis2dw12::LIS2DW12Component::configure_registers_ ( )

protected

Definition at line 145 of file lis2dw12.cpp.

◆ dump_config()

void esphome::lis2dw12::LIS2DW12Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::lis2dw12_i2c::LIS2DW12I2CComponent, and esphome::lis2dw12_spi::LIS2DW12SPIComponent.

Definition at line 176 of file lis2dw12.cpp.

◆ handle_event_()

void esphome::lis2dw12::LIS2DW12Component::handle_event_	(	Event	event,
		bool	active,
		uint32_t	now,
		LazyCallbackManager< void()> &	callback )

protected

Definition at line 257 of file lis2dw12.cpp.

◆ loop()

void esphome::lis2dw12::LIS2DW12Component::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 285 of file lis2dw12.cpp.

◆ publish_orientation_()

void esphome::lis2dw12::LIS2DW12Component::publish_orientation_ ( RegSixdSrc sixd )

protected

Definition at line 247 of file lis2dw12.cpp.

◆ read_acceleration_data_()

bool esphome::lis2dw12::LIS2DW12Component::read_acceleration_data_	(	float &	x,
		float &	y,
		float &	z )

protected

Definition at line 211 of file lis2dw12.cpp.

◆ read_byte()

bool esphome::lis2dw12::LIS2DW12Component::read_byte	(	uint8_t	a_register,
		uint8_t *	data )

inline

Definition at line 126 of file lis2dw12.h.

◆ read_bytes()

virtual bool esphome::lis2dw12::LIS2DW12Component::read_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len )

pure virtual

Implemented in esphome::lis2dw12_i2c::LIS2DW12I2CComponent, and esphome::lis2dw12_spi::LIS2DW12SPIComponent.

◆ set_active_binary_sensor()

void esphome::lis2dw12::LIS2DW12Component::set_active_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 136 of file lis2dw12.h.

◆ set_double_tap_binary_sensor()

void esphome::lis2dw12::LIS2DW12Component::set_double_tap_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 132 of file lis2dw12.h.

◆ set_filter_bandwidth()

void esphome::lis2dw12::LIS2DW12Component::set_filter_bandwidth ( FilterBandwidth bw )

inline

Definition at line 122 of file lis2dw12.h.

◆ set_freefall_binary_sensor()

void esphome::lis2dw12::LIS2DW12Component::set_freefall_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 135 of file lis2dw12.h.

◆ set_low_noise()

void esphome::lis2dw12::LIS2DW12Component::set_low_noise ( bool low_noise )

inline

Definition at line 119 of file lis2dw12.h.

◆ set_offset()

void esphome::lis2dw12::LIS2DW12Component::set_offset	(	float	offset_x,
		float	offset_y,
		float	offset_z )

Definition at line 338 of file lis2dw12.cpp.

◆ set_output_data_rate()

void esphome::lis2dw12::LIS2DW12Component::set_output_data_rate ( DataRate rate )

inline

Definition at line 120 of file lis2dw12.h.

◆ set_power_mode()

void esphome::lis2dw12::LIS2DW12Component::set_power_mode ( PowerMode mode )

inline

Definition at line 118 of file lis2dw12.h.

◆ set_range()

void esphome::lis2dw12::LIS2DW12Component::set_range ( Range range )

inline

Definition at line 121 of file lis2dw12.h.

◆ set_tap_binary_sensor()

void esphome::lis2dw12::LIS2DW12Component::set_tap_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 131 of file lis2dw12.h.

◆ set_transform()

void esphome::lis2dw12::LIS2DW12Component::set_transform	(	bool	mirror_x,
		bool	mirror_y,
		bool	mirror_z,
		bool	swap_xy )

Definition at line 344 of file lis2dw12.cpp.

◆ setup()

void esphome::lis2dw12::LIS2DW12Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::lis2dw12_spi::LIS2DW12SPIComponent.

Definition at line 84 of file lis2dw12.cpp.

◆ SUB_SENSOR()

esphome::lis2dw12::LIS2DW12Component::SUB_SENSOR ( acceleration_x ) &&

inline

Definition at line 140 of file lis2dw12.h.

◆ update()

void esphome::lis2dw12::LIS2DW12Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 317 of file lis2dw12.cpp.

◆ write_byte()

virtual bool esphome::lis2dw12::LIS2DW12Component::write_byte	(	uint8_t	a_register,
		uint8_t	data )

pure virtual

Implemented in esphome::lis2dw12_i2c::LIS2DW12I2CComponent, and esphome::lis2dw12_spi::LIS2DW12SPIComponent.

◆ write_reg_()

bool esphome::lis2dw12::LIS2DW12Component::write_reg_	(	RegisterMap	reg,
		uint8_t	value )

inlineprotected

Definition at line 164 of file lis2dw12.h.

Field Documentation

◆ active_callback_

LazyCallbackManager<void()> esphome::lis2dw12::LIS2DW12Component::active_callback_

protected

Definition at line 182 of file lis2dw12.h.

◆ data_rate_

DataRate esphome::lis2dw12::LIS2DW12Component::data_rate_ {DataRate::RATE_100HZ}

protected

Definition at line 186 of file lis2dw12.h.

◆ double_tap_callback_

LazyCallbackManager<void()> esphome::lis2dw12::LIS2DW12Component::double_tap_callback_

protected

Definition at line 180 of file lis2dw12.h.

◆ event_binary_sensors_

binary_sensor::BinarySensor* esphome::lis2dw12::LIS2DW12Component::event_binary_sensors_[EVENT_COUNT] {}

protected

Definition at line 177 of file lis2dw12.h.

◆ events_on_

uint8_t esphome::lis2dw12::LIS2DW12Component::events_on_ {0}

protected

Definition at line 192 of file lis2dw12.h.

◆ filter_bandwidth_

FilterBandwidth esphome::lis2dw12::LIS2DW12Component::filter_bandwidth_ {FilterBandwidth::BW_ODR_DIV_2}

protected

Definition at line 188 of file lis2dw12.h.

◆ freefall_callback_

LazyCallbackManager<void()> esphome::lis2dw12::LIS2DW12Component::freefall_callback_

protected

Definition at line 181 of file lis2dw12.h.

◆ last_event_ms_

uint32_t esphome::lis2dw12::LIS2DW12Component::last_event_ms_[EVENT_COUNT] {}

protected

Definition at line 174 of file lis2dw12.h.

◆ last_poll_ms_

uint32_t esphome::lis2dw12::LIS2DW12Component::last_poll_ms_ {0}

protected

Definition at line 175 of file lis2dw12.h.

◆ low_noise_

bool esphome::lis2dw12::LIS2DW12Component::low_noise_ {false}

protected

Definition at line 189 of file lis2dw12.h.

◆ mirror_x_

bool esphome::lis2dw12::LIS2DW12Component::mirror_x_ {false}

protected

Definition at line 190 of file lis2dw12.h.

◆ mirror_y_

bool esphome::lis2dw12::LIS2DW12Component::mirror_y_ {false}

protected

Definition at line 190 of file lis2dw12.h.

◆ mirror_z_

bool esphome::lis2dw12::LIS2DW12Component::mirror_z_ {false}

protected

Definition at line 190 of file lis2dw12.h.

◆ offset_x_

float esphome::lis2dw12::LIS2DW12Component::offset_x_ {0}

protected

Definition at line 172 of file lis2dw12.h.

◆ offset_y_

float esphome::lis2dw12::LIS2DW12Component::offset_y_ {0}

protected

Definition at line 172 of file lis2dw12.h.

◆ offset_z_

float esphome::lis2dw12::LIS2DW12Component::offset_z_ {0}

protected

Definition at line 172 of file lis2dw12.h.

◆ orientation_callback_

LazyCallbackManager<void()> esphome::lis2dw12::LIS2DW12Component::orientation_callback_

protected

Definition at line 183 of file lis2dw12.h.

◆ power_mode_

PowerMode esphome::lis2dw12::LIS2DW12Component::power_mode_ {PowerMode::HIGH_PERF}

protected

Definition at line 185 of file lis2dw12.h.

◆ range_

Range esphome::lis2dw12::LIS2DW12Component::range_ {Range::RANGE_2G}

protected

Definition at line 187 of file lis2dw12.h.

◆ scale_

float esphome::lis2dw12::LIS2DW12Component::scale_ {0}

protected

Definition at line 173 of file lis2dw12.h.

◆ shift_

uint8_t esphome::lis2dw12::LIS2DW12Component::shift_ {2}

protected

Definition at line 191 of file lis2dw12.h.

◆ sixd_last_

uint8_t esphome::lis2dw12::LIS2DW12Component::sixd_last_ {0xFF}

protected

Definition at line 194 of file lis2dw12.h.

◆ swap_xy_

bool esphome::lis2dw12::LIS2DW12Component::swap_xy_ {false}

protected

Definition at line 190 of file lis2dw12.h.

◆ tap_callback_

LazyCallbackManager<void()> esphome::lis2dw12::LIS2DW12Component::tap_callback_

protected

Definition at line 179 of file lis2dw12.h.

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

esphome/components/lis2dw12/lis2dw12.h
esphome/components/lis2dw12/lis2dw12.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_on_active_callback()

◆ add_on_double_tap_callback()

◆ add_on_freefall_callback()

◆ add_on_orientation_callback()

◆ configure_registers_()

◆ dump_config()

◆ handle_event_()

◆ loop()

◆ publish_orientation_()

◆ read_acceleration_data_()

◆ read_byte()

◆ read_bytes()

◆ set_active_binary_sensor()

◆ set_double_tap_binary_sensor()

◆ set_filter_bandwidth()

◆ set_freefall_binary_sensor()

◆ set_low_noise()

◆ set_offset()

◆ set_output_data_rate()

◆ set_power_mode()

◆ set_range()

◆ set_tap_binary_sensor()

◆ set_transform()

◆ setup()

◆ SUB_SENSOR()

◆ update()

◆ write_byte()

◆ write_reg_()

Field Documentation

◆ active_callback_

◆ data_rate_

◆ double_tap_callback_

◆ event_binary_sensors_

◆ events_on_

◆ filter_bandwidth_

◆ freefall_callback_

◆ last_event_ms_

◆ last_poll_ms_

◆ low_noise_

◆ mirror_x_

◆ mirror_y_

◆ mirror_z_

◆ offset_x_

◆ offset_y_

◆ offset_z_

◆ orientation_callback_

◆ power_mode_

◆ range_

◆ scale_

◆ shift_

◆ sixd_last_

◆ swap_xy_

◆ tap_callback_