feedbackd: Support visual feedback via LEDs

Currently all LED feedbacks are infinite we can improve that later on by using the 'repeat' attribute of the LED pattern trigger.
2020-07-05 19:25:44 +00:00
parent 2f083ea5ae
commit a5b4f99412
12 changed files with 623 additions and 0 deletions
@@ -0,0 +1,190 @@
+/*
+ * Copyright (C) 2020 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ * Author: Guido Günther <agx@sigxcpu.org>
+ */
+
+#define G_LOG_DOMAIN "fbd-feedback-led"
+
+#include "fbd-enums.h"
+#include "fbd-dev-leds.h"
+#include "fbd-feedback-led.h"
+#include "fbd-feedback-manager.h"
+
+/**
+ * SECTION:fbd-feedback-led
+ * @short_description: Describes a led feedback
+ * @Title: FbdFeedbackLed
+ *
+ * The #FbdFeedbackLed describes a feedback via an LED. It currently
+ * only supports periodic patterns.
+ */
+
+enum {
+  PROP_0,
+  PROP_FREQUENCY,
+  PROP_COLOR,
+  PROP_MAX_BRIGHTNESS,
+  PROP_PRIORITY,
+  PROP_LAST_PROP,
+};
+static GParamSpec *props[PROP_LAST_PROP];
+
+typedef struct _FbdFeedbackLed {
+  FbdFeedbackBase     parent;
+
+  guint               frequency;
+  guint               priority;
+  guint               max_brightness;
+  FbdFeedbackLedColor color;
+} FbdFeedbackLed;
+
+G_DEFINE_TYPE (FbdFeedbackLed, fbd_feedback_led, FBD_TYPE_FEEDBACK_BASE)
+
+static void
+fbd_feedback_led_set_property (GObject      *object,
+                               guint         property_id,
+                               const GValue *value,
+                               GParamSpec   *pspec)
+{
+  FbdFeedbackLed *self = FBD_FEEDBACK_LED (object);
+
+  switch (property_id) {
+  case PROP_FREQUENCY:
+    self->frequency = g_value_get_uint (value);
+    break;
+  case PROP_PRIORITY:
+    self->priority = g_value_get_uint (value);
+    break;
+  case PROP_MAX_BRIGHTNESS:
+    self->max_brightness = g_value_get_uint (value);
+    break;
+  case PROP_COLOR:
+    self->color = g_value_get_enum (value);
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+    break;
+  }
+}
+
+static void
+fbd_feedback_led_get_property (GObject    *object,
+                               guint       property_id,
+                               GValue     *value,
+                               GParamSpec *pspec)
+{
+  FbdFeedbackLed *self = FBD_FEEDBACK_LED (object);
+
+  switch (property_id) {
+  case PROP_FREQUENCY:
+    g_value_set_uint (value, self->frequency);
+    break;
+  case PROP_PRIORITY:
+    g_value_set_uint (value, self->priority);
+    break;
+  case PROP_MAX_BRIGHTNESS:
+    g_value_set_uint (value, self->max_brightness);
+    break;
+  case PROP_COLOR:
+    g_value_set_enum (value, self->color);
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+    break;
+  }
+}
+
+static void
+fbd_feedback_led_run (FbdFeedbackBase *base)
+{
+  FbdFeedbackLed *self = FBD_FEEDBACK_LED (base);
+  FbdFeedbackManager *manager = fbd_feedback_manager_get_default ();
+  FbdDevLeds *dev = fbd_feedback_manager_get_dev_leds (manager);
+
+  g_debug ("Periodic led feeedback: self->max_brightness, self->frequency");
+
+  /* FIXME: handle priority */
+  fbd_dev_leds_start_periodic (dev,
+                               self->color,
+                               self->max_brightness,
+                               self->frequency);
+}
+
+static void
+fbd_feedback_led_end (FbdFeedbackBase *base)
+{
+  FbdFeedbackLed *self = FBD_FEEDBACK_LED (base);
+  FbdFeedbackManager *manager = fbd_feedback_manager_get_default ();
+  FbdDevLeds *dev = fbd_feedback_manager_get_dev_leds (manager);
+
+  fbd_dev_leds_stop (dev, FBD_FEEDBACK_LED_COLOR_BLUE);
+  fbd_feedback_base_done (FBD_FEEDBACK_BASE (self));
+}
+
+static void
+fbd_feedback_led_class_init (FbdFeedbackLedClass *klass)
+{
+  FbdFeedbackBaseClass *base_class = FBD_FEEDBACK_BASE_CLASS (klass);
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->set_property = fbd_feedback_led_set_property;
+  object_class->get_property = fbd_feedback_led_get_property;
+
+  base_class->run = fbd_feedback_led_run;
+  base_class->end = fbd_feedback_led_end;
+
+  props[PROP_FREQUENCY] =
+    g_param_spec_uint (
+      "frequency",
+      "Frequency",
+      "Led event frequency in mHz",
+      0, G_MAXUINT, 0,
+      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
+
+  props[PROP_COLOR] =
+    g_param_spec_enum (
+      "color",
+      "Color",
+      "The LED color",
+      FBD_TYPE_FEEDBACK_LED_COLOR,
+      FBD_FEEDBACK_LED_COLOR_WHITE,
+      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
+
+  /**
+   * FbdFeedbackLed:priority:
+   *
+   * Priority of the led pattern. Led devices can only display a limited
+   * amount of patterns at time. In this case the pattern with the highest
+   * priority wins.
+   */
+  props[PROP_PRIORITY] =
+    g_param_spec_uint (
+      "priority",
+      "Priority",
+      "The LED pattern priority",
+      0, 255, 0,
+      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
+
+  /**
+   * FbdFeedbackLed:max-brightness:
+   *
+   * The maximum brightness in the LED pattern in percent of the LEDs
+   * maximum brightness.
+   */
+  props[PROP_MAX_BRIGHTNESS] =
+    g_param_spec_uint (
+      "max-brightness",
+      "Maximum brightness percentage",
+      "Maximum brightness in the LED pattern",
+      1, 100, 100,
+      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
+
+  g_object_class_install_properties (object_class, PROP_LAST_PROP, props);
+}
+
+static void
+fbd_feedback_led_init (FbdFeedbackLed *self)
+{
+  self->max_brightness = 100;
+}