-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Added labels to legend #7453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added labels to legend #7453
Conversation
@ArduinoBot build this please
✅ Build completed.
Please test this code using one of the following:
⬇️ http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-7453-BUILD-748-linux32.tar.xz
⬇️ http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-7453-BUILD-748-linux64.tar.xz
⬇️ http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-7453-BUILD-748-windows.zip
⬇️ http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-7453-BUILD-748-macosx.zip
⬇️ http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-7453-BUILD-748-linuxarm.tar.xz
i️ The linuxarm
build is still experimental and may not be always available.
jottr
commented
Mar 3, 2019
@facchinm will this be merged at some point?
I think we can merge it, but some documentation must be added too
@facchinm I'm guessing you mean user-targeted documentation rather than just comments in the source code. I completely agree that it's important do document this feature, otherwise the users will not know it's there.
There is some that mentions Serial Plotter, but I don't consider any of this to be a substitute for documentation of the plotter itself:
Built-in examples
- https://github.com/arduino/arduino-examples/blob/main/examples/01.Basics/AnalogReadSerial/AnalogReadSerial.ino
- https://github.com/arduino/arduino-examples/blob/main/examples/01.Basics/ReadAnalogVoltage/ReadAnalogVoltage.ino
Library examples
- https://github.com/arduino/ArduinoCore-samd/blob/master/libraries/I2S/examples/InputSerialPlotter/InputSerialPlotter.ino
- https://github.com/arduino-libraries/ArduinoSound/blob/master/examples/SpectrumSerialPlotter/SpectrumSerialPlotter.ino
- https://github.com/arduino-libraries/ArduinoSound/blob/master/examples/AmplitudeSerialPlotter/AmplitudeSerialPlotter.ino
Library reference
- ArduinoSound
- https://www.arduino.cc/en/Reference/FFTAnalyzerRead
- https://www.arduino.cc/en/Reference/FFTAnalyzerInput
- https://www.arduino.cc/en/Reference/AmpliudeInput
- https://www.arduino.cc/reference/en/libraries/arduinosound/amplitudeanalyzer.available/
- https://www.arduino.cc/reference/en/libraries/arduinosound/fftanalyzer.available/
Hardware
- https://docs.arduino.cc/tutorials/mkr-wifi-1010/connecting-sensors
- https://docs.arduino.cc/tutorials/nano-33-ble/imu_accelerometer
- https://docs.arduino.cc/tutorials/nano-33-ble-sense/imu_accelerometer
- https://docs.arduino.cc/tutorials/nano-33-ble-sense/imu_gyroscope
- https://docs.arduino.cc/tutorials/nano-33-ble-sense/microphone_sensor
- https://docs.arduino.cc/tutorials/nano-33-iot/imu_accelerometer
- https://docs.arduino.cc/tutorials/nano-33-iot/imu_gyroscope
- https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-microphone-basics
Other
- https://www.arduino.cc/en/IoT-Prime/Experiment02
- https://support.arduino.cc/hc/en-us/articles/360021222000
- https://docs.arduino.cc/tutorials/nano-33-ble-sense/get-started-with-machine-learning
- https://edu-content-preview.arduino.cc/content-preview/middle_school/lesson/CONTENTPREVIEW+AESK
I feel that adding a demonstration of the label feature to either of those built-in examples might overly complicate them since they're in the "Basics" section.
It would be more appropriate in the library examples, but that is hiding the label documentation pretty deeply.
I have thought it would be good to provide some formal documentation of the Serial Plotter (arduino/docs-content#668). Where do you envision the documentation of the new label functionality being added? I was thinking the IDE guide was the best place for it, but perhaps the more detailed documentation of the Serial Plotter (allowed delimiters, labels) will be too much for that page and deserves a page of its own, which would be linked to from the summary description of the Serial Plotter on the IDE guide page.
I'm happy to help with this. I would be limited to providing suggested text for the documentation, which would need to be implemented by someone else, since I don't have edit access to the documentation content. Even so, that would take care of some of the job.
Serial plotter surely needs some love, both from the "inline" documentation and from the website doc. We should coordinate with @SimonePDA to find the right spot where these documentation should be added but I really like the way you want to tackle it!
Hi
I have uploaded a small protocol description for the label functionality.
WilhelmWiens@cdd66b6
The legend is right now only shown when there is more than one data set. Should I change that so it is always shown ?
Hi
Thank you for the feedback.
One way to get an arm build is to clone the repository to your am bord and run it from there, but i have newer tried it by myself.
I think it is an good idear to add '|' sign as additional part seperator.
I think the arduino team has do decide what diretion the serialPlotter should take.
Open PR on SerialPlotter
Open issues on SerialPlotter
Regards
Where can I find an ARM Build to test?
@rin67630 assuming you mean 32-bit ARM Linux, it's the last link in the list of builds provided by ArduinoBot:
#7453 (comment)
The only changes made to this PR since that build are the addition of documentation files, so it is functionally identical.
rin67630
commented
Mar 28, 2019
I think it is an good idear to add '|' sign as additional part seperator.
It currently works well with " | " (pipe sign between spaces), no need to write additional code.
If possible, ignoring what is between /* ... */ would have been more useful.
Rebased and manually merged, thanks!
Supports CSV style header and colon separated :.
It is enough to send the label once they are kept until a new label is send.
Multiply values should be separated by space character. : : ...
If can send values only or mixed width labels like this:
: : ...
If you send one value you have to send al values. It will corrupt the visualisation.
!!! NOT ALLOWED !!! : : ...
Labels can be set without sending data:
: : ...
When using the CSV header style you just send space separated. OBS number only headers do not work. they are only allowed with colon separated style.