Switch to using enumerated widget types

Author: tekktrik

displayio_effects/__init__.py

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney for CircuitPython Organization
+#
+# SPDX-License-Identifier: MIT
+# pylint: disable=protected-access
+"""
+`displayio_effects`
+================================================================================
+
+Add the some flair to your widgets!
+
+
+* Author(s): Alec Delaney
+
+Implementation Notes
+--------------------
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+"""
+
+class WidgetType:
+    """Enum values  for customizable widget types"""
+
+    DIAL = 0
+    GAUGE = 1

displayio_effects/fluctuation_effect.py

@@ -22,11 +22,18 @@
 """
 
 import random
+from displayio_effects import WidgetType
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/tekktrik/CircuitPython_Org_DisplayIO_Effects.git"
 
 
+FLUCTUATION_WIDGET_VALUES = {
+    WidgetType.DIAL: "value",
+    WidgetType.GAUGE: "level",
+}
+
+
 @property
 def fluctuation_amplitude(self):
     """The furtherest the fluctuation effect can randomly set the widget value relative
@@ -88,26 +95,31 @@ def update_fluctuation(self):
         self._fluctuation_destination = self._fluctuation_hold_value
 
 
-def hook_fluctuation_effect(widget_class, value_name):
+def hook_fluctuation_effect(widget_class, widget_type):
     """Adds the fluctuation effect for the given class
 
-    :param widget_classes: The widgets that should have this effect hooked
+    :param widget_class: The widget that should have this effect hooked
         into them.
-    :param str value_name: The name of the attribute that sets the "value"
-        for this widget
+    :param int widget_type: The enum value of this widget type, must be a
+        valid ~WidgetType
 
     For example, to hook this into the ``Dial`` widget, you would use the
     following code:
 
     .. code-block:: python
 
         from displayio_dial import Dial
-        from displayio_effects import fluctuation_effect
+        from 
+        from displayio_effects import WidgetType, fluctuation_effect
 
-        fluctuation_effect.hook_fluctuation_effect(Dial, "value")
+        fluctuation_effect.hook_fluctuation_effect(Dial, WidgetType.DIAL)
 
     """
 
+    value_name = FLUCTUATION_WIDGET_VALUES.get(widget_type)
+    if not value_name:
+        raise ValueError("The given widget does not have the ability to use this effect")
+
     setattr(widget_class, "_value_name", value_name)
 
     setattr(widget_class, "_fluctuation_destination", None)