haptics_driver_api Struct Reference

Driver Operations Haptics driver operations More...

#include <zephyr/drivers/haptics.h>

Data Fields
haptics_start_output_t	start_output
	REQ Set the haptic device to start output for a playback event.
haptics_stop_output_t	stop_output
	REQ Set the haptic device to stop output for a playback event.
haptics_register_error_callback_t	register_error_callback
	OPT Register a callback function for haptics errors.

Detailed Description

Driver Operations Haptics driver operations

This is the driver API structure any Haptics 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

register_error_callback

haptics_register_error_callback_t haptics_driver_api::register_error_callback

OPT Register a callback function for haptics errors.

start_output

haptics_start_output_t haptics_driver_api::start_output

REQ Set the haptic device to start output for a playback event.

stop_output

haptics_stop_output_t haptics_driver_api::stop_output

REQ Set the haptic device to stop output for a playback event.

---

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

• zephyr/drivers/haptics.h