The latest development version of this page may be more current than this released 4.0.0 version.

zephyr,sensing-phy-3d-sensor

Vendor: Zephyr-specific binding

Note

An implementation of a driver matching this compatible is available in subsys/sensing/sensor/phy_3d_sensor/phy_3d_sensor.c.

Description

Sensing subsystem physical 3d sensors(accel, gyro, mag) bindings.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

underlying-device

phandle

underlying sensor device for physical sensor

This property is required.

sensor-types

array

sensor type id (follow HID spec definition)

This property is required.

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).

This property is required.

minimal-interval

int

sensor minimal report interval

This property is required.

reporters

phandles

sensor reporters

reporters-index

array

the index in sensor-types of reporter if the reporter support multiple sensor-types

stream-mode

boolean

sensor works on stream mode or poll mode