serialplotter filter #4058
serialplotter filter #4058
Conversation
|
|
|
Needs some fix, so I'm closing the PR. |
I'm reopening the PR after fixing the cleanup procedure. The usage of this function is as follows. pio device monitor -f serial_plotter And I would like to get some advice on how to get the prereq(https://github.com/yhur/PIOSerialPlotter.git) installed automatically when the user invokes above command for the first time if possible. Thanks. |
For now, I put the preventive code to handle the case the serialPotter is not installed yet by the commit 'handling for the case no serialPlotter installed. |
| def __init__(self, *args, **kwargs): | ||
| super(SerialPlotter, self).__init__(*args, **kwargs) | ||
| self.buffer = '' | ||
| self.plotter_py = os.path.expanduser('~') + '/.platformio/packages/tool-serialplotter/serialPlotter.py' |
There was a problem hiding this comment.
Will this work for Windows users? Better not use os.path.join() to concatenate paths?
There was a problem hiding this comment.
Hi @maxgerhardt ,
Thank you for the suggestion. I'll modify the code on my branch for this.
There was a problem hiding this comment.
Oh, in fact it can't be assumed that PlatformIO is even installed in that path since it can be arbitrary. You should use get_project_core_dir() per
(from platformio.project.helpers import get_project_core_dir)
There was a problem hiding this comment.
Great! Actually that's what I really needed. Thanks.
There was a problem hiding this comment.
By the way, since I started changing the serialPlotter tool itself after getting @ivankravets's advice, I may change some part of this filter to take the tools modification. And I may work on it this Weekend. So let's continue this thread early next week. Thanks.
There was a problem hiding this comment.
Hi @ivankravets and @maxgerhardt ,
I reworked the serialplotter python command and it’s renamed to arduplot taking @ivankravets idea of naming.
Github repo → https://github.com/yhur/arduplot
- And I pushed it to pypi.org, so it can be installed with pip.
- this serial_plotter filter is also updated.
Would you take a look and give me your feedback for the merge?
|
This needs the help of @ivankravets to integrate and auto-install your suggested |
yes @maxgerhardt , I had a talk with @ivankravets already, and am working on my tool-serialplotter as a pip-installable. I will come back to you and him after working on that too. Thanks. |
|
Hi @ivankravets and @maxgerhardt, When researched other packages like ‘twine’, it installs twine.exe for Windows while twine python script for MacOS/Linux. So I think I need to make ‘arduplot’ as ‘arduplot.exe’ for Windows, but don’t know how to do it. Could you help on this or give me some pointers to refer and to learn? Thanks. |
|
Hi @ivankravets and @maxgerhardt, As an alternative resolution to the 'arduplot' command for Windows, I wrapped it with 'arduplot.cmd' batch script. |
| if sys.platform == 'win32': | ||
| self.arduplot = os.path.join(pio_root, 'penv', 'Scripts' , self.arduplot + '.cmd') | ||
| else: | ||
| self.arduplot = os.path.join(pio_root, 'penv', 'bin' , self.arduplot) | ||
|
|
||
| if not os.path.isfile(self.arduplot): |
There was a problem hiding this comment.
You don't need to call arduplot via subprocess and depend on the physical files. Please import arduplot directly as a module
import subprocess
from platformio import proc
try:
from arduplot import main as arduplot_main
except ImportError:
args = [proc.get_pythonexe_path(), "-m", "pip", "install", "--upgrade", "arduplot"]
subprocess.call(args)
from arduplot import main as arduplot_main
arduplot_main(**kwargs)Please note that you will need to split code in https://github.com/yhur/arduplot/blob/main/src/arduplot/plotserialdata.py#L57
For example, keep function main without any changes and create a new one:
@click...
def cli(**kwargs):
arduplot_main(**kwargs)P.S: I didn't test this code. Just gave you a few ideas where to move further. Thanks!
See
There was a problem hiding this comment.
Thank you for your review.
The reason I call arduplot via subprocess is to use the monitor feature's serial printing as well while plotting.
Please take a look at the video.
And regarding creating an additional function, could you please tell me what that means or any link that explains the 'cli' function? Like what it does in addition to the main and so on. Sorry I'm new to click.
My.Movie.1.mp4
|
We finally implemented custom device monitor filters. See docs https://docs.platformio.org/en/latest/core/userguide/device/cmd_monitor.html#custom-filters So, let's move this discussion to yhur/arduplot#2 |
I'm publishing a package called serialPlotter which the serial data just like the Arduino IDE's serial plotter.
And this pull request is an addition of new pio device monitor filter that invokes the serialPlotter so that the PIO developers can have the Arduino IDE's serial plotter equivalent.
Regards,