Skip to content

Commit 163afec

Browse files
committed
updating docs
1 parent fed2ee9 commit 163afec

File tree

4 files changed

+29
-2
lines changed

4 files changed

+29
-2
lines changed

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ For detailed view of the library please refer to the `Quick start guide <https:/
2121
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/readme2.png
2222

2323

24+
Below a picture oa a real live application. for more information visit the project `page <https://github.com/casainho/temperature_humidity_sensor_eink_display>`_. Thanks to @Casainho
25+
26+
.. image:: https://github.com/jposada202020/CircuitPython_uplot/blob/main/docs/logging.png
27+
28+
2429
Dependencies
2530
=============
2631
This library depends on:

docs/logging.png

3.07 MB
Loading

docs/logging.png.license

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
SPDX-FileCopyrightText: 2023 Casainho
2+
3+
SPDX-License-Identifier: MIT

docs/quick_start.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,19 +377,38 @@ Logging
377377
===============
378378

379379
This is a similar to Cartesian but designed to allow the user to use it as a data logger.
380-
The user needs to setup manually the range and tick values in order for this graph to work proeprly
380+
The user needs to manually set up the range and tick values in order for this graph to work properly
381381

382382
There are some parameters that you can customize:
383383

384384
* rangex and rangey: you need specify the ranges of your graph. This allows you to move your graph according to your needs. This parameters only accept lists
385385
* ticksx and ticksy: Specific ticks for the X and Y axes
386386
* line_color: you can specify the color in HEX
387387
* tick_pos: Allows to show the ticks below the axes.
388-
* fill: genrates lines under each point, to fill the area under the points
388+
* fill: generates lines under each point, to fill the area under the points
389389

390390

391391
.. code-block:: python
392392
393393
plot = Uplot(0, 0, display.width, display.height)
394394
395395
ulogging(plot, x, y, rangex=[0, 200], rangey=[0, 100], ticksx=[10, 50, 80, 100], ticksy=[15, 30, 45, 60],)
396+
397+
===============
398+
SVG
399+
===============
400+
401+
A small module to load, locate and scale svg path collection of points in the plot area. This will tend to be memory consuming as some SVG will have several path points.
402+
There are some pre-provided icons in the ``icons.py`` file, you could add more if needed.
403+
Specific icons are stored as a dictionary in the icons.py file. Every path is a entry in the dictionary.
404+
For example, if you want to load the Temperature icon with a scale of 2
405+
406+
.. code-block:: python
407+
408+
from circuitpython_uplot.usvg import usvg
409+
from circuitpython_uplot.icons import Temperature
410+
411+
display = board.DISPLAY
412+
plot = Uplot(0, 0, display.width, display.height)
413+
usvg(plot, Temperature, 250, 50, 2)
414+
display.show(plot)

0 commit comments

Comments
 (0)