Updated docs and included figures and licesne files, add simpletest example

Author: kmatch98

adafruit_displayio_layout/widgets/dial.py

@@ -91,6 +91,50 @@ class Dial(Widget):
      anchor point relative to the dial's bounding box
     :param (int,int) anchored_position: (x,y) pixel value for the location
      of the `anchor_point`
+
+
+    **Simple example of dial and moving needle**
+
+    See file: ``examples/displayio_layout_dial_simpletest.py``
+
+
+
+    .. figure:: dial.gif
+       :scale: 100 %
+       :figwidth: 50%
+       :align: center
+       :alt: Diagram of the dial widget with needle in motion.
+
+       This is a diagram of a dial widget with the needle moving from its
+       minimum to maximum positions.
+
+    .. figure:: dial_variables_angles.png
+       :scale: 50 %
+       :figwidth: 70%
+       :align: center
+       :alt: Diagram showing the definition of ``start_angle`` and ``sweep_angle``,
+        both are in units of degrees.
+
+       Diagram showing the definition of ``start_angle`` and ``sweep_angle``,
+       both are in units of degrees.
+
+    .. figure:: dial_variables_min_max_values.png
+       :scale: 50 %
+       :figwidth: 70%
+       :align: center
+       :alt: Diagram showing the defintion of ``min_value`` and ``max_value``.
+
+       Diagram showing the defintion of ``min_value`` and ``max_value``.
+
+    .. figure:: dial_variables_ticks.png
+       :scale: 50 %
+       :figwidth: 70%
+       :align: center
+       :alt: Diagram showing the various parameters for setting the dial labels
+        and major and minor tick marks.
+
+       Diagram showing the various parameters for setting the dial labels
+       and major and minor tick marks.
     """
 
     # The dial is a subclass of Group->Widget.
@@ -243,7 +287,7 @@ def _initialize_dial(self, width, height):
             tick_length=self._major_tick_length,
             start_angle=self._start_angle,
             sweep_angle=self._sweep_angle,
-            tick_color_index=1,
+            tick_color_index=2,
         )
 
         draw_ticks(  # minor ticks
@@ -255,7 +299,7 @@ def _initialize_dial(self, width, height):
             tick_length=self._minor_tick_length,
             start_angle=self._start_angle,
             sweep_angle=self._sweep_angle,
-            tick_color_index=1,
+            tick_color_index=2,
         )
 
         draw_labels(
@@ -278,8 +322,8 @@ def _initialize_dial(self, width, height):
             self.dial_palette[0] = 0x000000
         else:
             self.dial_palette[0] = self._background_color
-        self.dial_palette[1] = self._tick_color
-        self.dial_palette[2] = self._tick_label_color
+        self.dial_palette[1] = self._tick_label_color
+        self.dial_palette[2] = self._tick_color
 
         # create the dial tilegrid and append to the self Widget->Group
         self.dial_tilegrid = displayio.TileGrid(
@@ -593,7 +637,7 @@ def draw_ticks(
     tick_length,
     start_angle,
     sweep_angle,
-    tick_color_index=1,
+    tick_color_index=2,
 ):
     """Helper function for drawing ticks on the dial widget.  Can be used to
     customize the dial face.

docs/dial.gif

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2021 Kevin Matocha
+
+SPDX-License-Identifier: MIT

docs/dial.gif.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2021 Kevin Matocha
+
+SPDX-License-Identifier: MIT

docs/dial_variables_angles.png

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2021 Kevin Matocha
+
+SPDX-License-Identifier: MIT

docs/dial_variables_angles.png.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2021 Kevin Matocha
+
+SPDX-License-Identifier: MIT

docs/dial_variables_min_max_values.png

@@ -8,16 +8,13 @@
 import time
 import board
 import displayio
+import terminalio
 from adafruit_displayio_layout.widgets.dial import Dial
 
 from adafruit_bitmap_font import bitmap_font
 
-glyphs = "0123456789"
-
 # Fonts used for the Dial tick labels
-tick_font_file = "fonts/BitstreamVeraSans-Bold-16.pcf"
-tick_font = bitmap_font.load_font(tick_font_file)
-tick_font.load_glyphs(glyphs)
+tick_font = terminalio.FONT
 
 display = board.DISPLAY  # create the display on the PyPortal or Clue (for example)
 # otherwise change this to setup the display
@@ -39,7 +36,8 @@
     sweep_angle=240,  # total sweep angle of 240 degrees
     min_value=minimum_value,  # set the minimum value shown on the dial
     max_value=maximum_value,  # set the maximum value shown on the dial
-    tick_label_font=tick_font,  #
+    tick_label_font=tick_font,  # the font used for the tick labels
+    tick_label_scale=2.0, # the scale factor for the tick label font
 )
 
 my_group = displayio.Group(max_size=1)