rooty/Arduino
1
0
Fork 0
mirror of https://github.com/arduino/Arduino.git synced 2024-12-01 12:24:14 +01:00
Code Issues Releases Activity

Merge pull request #11833 from slavicd/patch-1

Browse Source 
Corrects grammar in ArduinoSerialProtocol.md
This commit is contained in:
per1234 2022-10-29 12:36:22 -07:00 committed by GitHub
commit 89539b1131
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
build/shared/ArduinoSerialPlotterProtocol.md
View File

@ -1,6 +1,6 @@
# SerialPlotter protocol # 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. One part can consist of one label, one label and a value or only a value.
| | | | | |
@ -31,11 +31,11 @@ There is a special case, the CSV header style.
|-------|----|---------|-----|---------|----| |-------|----|---------|-----|---------|----|
|Label 1| \t | Label 2 | ... | Label n | \n | |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. It is safer to just use the normal label only message.
## Value only messages Value ## 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. Because when the label is sent, before you had the SerialPlotter opened, then the label/labels get/gets never set.
| | | | | | | | | | | | | |
@ -73,7 +73,7 @@ The output looks like this
``` ```
## Single Trace with label ## 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 ```ino
void setup() { void setup() {
@ -100,7 +100,7 @@ Label 1:\n
14\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. This example sends the label every time together with the value.
@ -126,7 +126,7 @@ Label 1:12\n
Label 1:13\n Label 1:13\n
Label 1:14\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. This example sends two values together with the labels.