Skip to content
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

Closed
wants to merge 3 commits into from

Conversation

@chromhelm
Copy link
Contributor

commented Apr 10, 2018

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.

@facchinm

This comment has been minimized.

Copy link
Member

commented Apr 11, 2018

@ArduinoBot build this please

@jottr

This comment has been minimized.

Copy link

commented Mar 3, 2019

@facchinm will this be merged at some point?

@facchinm facchinm added this to the Release 1.8.9 milestone Mar 4, 2019
@facchinm

This comment has been minimized.

Copy link
Member

commented Mar 4, 2019

I think we can merge it, but some documentation must be added too

@per1234

This comment has been minimized.

Copy link
Collaborator

commented Mar 4, 2019

@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.

My understanding is that the Serial Plotter is only documented via the following examples:

and the following library examples (and their associated tutorials:

and this ArduinoSound library reference example:

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 (#5651). 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.

@facchinm

This comment has been minimized.

Copy link
Member

commented Mar 4, 2019

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!

@chromhelm

This comment has been minimized.

Copy link
Contributor Author

commented Mar 5, 2019

Hi
I have uploaded a small protocol description for the label functionality.
chromhelm@cdd66b6

@chromhelm

This comment has been minimized.

Copy link
Contributor Author

commented Mar 5, 2019

The legend is right now only shown when there is more than one data set. Should I change that so it is always shown ?

@rin67630

This comment has been minimized.

Copy link

commented on cdd66b6 Mar 16, 2019

Thank you for the description.
Your following sentence ist hard to understand:
"There is a special case, the CSV header style: Label1 , Label 2 ... Label n \n
But in this format labels are only numbers are not recognised. It safer to just use the normal label
only message."

You probably mean:
"There is a special case, the CSV header style: Label1 , Label 2 ... Label n \n
But in this format, labels consisting of pure numbers are not recognised.
It safer to just use the normal label only message."

Anyhow providing coding examples is always useful.

By the way "[space]|[space]" is also a valid separator, which draws nice tables when printed.

Where can I find an ARM Build to test?
Regards

This comment has been minimized.

Copy link

replied Mar 16, 2019

P.S. If you are active in developing for the SerialPlotter, you might find also a "comment marker" useful.
If the plotter parser would ignore everything that is e.g. enclosed between /* */ markers (like programming comments) we could make reports that fits plotting and monitoring altogether containing non periodical numeric data that will just be ignored by the plotter.

Regards

@chromhelm

This comment has been minimized.

Copy link
Contributor Author

commented Mar 19, 2019

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

@per1234

This comment has been minimized.

Copy link
Collaborator

commented Mar 19, 2019

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

This comment has been minimized.

Copy link

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.

@facchinm

This comment has been minimized.

Copy link
Member

commented Jul 18, 2019

Rebased and manually merged, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
6 participants
You can’t perform that action at this time.