SymbX/feedbackd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Document the VibraPattern feedback

Browse Source 
Signed-off-by: Guido Günther <agx@sigxcpu.org>
This commit is contained in:
Guido Günther
2025-03-06 11:00:05 +01:00
parent 7b19feb25f
commit 85c4545adf
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/feedback-themes.rst
+11
View File
@@ -27,6 +27,7 @@ To build a theme you can use several different feedback types:
- `Sound`: Plays a sound from the installed sound theme - `Sound`: Plays a sound from the installed sound theme
- `VibraRumble`: A single rumble using the haptic motor - `VibraRumble`: A single rumble using the haptic motor
- `VibraPeriodic`: A periodic rumble using the haptic motor - `VibraPeriodic`: A periodic rumble using the haptic motor
- `VibraPattern`: A pattern specifying the rumbling of the haptic motor
- `Led`: A LED blinking in a periodic pattern - `Led`: A LED blinking in a periodic pattern
Sound feedback Sound feedback
@@ -42,6 +43,16 @@ The `VibraRumble` feedback uses a single property
- `duration`: The duration of the rumble in ms. - `duration`: The duration of the rumble in ms.
VibraPattern feedback
~~~~~~~~~~~~~~~~~~~~~
The `VibraPattern` feedback has these properties
- `magnitudes`: The relative magnitude of each rumble ``[0, 1]`` as array of doubles.
- `durations`: The durations of each rumble in ms as array of unsigned integers.
Both arrays must have the same length.
LED feedback LED feedback
~~~~~~~~~~~~ ~~~~~~~~~~~~