LIS2DW12 Sensor

Component/Hub

The lis2dw12 sensor platform allows you to use your ST LIS2DW12 tri-axial, low-g accelerometer (datasheet) with ESPHome. The sensor supports both I²C and SPI buses.

LIS2DW12 is a 14-bit accelerometer with multiple power modes, tap/double-tap detection, free-fall detection, wake-up/activity detection, and 6D orientation recognition.

This component provides acceleration data in m/s², orientation information, and event detection. XYZ axes can be calibrated and transformed to match the physical orientation of the sensor.

Module breakout board with LIS2DW12 sensor.

# Example I2C configuration
lis2dw12_i2c:
  range: 4G
  power_mode: high_performance
  output_data_rate: 100Hz
  update_interval: 10s

# Example SPI configuration
lis2dw12_spi:
  cs_pin: GPIO5
  range: 4G
  power_mode: high_performance
  output_data_rate: 100Hz
  update_interval: 10s

Configuration variables

The configuration is made up of several parts: The central component (I2C or SPI variant), acceleration sensors, text sensor with orientation information, and binary sensors for taps, freefall, and movement detection.

Base Configuration (shared by both lis2dw12_i2c and lis2dw12_spi):

• update_interval (Optional, Time): The interval for updating acceleration sensors. Defaults to 10s.

• range (Optional, string): The range of the sensor measurements. One of 2G, 4G, 8G, 16G. Defaults to 2G which means it picks up accelerations between -2g and 2g.

• power_mode (Optional, string): Operating power mode. One of high_performance, low_power_1, low_power_2, low_power_3, low_power_4. Mode low_power_1 uses 12-bit resolution, all others use 14-bit. Defaults to high_performance.

• output_data_rate (Optional, string): Output data rate. One of 1.6Hz, 12.5Hz, 25Hz, 50Hz, 100Hz, 200Hz, 400Hz, 800Hz, 1600Hz. Defaults to 100Hz.

• filter_bandwidth (Optional, string): Digital filter bandwidth. One of odr_div_2, odr_div_4, odr_div_10, odr_div_20. Defaults to odr_div_2.

• low_noise (Optional, boolean): Enable low-noise mode. Defaults to false.

• calibration (Optional):

  • offset_x (Optional, float): X-axis zero position calibration, in m/s². From -4.5 to 4.5. Defaults to 0.
  • offset_y (Optional, float): Y-axis zero position calibration, in m/s². From -4.5 to 4.5. Defaults to 0.
  • offset_z (Optional, float): Z-axis zero position calibration, in m/s². From -4.5 to 4.5. Defaults to 0.

• transform (Optional):

  • mirror_x (Optional, boolean): Mirror X-axis. Defaults to false.
  • mirror_y (Optional, boolean): Mirror Y-axis. Defaults to false.
  • mirror_z (Optional, boolean): Mirror Z-axis. Defaults to false.
  • swap_xy (Optional, boolean): Swap X and Y axis. Defaults to false.

I2C-specific:

• All options from I²C Device. Default address is 0x19.

SPI-specific:

• cs_pin (Required, Pin): The chip select pin.
• All other options from SPI Device.

Binary Sensor

Four binary sensors available for use. Internal 500 ms debounce is applied for all sensors. For every sensor name is required. All other options from Binary Sensor. Shorthand notation also can be used.

binary_sensor:
  - platform: lis2dw12_base
    tap: Single tap          # shorthand notation for the sensor
    double_tap: Double tap   # -- "" --
    freefall: Freefall       # -- "" --
    active:                  # regular notation for the sensor to be able
      name: Active           # to use filters and other options
      filters:
        - delayed_off: 5000ms # example of prolongation of movement detection signal

Configuration variables

• tap (Optional): Single tap detection.
• double_tap (Optional): Double tap detection.
• freefall (Optional): Free-fall detection.
• active (Optional): Movement detection.

Sensor

Acceleration data is available through sensors configuration. You can use shorthand notation like acceleration_x: "Acceleration X" or use regular notation. For regular notation only the name is required. All options from Sensor.

sensor:
  - platform: lis2dw12_base
    acceleration_x: Accel X
    acceleration_y: Accel Y
    acceleration_z: Accel Z

Configuration variables

• acceleration_x (Optional): X-axis acceleration, m/s².
• acceleration_y (Optional): Y-axis acceleration, m/s².
• acceleration_z (Optional): Z-axis acceleration, m/s².

Text Sensor

Text sensor provides 6D orientation information. You can use shorthand notation like orientation: "Orientation" or use regular notation.

text_sensor:
  - platform: lis2dw12_base
    orientation: Orientation

Configuration variables

• orientation (Optional): 6D orientation. Can be one of X Up, X Down, Y Up, Y Down, Z Up, Z Down.

Automations

on_tap trigger

This automation will be triggered when single tap is detected.

lis2dw12_i2c:  # or lis2dw12_spi
  # ...
  on_tap:
    - then:
        - logger.log: "Tapped"

on_double_tap trigger

This automation will be triggered when double tap is detected.

lis2dw12_i2c:  # or lis2dw12_spi
  # ...
  on_double_tap:
    - then:
        - logger.log: "Double tapped"

on_freefall trigger

This automation will be triggered when free-fall is detected.

lis2dw12_i2c:  # or lis2dw12_spi
  # ...
  on_freefall:
    - then:
        - logger.log: "Freefall detected"

on_active trigger

This automation will be triggered when device detects changes in motion.

lis2dw12_i2c:  # or lis2dw12_spi
  # ...
  on_active:
    - then:
        - logger.log: "Activity detected"

on_orientation trigger

This automation will be triggered when device orientation is changed with respect to the gravitation field vector g.

lis2dw12_i2c:  # or lis2dw12_spi
  # ...
  on_orientation:
    - then:
        - logger.log: "Orientation change detected"

See Also

• Sensor Filters
• API Reference: lis2dw12_base.h