aboutsummaryrefslogtreecommitdiff
path: root/shared/protocol.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2022-10-19 20:04:06 +0200
committerlonkaars <loek@pipeframe.xyz>2022-10-19 20:04:06 +0200
commitaab4ed17b94f54813368201d3a0cba3f3d432589 (patch)
tree4babada7f6d176d06a5459510533baa10ac91cd4 /shared/protocol.md
parent2274409f898351f958975d49b0324d992c6073d0 (diff)
integrate protocol code into stm32 code
Diffstat (limited to 'shared/protocol.md')
-rw-r--r--shared/protocol.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/shared/protocol.md b/shared/protocol.md
index bafec4d..b6e955c 100644
--- a/shared/protocol.md
+++ b/shared/protocol.md
@@ -29,8 +29,9 @@ conventions.
Returns the last `n` records in csv format. The first line has the csv table
header, with the fields `id`, `temperature`, `humidity`, and
`atmospheric_pressure`. The rest of the response consists of 1 record per line.
-When `n` is 0, or no records exist yet, the csv header is still returned, but
-without any records.
+The amount of records is limited to the amount of valid records in the backlog
+buffer. When the amount of returned records is 0, the response consists of the
+csv header, but without any following records.
## Example transaction
@@ -39,7 +40,7 @@ starting with `<`, and response by lines starting with `>`.
```
< last-records 5<0a>
-> ok,115<0a>
+> ok,73<0a>
> id,temperature,humidity,atmospheric_pressure<0a>
> 10dc,2f,c5,7f<0a>
> 10dd,30,c6,7f<0a>