From 85c4545adfe1a260e8b3fd408fb8fe1b2a8a37a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Sat, 1 Mar 2025 23:20:27 +0100 Subject: [PATCH] doc: Document the `VibraPattern` feedback MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Guido Günther --- doc/feedback-themes.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/feedback-themes.rst b/doc/feedback-themes.rst index 7490847..12c583d 100644 --- a/doc/feedback-themes.rst +++ b/doc/feedback-themes.rst @@ -27,6 +27,7 @@ To build a theme you can use several different feedback types: - `Sound`: Plays a sound from the installed sound theme - `VibraRumble`: A single 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 Sound feedback @@ -42,6 +43,16 @@ The `VibraRumble` feedback uses a single property - `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 ~~~~~~~~~~~~