adding pictures and integration example

Author: jposada202020

README.rst

@@ -15,7 +15,10 @@ Introduction
     :target: https://github.com/psf/black
     :alt: Code Style: Black
 
-framework to display different plots in displayio. similar to widget
+Framework to display different plots in displayio. Similar to widget
+Take a look in the examples section in RTD to see the gallery.
+
+.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/uplot_ex4.jpg
 
 
 Dependencies
@@ -32,9 +35,6 @@ or individual libraries can be installed using
 
 =====================
 
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/circuitpython-uplot/>`_.
 To install for current user:

docs/examples.rst

@@ -7,6 +7,8 @@ Ensure your device works with this simple test.
     :caption: examples/uplot_simpletest.py
     :linenos:
 
+.. image:: ../docs/uplot_ex1.jpg
+
 Plot Example
 -------------
 
@@ -16,11 +18,25 @@ Pot some data for x and y
     :caption: examples/uplot_plot_example.py
     :linenos:
 
+.. image:: ../docs/uplot_ex4.jpg
+
 Tick Parameters Settings Example
 ----------------------------------
 
-Settting up the ticks parameters
+Setting up the ticks parameters
 
 .. literalinclude:: ../examples/uplot_tickparameters.py
     :caption: examples/uplot_tickparameters.py
     :linenos:
+
+.. image:: ../docs/uplot_ex3.jpg
+
+Integration Example
+-------------------
+
+Example showing different graphcals elements integration
+
+.. literalinclude:: ../examples/uplot_integration_example.py
+    :caption: examples/uplot_integration_example.py
+    :linenos:
+.. image:: ../docs/uplot_ex5.jpg

docs/uplot_ex1.jpg

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Jose David M.
+
+SPDX-License-Identifier: MIT

docs/uplot_ex1.jpg.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Jose David M.
+
+SPDX-License-Identifier: MIT

docs/uplot_ex3.jpg

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Jose David M.
+
+SPDX-License-Identifier: MIT

docs/uplot_ex3.jpg.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Jose David M.
+
+SPDX-License-Identifier: MIT

docs/uplot_ex4.jpg

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: Unlicense
+
+import board
+from ulab import numpy as np
+from uhistogram import Histogram
+from uplot import Uplot
+
+
+# Setting Up the histogram
+data = [5, 4, 3, 2, 7, 5, 3, 3, 3, 3, 2, 9, 7, 6]
+my_box = Histogram(data, x=50, y=50, width=100, height=100)
+my_box.draw()
+
+# Setting up the display
+display = board.DISPLAY
+
+# Adding the plot area
+plot = Uplot(0, 0, display.width, display.height)
+
+# Seeting some date to plot
+x = np.linspace(-4, 4, num=50)
+constant = 1.0 / np.sqrt(2 * np.pi)
+y = constant * np.exp((-(x**2)) / 2.0)
+
+# Plotting and showing the plot
+plot.draw_plot(x, y)
+plot.append(my_box)
+
+# Adding a circle
+plot.draw_circle(radius=8, x=120, y=120)
+
+# Showing in the screen
+display.show(plot)
+
+while True:
+    pass

docs/uplot_ex4.jpg.license

@@ -14,7 +14,7 @@
 plot = Uplot(0, 0, display.width, display.height)
 
 # Setting up tick parameters
-plot.tick_params(tickheight=12, tickcolor=0xFF00FF)
+plot.tick_params(tickheight=12, tickcolor=0xFF00FF, tickgrid=True)
 
 # Seeting some date to plot
 x = np.linspace(-4, 4, num=50)

docs/uplot_ex5.jpg

@@ -52,6 +52,7 @@ def __init__(self, x=0, y=0, width=None, height=None, padding=15):
         self._tickheight = 8
         self._tickcolor = 0xFFFFFF
         self._showticks = False
+        self._tickgrid = False
 
         self._width = width
         self._height = height
@@ -178,16 +179,12 @@ def _draw_ticks(self, x, y):
 
         """
         ticks = np.array([10, 30, 50, 70, 90])
-        subticks = np.array([20, 40, 60, 80, 100])
-        ticksxnorm = np.array(self.normalize(10, 100, np.min(x), np.max(x), ticks))
-        ticksynorm = np.array(self.normalize(10, 100, np.min(y), np.max(y), ticks))
+        subticks = np.array([20, 40, 60, 80])
+        ticksxnorm = np.array(self.normalize(0, 100, np.min(x), np.max(x), ticks))
+        ticksynorm = np.array(self.normalize(0, 100, np.min(y), np.max(y), ticks))
 
-        subticksxnorm = np.array(
-            self.normalize(10, 100, np.min(x), np.max(x), subticks)
-        )
-        subticksynorm = np.array(
-            self.normalize(10, 100, np.min(y), np.max(y), subticks)
-        )
+        subticksxnorm = np.array(self.normalize(0, 100, np.min(x), np.max(x), subticks))
+        subticksynorm = np.array(self.normalize(0, 100, np.min(y), np.max(y), subticks))
 
         ticksxrenorm = np.array(
             self.normalize(
@@ -251,16 +248,66 @@ def _draw_ticks(self, x, y):
                 2,
             )
 
-    def tick_params(self, tickheight=8, tickcolor=0xFFFFFF):
+        if self._tickgrid:
+            self._draw_gridx(ticksxrenorm)
+            self._draw_gridy(ticksyrenorm)
+
+    def tick_params(self, tickheight=8, tickcolor=0xFFFFFF, tickgrid=False):
         """
         Function to set ticks parameters
 
         :param tickheight:
         :param tickcolor:
-        :return:
+
+        :return: None
 
         """
 
         self._showticks = True
         self._tickheight = tickheight
         self._plot_palette[2] = tickcolor
+        self._tickgrid = tickgrid
+
+    def _draw_gridx(self, ticks_data):
+        """
+        draw plot grid
+
+        :return: None
+
+        """
+        grid_espace = 10
+        line_lenght = 10
+        for tick in ticks_data:
+            start = self._newymin
+            while start >= self._newymax:
+                draw_line(
+                    self._plotbitmap,
+                    tick,
+                    start,
+                    tick,
+                    start - line_lenght,
+                    2,
+                )
+                start = start - grid_espace - line_lenght
+
+    def _draw_gridy(self, ticks_data):
+        """
+        draw plot grid
+
+        :return: None
+
+        """
+        grid_espace = 10
+        line_lenght = 10
+        for tick in ticks_data:
+            start = self._newxmin
+            while start <= self._newxmax:
+                draw_line(
+                    self._plotbitmap,
+                    start,
+                    tick,
+                    start + line_lenght,
+                    tick,
+                    2,
+                )
+                start = start + grid_espace + line_lenght