977c70a6c0
Introduces a haptics API for use with LRA driver ICs to create haptic feedback events. Signed-off-by: Ricardo Rivera-Matos <ricardo.rivera-matos@cirrus.com>
26 lines
734 B
ReStructuredText
26 lines
734 B
ReStructuredText
.. _haptics_api:
|
|
|
|
Haptics
|
|
#######
|
|
|
|
Overview
|
|
********
|
|
|
|
The haptics API allows for the control of haptic driver devices for the
|
|
purposes of performing haptic feedback events.
|
|
|
|
During a haptic feedback event the haptic device drives a signal to an
|
|
actuator. The source of the haptic event signal varies depending on the
|
|
capabilities of the haptic device.
|
|
|
|
Some examples of haptic signal sources are analog signals, preprogrammed
|
|
(ROM) wavetables, synthesized (RAM) wavetables, and digital audio streams.
|
|
|
|
Additionally, haptic driver devices often offer controls for adjusting and
|
|
tuning the drive signal to meet the electrical requirements of their respective
|
|
actuators.
|
|
|
|
API Reference
|
|
*************
|
|
|
|
.. doxygengroup:: haptics_interface
|