This tool listens the serial port and draws the data to matplotlib.
Project description
arduplot
No Serial Plotter for PlatformIO/VSCode ???
The following picture shows the Arduino IDE's serial plotter which plots the data coming through the serial port.
But there is no built-in equivalent tool for the PlatformIO and/or VSCode. Hence arduplot(Arduino Plot) is made to support the equivalent funcitionality.
This tool can be run stand alone with the usage below. This needs to be started in the PIO Terminal Panel, specifically in the PIO bundled python venv.
Usage: arduplot [OPTIONS] [LABELS]...As an example, you can build and run https://github.com/iotlab101/pio_filter_dht22 on an esp8266 and run the following command.Options: -w, --width INTEGER Plotter Width -i, --width INTEGER Plotter Y Axis Min -x, --width INTEGER Plotter Y Axis Max -t, --title TEXT Plotter Title -s, --socket INTEGER TCP Socket Port number -p, --port TEXT Serial Port, a number or a device name -b, --baud INTEGER Set baudrate, default=115200 --help Show this message and exit.
arduplot -p COM5 -t Thermometer -w 100 Temperature Humidity
Here -t Thermometer is the title of the plot chart, -w 100 is the width of the plot, and Temperature and the Humidity are the labels of the plotting data. And you'll see see the plot like this
(And you can plot the data from a TCP connection as well instead of the serial port if you use the -s option. Use the -s option to open and wait on a socket, then feed the data to the socket. The data format should be the same as the Serial port case)
Optional Plot Configuration
There is an optional configuration file where you can set the setting for the plotting for the project. If you create a json file named 'plotcfg.json' under the the PIO project directory, you don't have to pass the parameters every time you invoke the tool.
{ "label": [ "temperature", "humidity" ], "title": "Thermmeter", "width": 100 }
This configuration would be helpful, if you want to run this tool over the TCP port via some other tool where it's not easy to pass-through the setting information.
Installation and Prerequisite
- This plotter uses the following dependancies, and they will be installed when you install this tool..
matplotlib click pyserial
You can install this tool with the pip as follows
pip install arduplot
Running it as part of PlatformIO monitor filter
1. Install the arduplot first
pip install arduplot2. Configure the tool. There are three ways to configure.
- configure every time you create a pio project
- configure your platform wise like esp8266 or esp32
- or you just configure globally by setting an environment variable.
For i), you create a folder 'monitor' under your pio project folder, and copy ~/.platformio/penv/lib/python3.9/site-packages/arduplot/filter_plotter.py script to that folder.
<Project>/monitor
For ii), you create the ~/.platformio/platform/espressif8266/monitor folder and copy ~/.platformio/penv/lib/python3.9/site-packages/arduplot/filter_plotter.py to that folder. If you're using other platform like esp32, then create the ~/.platformio/platform/espressif32/monitor folder and copy to that folder.
~/.platformio/platform/espressif8266/monitor (or ~/.platformio/platform/espressif32/monitor for esp32)
And for iii), you can just set the environment variable as below and run this without copying. For Windows, you set the environment variable as such in the Windows way.
export PLATFORMIO_MONITOR_DIR=${HOME}/.platformio/penv/lib/python3.9/site-packages/arduplot/
3. With the above steps done, run
pio device monitor -f plotterAnd you will get this plot.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.