Driver Operations Sensor driver operations More...

#include <zephyr/drivers/sensor.h>

Data Fields
sensor_attr_set_t	attr_set
	OPT Set an attribute for a sensor.
sensor_attr_get_t	attr_get
	OPT Get an attribute for a sensor.
sensor_trigger_set_t	trigger_set
	OPT Activate a sensor's trigger and set the trigger handler.
sensor_sample_fetch_t	sample_fetch
	REQ Fetch a sample from the sensor and store it in an internal driver buffer.
sensor_channel_get_t	channel_get
	REQ Get a reading from a sensor device.
sensor_get_decoder_t	get_decoder
	OPT Get the sensor's decoder API.
sensor_submit_t	submit
	OPT Handler for RTIO submissions to this sensor.

Detailed Description

Driver Operations Sensor driver operations

This is the driver API structure any Sensor driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ attr_get

sensor_attr_get_t sensor_driver_api::attr_get

OPT Get an attribute for a sensor.

◆ attr_set

sensor_attr_set_t sensor_driver_api::attr_set

OPT Set an attribute for a sensor.

◆ channel_get

sensor_channel_get_t sensor_driver_api::channel_get

REQ Get a reading from a sensor device.

◆ get_decoder

sensor_get_decoder_t sensor_driver_api::get_decoder

OPT Get the sensor's decoder API.

◆ sample_fetch

sensor_sample_fetch_t sensor_driver_api::sample_fetch

REQ Fetch a sample from the sensor and store it in an internal driver buffer.

◆ submit

sensor_submit_t sensor_driver_api::submit

OPT Handler for RTIO submissions to this sensor.

◆ trigger_set

sensor_trigger_set_t sensor_driver_api::trigger_set

OPT Activate a sensor's trigger and set the trigger handler.

The documentation for this struct was generated from the following file:

zephyr/drivers/sensor.h

Data Fields