Skip to content

Corrects grammar in ArduinoSerialProtocol.md #11833

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 29, 2022
Merged

Corrects grammar in ArduinoSerialProtocol.md #11833

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions build/shared/ArduinoSerialPlotterProtocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SerialPlotter protocol

One message can consist of multiply parts.
One message can consist of multiple parts.
One part can consist of one label, one label and a value or only a value.

| | |
Expand Down Expand Up @@ -31,11 +31,11 @@ There is a special case, the CSV header style.
|-------|----|---------|-----|---------|----|
|Label 1| \t | Label 2 | ... | Label n | \n |

But in this format, labels consisting of only numbers are not recognised as labels.
Note that in this format, labels consisting of only numbers are not recognised as labels.
It is safer to just use the normal label only message.

## Value only messages Value
This is not recommended if you using a board with USB to UART converter.
This is not recommended if you use a board with USB to UART converter.
Because when the label is sent, before you had the SerialPlotter opened, then the label/labels get/gets never set.

| | | | | | |
Expand Down Expand Up @@ -73,7 +73,7 @@ The output looks like this
```
## Single Trace with label

This example sends the label once in the setup routine. Afterwards only the value is send.
This example sends the label once in the setup routine. Afterwards only the value is sent.

```ino
void setup() {
Expand All @@ -100,7 +100,7 @@ Label 1:\n
14\n
```

## Single Trace with label send every time
## Single Trace with label sent every time

This example sends the label every time together with the value.

Expand All @@ -126,7 +126,7 @@ Label 1:12\n
Label 1:13\n
Label 1:14\n
```
## Two Traces with label send every time
## Two Traces with label sent every time

This example sends two values together with the labels.

Expand Down