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

ams,ccs811 (on i2c bus)

Vendor: AMS AG

Note

An implementation of a driver matching this compatible is available in drivers/sensor/ams/ccs811/ccs811.c.

Description

CCS811 digital air quality sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

wake-gpios

phandle-array

The WAKEn pin is asserted to communicate with the sensor.  The
sensor receives this as an active-low signal.

reset-gpios

phandle-array

The RESETn pin is asserted to disable the sensor causing a hard
reset.  The sensor receives this as an active-low signal.

irq-gpios

phandle-array

The INTn pin signals that a new reading is available.  The
sensor generates an active-low level signal which remains
asserted until the data is read.

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.