feedback-themes: Mention the profiles feedback types are used in
Signed-off-by: Guido Günther <agx@sigxcpu.org>
This commit is contained in:
+17
-8
@@ -12,17 +12,19 @@ DESCRIPTION
|
||||
-----------
|
||||
|
||||
The feedback provided to the user for an event is determined by the
|
||||
feedback theme. Each theme consists of up to three profiles (`full`,
|
||||
`quiet` and `silent`) containing event names and their associated
|
||||
feedback.
|
||||
currently active feedback theme.
|
||||
|
||||
Events in the theme are named according to the
|
||||
Each theme consists of up to three profile sections named `full`,
|
||||
`quiet` and `silent` containing event names and their associated
|
||||
feedback. They can reference another theme via the `parent-name`
|
||||
element to avoid repetition.
|
||||
|
||||
The events in the theme are named according to the
|
||||
`Event Naming Specifiaction
|
||||
<https://gitlab.freedesktop.org/agx/feedbackd/-/blob/main/doc/Event-naming-spec-0.0.0.md>`_
|
||||
|
||||
Feedback themes use a JSON format that can be validated with
|
||||
``fbd-theme-validate(1)``. They can include other themes to avoid
|
||||
repetition.
|
||||
``fbd-theme-validate(1)``.
|
||||
|
||||
For details on how to create or modify feedback themes see
|
||||
``feedbackd's documentation`` at https://gitlab.freedesktop.org/agx/feedbackd#feedback-theme
|
||||
@@ -47,6 +49,8 @@ are described in the ``Sound theme spec`` at https://freedesktop.org/wiki/Specif
|
||||
- `event-name`: The sound event name to use.
|
||||
- `media-role`: The media role to set played audio stream. Defaults to `event`.
|
||||
|
||||
`Sound` feedback is usually used in the `full` profile section of the the theme only.
|
||||
|
||||
VibraRumble feedback
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -57,6 +61,8 @@ The `VibraRumble` feedback uses a single property
|
||||
- `duration`: The duration of the rumble in ms.
|
||||
- `mangitude`: The relative magnitude of the rumble (``[0, 1]``).
|
||||
|
||||
`VibraRumble` feedback is usually used in the `quiet` profile section of the the theme only.
|
||||
|
||||
VibraPattern feedback
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -65,9 +71,10 @@ 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.
|
||||
Both arrays must have the same length. `VibraPattern` feedback is
|
||||
usually used in the `quiet` profile section of the the theme only.
|
||||
|
||||
LED feedback
|
||||
Led feedback
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The `Led` feedback type uses two properties to specify the way a LED blinks.
|
||||
@@ -78,6 +85,8 @@ The `Led` feedback type uses two properties to specify the way a LED blinks.
|
||||
each component. E.g. `#00FFFF` corresponds to cyan color.
|
||||
- `frequency`: The LEDs blinkinig frequency in mHz.
|
||||
|
||||
`Led` feedback is usually used in the `silent` profile section of the the theme only.
|
||||
|
||||
See also
|
||||
========
|
||||
|
||||
|
||||
Reference in New Issue
Block a user