Man page - feedback-themes(5)

Packages contains this manual

Package: feedbackd
apt-get install feedbackd

Manuals in package:

Documentations in package:

feedbackd

Manual

FEEDBACK-THEMES

NAME
DESCRIPTION
FEEDBACK TYPES
Sound feedback
VibraRumble feedback
VibraPattern feedback
LED feedback
See also

NAME

feedback-themes - Theme configuration for feedbackd

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.

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.

For details on how to create or modify feedback themes see feedbackd's documentation at <https://gitlab.freedesktop.org/agx/feedbackd#feedback-theme>

FEEDBACK TYPES

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

Sound feedbacks specify an event name from a XDG sound theme. Sound themes are described in the Sound theme spec at <https://freedesktop.org/wiki/Specifications/sound-theme-spec/>

	•		event-name : The sound event name to use.
	•		media-role : The media role to set played audio stream. Defaults to event .

VibraRumble feedback

The VibraRumble feedback uses a single property

	•		count : The number of rumbles.
	•		pause : The pause between each rumble in ms.
	•		duration : The duration of the rumble in ms.
	•		mangitude : The relative magnitude of the rumble ( [0, 1] ).

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

The Led feedback type uses two properties to specify the way a LED blinks.

	•		color : This specifies the color a LED should blink with. It supports the fixed color names red , green , blue and white as well as values in the RGB HEX format ( #RRGGBB ) where RR , GG and BB are two digit hex value between 00 and FF specifying the value of each component. E.g. #00FFFF corresponds to cyan color.
	•		frequency : The LEDs blinkinig frequency in mHz.