Skip to content

Commit

Permalink
Merge pull request #11833 from slavicd/patch-1
Browse files Browse the repository at this point in the history
Corrects grammar in ArduinoSerialProtocol.md
  • Loading branch information
per1234 authored Oct 29, 2022
2 parents 43b0818 + 92bbac4 commit 89539b1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions build/shared/ArduinoSerialPlotterProtocol.md
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

0 comments on commit 89539b1

Please sign in to comment.