From ed523e8755dcb4ab2bf9696aa2fd4590d9703cab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Date: Thu, 1 Dec 2022 12:11:47 +0100
Subject: [PATCH] data: Add key press/release events
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

While we have "button-{pressed,released}" events there's often the
desire to control sound for key presses of e.g. on screen keyboards too.
Add separate events for that.

This allows us to e.g. add a particular sound for OSK key presses and
OSKs can send this with an `important` hint so they're also usable
in silent mode.

Closes: https://gitlab.freedesktop.org/agx/feedbackd/-/issues/85
Signed-off-by: Guido Günther <agx@sigxcpu.org>
---
 data/default.json              | 21 +++++++++++++++++++++
 doc/Event-naming-spec-0.0.0.md |  2 ++
 2 files changed, 23 insertions(+)

diff --git a/data/default.json b/data/default.json
index f1a4c40..ffc51e1 100644
--- a/data/default.json
+++ b/data/default.json
@@ -29,6 +29,16 @@
           "type"       : "Sound",
           "effect"     : "camera-shutter"
         },
+        {
+          "event-name" : "key-pressed",
+          "type"       : "Sound",
+          "effect"     : "key-pressed"
+        },
+        {
+          "event-name" : "key-released",
+          "type"       : "Sound",
+          "effect"     : "key-released"
+        },
         {
           "event-name" : "message-new-cellbroadcast",
           "type"       : "Sound",
@@ -116,6 +126,17 @@
           "type"       : "VibraRumble",
           "duration"   : 12
         },
+        {
+          "event-name" : "key-pressed",
+          "type"       : "VibraPattern",
+          "magnitudes" : [ 0.2 ],
+          "durations"  : [ 7 ]
+        },
+        {
+          "event-name" : "key-released",
+          "type"       : "VibraRumble",
+          "duration"   : 12
+        },
         {
           "event-name" : "message-new-cellbroadcast",
           "type"       : "VibraPattern",
diff --git a/doc/Event-naming-spec-0.0.0.md b/doc/Event-naming-spec-0.0.0.md
index cf2c435..3f68c27 100644
--- a/doc/Event-naming-spec-0.0.0.md
+++ b/doc/Event-naming-spec-0.0.0.md
@@ -109,6 +109,8 @@ These events are meant to be used by system components.
 - *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.
 - *device-added*: The event used when a device has become available to the desktop, i.e. due to USB plugging.
+- *key-pressed*: The event used when a key on e.g. an on screen keyboard is pressed.
+- *key-released*: The event used when a key on e.g. an on screen keyboard is released.
 - *message-missed-notification*: The event used when a notification was shown but not seen by the user. (*deprecated*)
 - *message-new-cellbroadcast*: The event used when a new cell broadcast message is received.
 - *notification-missed-generic*: The event used when a generic notification was