Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
haptics_driver_api Struct Reference

@driver_ops{Haptics} More...

#include <haptics.h>

Data Fields

haptics_calibrate_t calibrate
 @driver_ops_optional Calibrate the haptic driver for an external actuator.
haptics_monitor_get_t monitor_get
 @driver_ops_optional Retrieve an integrated sensor reading from the haptic driver.
haptics_monitor_set_t monitor_set
 @driver_ops_optional Enable or disable integrated sensing for the haptic driver.
haptics_register_error_callback_t register_error_callback
 @driver_ops_optional Register a callback function for haptics errors.
haptics_select_source_t select_source
 @driver_ops_mandatory Specify a playback source and related configuration details.
haptics_set_level_t set_level
 @driver_ops_optional Set level controls for haptic effects.
haptics_start_output_t start_output
 @driver_ops_mandatory Start playback for a haptic effect.
haptics_stop_output_t stop_output
 @driver_ops_mandatory Stop an ongoing haptic effect and cancel any queued effects, if applicable.
haptics_stream_samples_t stream_samples
 @driver_ops_optional Stream 8-bit samples over the control port for haptic effects.

Detailed Description

@driver_ops{Haptics}

Field Documentation

◆ calibrate

haptics_calibrate_t haptics_driver_api::calibrate

@driver_ops_optional Calibrate the haptic driver for an external actuator.

◆ monitor_get

haptics_monitor_get_t haptics_driver_api::monitor_get

@driver_ops_optional Retrieve an integrated sensor reading from the haptic driver.

◆ monitor_set

haptics_monitor_set_t haptics_driver_api::monitor_set

@driver_ops_optional Enable or disable integrated sensing for the haptic driver.

◆ register_error_callback

haptics_register_error_callback_t haptics_driver_api::register_error_callback

@driver_ops_optional Register a callback function for haptics errors.

◆ select_source

haptics_select_source_t haptics_driver_api::select_source

@driver_ops_mandatory Specify a playback source and related configuration details.

◆ set_level

haptics_set_level_t haptics_driver_api::set_level

@driver_ops_optional Set level controls for haptic effects.

◆ start_output

haptics_start_output_t haptics_driver_api::start_output

@driver_ops_mandatory Start playback for a haptic effect.

◆ stop_output

haptics_stop_output_t haptics_driver_api::stop_output

@driver_ops_mandatory Stop an ongoing haptic effect and cancel any queued effects, if applicable.

◆ stream_samples

haptics_stream_samples_t haptics_driver_api::stream_samples

@driver_ops_optional Stream 8-bit samples over the control port for haptic effects.


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