adding logging line_limits

Author: jposada202020

circuitpython_uplot/logging.py

@@ -14,7 +14,7 @@
 
 """
 try:
-    from typing import Union
+    from typing import Union, Optional
     from circuitpython_uplot.plot import Plot
 except ImportError:
     pass
@@ -42,6 +42,8 @@ def __init__(
         ticksy: Union[np.array, list] = np.array([0, 10, 30, 50, 70, 90]),
         tick_pos: bool = False,
         fill: bool = False,
+        limits: Optional[list] = None,
+        limits_color: int = 0xFF0000,
     ) -> None:
         """
 
@@ -70,11 +72,22 @@ def __init__(
 
         plot._plot_palette[plot._index_colorused] = line_color
 
+        self._line_index = plot._index_colorused
+
         self.xmin = rangex[0]
         self.xmax = rangex[1]
         self.ymin = rangey[0]
         self.ymax = rangey[1]
 
+        if limits is not None:
+            self._limits = np.array(
+                plot.transform(
+                    self.ymin, self.ymax, plot._newymin, plot._newymax, np.array(limits)
+                ),
+                dtype=np.int16,
+            )
+            plot._plot_palette[9] = limits_color
+
         self.draw_points(plot, x, y, fill)
 
         if plot._showticks:
@@ -186,7 +199,7 @@ def draw_new_lines(self, plot: Plot, x: list, y: list, fill: bool = False) -> No
                     ynorm[index],
                     xnorm[index + 1],
                     ynorm[index + 1],
-                    plot._index_colorused,
+                    self._line_index,
                 )
             if fill:
                 for index, _ in enumerate(xnorm):
@@ -196,5 +209,23 @@ def draw_new_lines(self, plot: Plot, x: list, y: list, fill: bool = False) -> No
                         ynorm[index],
                         xnorm[index],
                         plot._newymin,
-                        plot._index_colorused,
+                        self._line_index,
                     )
+
+    def _draw_limit_lines(self, plot: Plot) -> None:
+        draw_line(
+            plot._plotbitmap,
+            plot._newxmin,
+            self._limits[0],
+            plot._newxmax,
+            self._limits[0],
+            9,
+        )
+        draw_line(
+            plot._plotbitmap,
+            plot._newxmin,
+            self._limits[1],
+            plot._newxmax,
+            self._limits[1],
+            9,
+        )

docs/examples.rst

@@ -309,6 +309,16 @@ This example shows how to animate a plot
     :caption: examples/logging_animation.py
     :lines: 5-
 
+Logging Animation Example
+---------------------------------------
+
+This example shows how to add limits to our plot
+
+.. literalinclude:: ../examples/logging_limits.py
+    :caption: examples/logging_limits.py
+    :lines: 5-
+.. image:: ../docs/logging_limits.jpg
+
 SVG Images examples
 ---------------------------
 

docs/logging_limits.jpg

@@ -0,0 +1,91 @@
+# SPDX-FileCopyrightText: Copyright (c) Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+
+import time
+import random
+import board
+from circuitpython_uplot.plot import Plot, color
+from circuitpython_uplot.logging import Logging
+
+# Setting up the display
+display = board.DISPLAY
+display.auto_refresh = False
+
+# Drawing the graph
+my_plot = Plot(
+    140,
+    60,
+    200,
+    200,
+    padding=1,
+    show_box=True,
+    box_color=color.WHITE,
+)
+
+# Setting the tick parameters
+my_plot.tick_params(
+    tickx_height=4,
+    ticky_height=4,
+    show_ticks=True,
+    tickcolor=color.TEAL,
+    showtext=True,
+)
+
+# Creating the x and y data
+x = [
+    10,
+    20,
+    30,
+    40,
+    50,
+    60,
+    70,
+    80,
+    90,
+    100,
+    110,
+    120,
+    130,
+    140,
+    150,
+    160,
+    170,
+    180,
+    190,
+]
+y = [26, 32, 34, 30, 28, 35, 46, 65, 37, 23, 40, 27, 26, 36, 44, 53, 69, 27, 26]
+
+# Creating the random numbers
+random_numbers = [32, 34, 45, 65, 24, 40, 18, 27]
+
+
+display.show(my_plot)
+display.refresh()
+
+dist = 1
+
+# Creating the loggraph
+my_loggraph = Logging(
+    my_plot,
+    x[0:dist],
+    y[0:dist],
+    rangex=[0, 210],
+    rangey=[0, 110],
+    line_color=color.BLUE,
+    ticksx=[25, 50, 75, 100, 125, 150, 175, 200],
+    ticksy=[25, 50, 75, 100],
+    limits=[30, 60],
+)
+
+# Showing the loggraph
+for i in range(45):
+    if dist > len(x):
+        y.pop(0)
+        y.append(random.choice(random_numbers))
+
+    my_loggraph.draw_points(my_plot, x[0:dist], y[0:dist])
+    display.refresh()
+    dist += 1
+    time.sleep(0.5)