adding_bar_example

Author: jposada202020

circuitpython_uplot/ubar.py

@@ -25,6 +25,7 @@
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/CircuitPython_uplot.git"
 
+
 # pylint: disable=too-many-arguments, invalid-name, protected-access
 # pylint: disable=too-few-public-methods, no-self-use, too-many-locals
 class ubar:
@@ -54,9 +55,14 @@ def __init__(
         :param bool projection: creates projection of the bars given them depth.
 
         """
-        self._bar_space = bar_space
-        self._graphx = abs(plot._newxmax - plot._newxmin) // (len(x) + 4)
-        self._graphy = abs(plot._newymax - plot._newymin) // (max(y) + 2)
+        y = [i * plot.scale for i in y]
+        self._bar_space = int(bar_space / plot.scale)
+        self._graphx = plot.scale * int(
+            abs(plot._newxmax - plot._newxmin) / (len(x) + 4)
+        )
+        self._graphy = plot.scale * int(
+            abs(plot._newymax - plot._newymin) / (max(y) + 2)
+        )
         self._new_min = int(plot.transform(0, max(y), max(y), 0, 0))
         self._new_max = int(plot.transform(0, max(y), max(y), 0, max(y)))
 
@@ -70,7 +76,7 @@ def __init__(
                         width=self._graphx,
                         height=self._graphy * y[i],
                         x=xstart + (i * self._graphx),
-                        y=plot._newymin - self._graphy * y[i],
+                        y=int(plot._newymin - self._graphy * y[i] / plot.scale),
                         color_index=plot._index_colorused,
                     )
                 )

circuitpython_uplot/uplot.py

@@ -93,7 +93,7 @@ def __init__(
             print("Defaulting to y=0")
             y = 0
 
-        super().__init__(x=x, y=y, scale=1)
+        super().__init__(x=x, y=y, scale=scale)
 
         self._axesparams = "box"
 

docs/bar_scale.jpg

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
@@ -12,41 +10,28 @@
 
 # -- General configuration ------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
 ]
 
-# Uncomment the below if you use native CircuitPython modules such as
-# digitalio, micropython and busio. List the modules you use. Without it, the
-# autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio", "bitmaptools", "vectorio", "ulab", "terminalio"]
-
 autodoc_preserve_defaults = True
 
-
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
     "ulab": ("https://micropython-ulab.readthedocs.io/en/latest/", None),
 }
 
+autodoc_mock_imports = ["digitalio", "busio", "bitmaptools", "vectorio", "ulab"]
 # Show the docstring from both the class and its __init__() method.
 autoclass_content = "both"
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
 source_suffix = ".rst"
-
-# The master toctree document.
 master_doc = "index"
-
 # General information about the project.
 project = "CircuitPython uplot Library"
 creation_year = "2023"
@@ -68,11 +53,6 @@
 # The full version, including alpha/beta/rc tags.
 release = "1.0"
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = "en"
 
 # List of patterns, relative to source directory, that match files and
@@ -86,22 +66,11 @@
     "CODE_OF_CONDUCT.md",
 ]
 
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#
 default_role = "any"
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#
 add_function_parentheses = True
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
-
 todo_include_todos = False
-
-todo_emit_warnings = True
-
+todo_emit_warnings = False
 napoleon_numpy_docstring = False
 
 # -- Options for HTML output ----------------------------------------------
@@ -136,60 +105,3 @@
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "CircuitPython_Uplot_Librarydoc"
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (
-        master_doc,
-        "CircuitPython_uplot_Library.tex",
-        "CircuitPython uplot Library Documentation",
-        author,
-        "manual",
-    ),
-]
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (
-        master_doc,
-        "CircuitPython_uplot_Library",
-        "CircuitPython uplot Library Documentation",
-        [author],
-        1,
-    ),
-]
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        master_doc,
-        "CircuitPython_uplot_Library",
-        "CircuitPython uplot Library Documentation",
-        author,
-        "CircuitPython_uplot_Library",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]

docs/conf.py

@@ -71,6 +71,17 @@ ubar example
     :lines: 5-
 .. image:: ../docs/uplot_ex8.jpg
 
+Ubar Scale Example
+---------------------
+
+Bar plot example showing how to use the scale
+
+.. literalinclude:: ../examples/uplot_ubar_scale_example.py
+    :caption: examples/uplot_ubar_scale_example.py
+    :lines: 5-
+.. image:: ../docs/bar_scale.jpg
+
+
 Ubar 3D Example
 ----------------
 

docs/examples.rst

@@ -37,7 +37,8 @@ Options available are:
     * backround_color: Allows to change the background color. The default is black.
     * box_color: Allows to change the box color. Default is white.
     * padding: allows the user to give the plot area a pad. This is helpful if you are planning to include text and legends in the axes.
-    * scale: scale of the plot.
+    * scale: scale of the plot. This will allow a plot to be scaled up at a user defined rate. This is currently only available for logging and bar plots.
+
 
 We tell the microcontroller to display our plot:
 

docs/quick_start.rst

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: MIT
+
+import time
+import board
+import displayio
+from circuitpython_uplot.uplot import Uplot
+from circuitpython_uplot.ubar import ubar
+
+# from uplot_examples import u8
+# Setting up the display
+display = board.DISPLAY
+
+# Creating a group to add the two plots
+group = displayio.Group()
+
+# Creating the plot objects
+plot_scale1 = Uplot(0, 0, 100, 100, 1, scale=1)
+plot_scale2 = Uplot(125, 0, 100, 100, 1, scale=2)
+
+# Creating the data
+a = ["a", "b", "c", "d"]
+b = [3, 5, 1, 7]
+
+# Creating the bar plot
+ubar(plot_scale1, a, b, 0xFF1000, True, bar_space=8, xstart=10)
+ubar(plot_scale2, a, b, 0xFF1000, True, bar_space=4, xstart=5)
+
+# Plotting and showing the plot
+group.append(plot_scale1)
+group.append(plot_scale2)
+
+display.show(group)
+
+# Adding some wait time
+while True:
+    time.sleep(1)