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

Merge branch 'notifications' into 'main'

Browse Source 
Expand description of notifications events and a an event for new notifications

See merge request Librem5/feedbackd!144
This commit is contained in:
Guido Günther
2024-10-02 13:05:36 +00:00
parent 245083d82c f629ef431c
commit f5c27d5521
2 changed files with 46 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
data/default.json
+6
View File
@@ -203,6 +203,12 @@
"color" : "blue", "color" : "blue",
"frequency" : 2000 "frequency" : 2000
}, },
{
"event-name" : "notification-missed-generic",
"type" : "Led",
"color" : "blue",
"frequency" : 500
},
{ {
"event-name" : "phone-missed-call", "event-name" : "phone-missed-call",
"type" : "Led", "type" : "Led",
doc/Event-naming-spec-0.0.0.md
+40 -35
View File
@@ -23,7 +23,7 @@ The list of default contexts for the feedback theme are:
- Notifications: Events to trigger feedback to notify the user that - Notifications: Events to trigger feedback to notify the user that
the system, or their current use case has changed state in some way, the system, or their current use case has changed state in some way,
e.g. new email arriving e.g. new email arriving
- Actions: Event that notify the user on their actions. - Actions: Event that notify the user on their actions.
- Input Event: This triggers feedbacks that give direct response to - Input Event: This triggers feedbacks that give direct response to
input events from the user, such as key presses on an on screen input events from the user, such as key presses on an on screen
keyboard keyboard
@@ -61,62 +61,67 @@ These events are meant to be used by applications.
#### Notifications #### Notifications
- camera-focus: The event used when the camera got focus. - *camera-focus*: The event used when the camera got focus.
- camera-shutter: The event used when a photo was taken. - *camera-shutter*: The event used when a photo was taken.
- message-new-instant: The event used when a new IM is received. - *message-new-instant*: The event used when a new IM is received.
- message-new-sms: The event used when a new sms is received. - *message-new-sms*: The event used when a new sms is received.
- message-new-email: The event used when a new email is received. - *message-new-email*: The event used when a new email is received.
- message-missed-email: The event used when an email was received but not seen by the user. - *message-missed-email*: The event used when an email was received but not seen by the user.
- message-missed-instant: The event used when a instant message was received but not seen by the user. - *message-missed-instant*: The event used when a instant message was received but not seen by the user.
- message-missed-notification: The event used when a notification was shown but not seen by the user. - *message-missed-sms*: The event used when a sms message was received but not seen by the user.
- message-missed-sms: The event used when a sms message was received but not seen by the user. - *phone-incoming-call*: The event used when a phone/voip call is coming in.
- phone-incoming-call: The event used when a phone/voip call is coming in. - *phone-missed-call*: The event used when a phone/voip call is was incoming but not answered.
- phone-missed-call: The event used when a phone/voip call is was incoming but not answered. - *phone-outgoing-busy*: The event used when for outgoing phone/voip call when the responder is busy/not available.
- phone-outgoing-busy: The event used when for outgoing phone/voip call when the responder is busy/not available. - *phone-hangup*: The event used when a phone/voip call is hung up.
- phone-hangup: The event used when a phone/voip call is hung up. - *phone-failure*: The event used when a phone/voip call is terminated because of a failure.
- phone-failure: The event used when a phone/voip call is terminated because of a failure. - *alarm-clock-elapsed*: A user configured alarm elapsed.
- alarm-clock-elapsed: A user configured alarm elapsed. - *timeout-completed*: A user configured timeout completed (e.g. a stop watch).
- timeout-completed: A user configured timeout completed (e.g. a stop watch).
#### Actions #### Actions
- message-sent-instant: The sound used when a new IM is sent. - *message-sent-instant*: The sound used when a new IM is sent.
#### Input Events #### Input Events
- button-pressed: The event used when a button is pressed. - *button-pressed*: The event used when a button is pressed.
- button-released: The event used when a button is released. - *button-released*: The event used when a button is released.
### System Components ### System Components
These events are meant to be used by applications. These events are meant to be used by system components.
### Actions #### Actions
- bell-terminal: The sound to use as a terminal bell. - *bell-terminal*: The sound to use as a terminal bell.
- screen-capture: A screenshot was made - *screen-capture*: A screenshot was made
- theme-demo: A event that should be played for demoing this theme. Usually - *theme-demo*: A event that should be played for demoing this theme. Usually
this should just be an alias for a very representative sound (such as this should just be an alias for a very representative sound (such as
a incoming phone call) of a theme that would work nicely as a demo event for a incoming phone call) of a theme that would work nicely as a demo event for
a theme in the theme selector dialog. a theme in the theme selector dialog.
### Alerts #### Alerts
- battery-low: The Event used when the battery is low (below 20%, for example). - battery-low: The Event used when the battery is low (below 20%, for example).
- power-unplug-battery-low: The power cable has been unplugged and the battery level is low. - power-unplug-battery-low: The power cable has been unplugged and the battery level is low.
### Notifications #### Notifications
- battery-caution: The event used when the battery is nearing exhaustion (below 40%, for example). - *battery-caution*: The event used when the battery is nearing exhaustion (below 40%, for example).
- battery-full: The event used when the battery is fully loaded up. - *battery-full*: The event used when the battery is fully loaded up.
- device-added: The event used when a device has become available to the desktop, i.e. due to USB plugging. - *device-added*: The event used when a device has become available to the desktop, i.e. due to USB plugging.
- message-new-cellbroadcast: The event used when a new cell broadcast message is received. - *message-new-cellbroadcast*: The event used when a new cell broadcast message is received.
- power-plug: The power cable has been plugged in. - *power-plug*: The power cable has been plugged in.
- power-unplug: The power cable has been unplugged. - *power-unplug*: The power cable has been unplugged.
- *message-missed-notification*: The event used when a notification was shown but not seen by the user. (*deprecated*)
- *notification-missed-generic*: The event used when a generic notification was
shown but not seen by the user. This event is usually only used by
the notification server.
- *notification-new-generic*: The event used when a generic notification
is shown to the user. This event is usually only used by the
notification server.
#### Input Events #### Input Events
- window-close: The sound used when an existing window is closed. - window-close: The sound used when an existing window is closed.
[Sound naming spec]: http://0pointer.de/public/sound-naming-spec.html [Sound naming spec]: http://0pointer.de/public/sound-naming-spec.html