st,lsm9ds1 (on i2c bus)

Vendor: STMicroelectronics

Description

STMicroelectronics LSM9DS1 9-axis IMU (Inertial Measurement Unit) sensor
accessed through I2C bus.

This binding describe only the inertial part : accelerometer and gyroscope.

When setting the accel-range, gyro-range, imu-odr properties in
a .dts or .dtsi file you may include lsm9ds1.h and use the macros
defined there.

Example:
#include <zephyr/dt-bindings/sensor/lsm9ds1.h>

lsm9ds1: lsm9ds1@0 {
  ...

  accel-range = <LSM9DS1_DT_FS_4G>;
  imu-odr   =  <LSM9DS1_IMU_14Hz9>;
  gyro-range = <LSM9DS1_DT_FS_2000DPS>;
};

Properties

Properties not inherited from the base binding file.

Name

Type

Details

friendly-name

string

 
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.

This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).

supply-gpios

phandle-array

 
GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

 
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.

accel-range

int

 
Range of the accelerometer. Unit : g. Default is power-up configuration.

- 0 # LSM9DS1_DT_FS_2G  (0.061 mg/LSB)
- 1 # LSM9DS1_DT_FS_16G (0.732 mg/LSB)
- 2 # LSM9DS1_DT_FS_4G  (0.122 mg/LSB)
- 3 # LSM9DS1_DT_FS_8G  (0.244 mg/LSB)

Legal values: 0, 1, 2, 3

gyro-range

int

 
Range in dps. Default is power-up configuration.

- 0 # LSM9DS1_DT_FS_245DPS  (8.75  mdps/LSB)
- 1 # LSM9DS1_DT_FS_500DPS  (17.50 mdps/LSB)
- 3 # LSM9DS1_DT_FS_2000DPS (70    mdps/LSB)

Legal values: 0, 1, 3

imu-odr

int

 
Specify the default accelerometer and gyroscope output data rate expressed in samples
per second (Hz).
Default is power-up configuration.

- 0x00 # LSM9DS1_IMU_OFF
- 0x10 # LSM9DS1_GY_OFF_XL_10Hz
- 0x20 # LSM9DS1_GY_OFF_XL_50Hz
- 0x30 # LSM9DS1_GY_OFF_XL_119Hz
- 0x40 # LSM9DS1_GY_OFF_XL_238Hz
- 0x50 # LSM9DS1_GY_OFF_XL_476Hz
- 0x60 # LSM9DS1_GY_OFF_XL_952Hz
- 0x01 # LSM9DS1_XL_OFF_GY_14Hz9
- 0x02 # LSM9DS1_XL_OFF_GY_59Hz5
- 0x03 # LSM9DS1_XL_OFF_GY_119Hz
- 0x04 # LSM9DS1_XL_OFF_GY_238Hz
- 0x05 # LSM9DS1_XL_OFF_GY_476Hz
- 0x06 # LSM9DS1_XL_OFF_GY_952Hz
- 0x11 # LSM9DS1_IMU_14Hz9
- 0x22 # LSM9DS1_IMU_59Hz5
- 0x33 # LSM9DS1_IMU_119Hz
- 0x44 # LSM9DS1_IMU_238Hz
- 0x55 # LSM9DS1_IMU_476Hz
- 0x66 # LSM9DS1_IMU_952Hz
- 0x81 # LSM9DS1_XL_OFF_GY_14Hz9_LP
- 0x82 # LSM9DS1_XL_OFF_GY_59Hz5_LP
- 0x83 # LSM9DS1_XL_OFF_GY_119Hz_LP
- 0x91 # LSM9DS1_IMU_14Hz9_LP
- 0xA2 # LSM9DS1_IMU_59Hz5_LP
- 0xB3 # LSM9DS1_IMU_119Hz_LP

Legal values: 0, 16, 32, 48, 64, 80, 96, 1, 2, 3, 4, 5, 6, 17, 34, 51, 68, 85, 102, 129, 130, 131, 145, 162, 179