neale/vail
neale
/
vail
mirror of https://github.com/nealey/vail.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add clients to protocol doc

This commit is contained in:
Neale Pickett 2024-10-24 13:32:43 -06:00
parent 5c3dc7ec6c
commit c2c9dbcacb
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/protocol.md
View File

@ -26,11 +26,13 @@ JSON-encoded Vail messages are a direct encoding of the struct:
```json ```json
{ {
"Timestamp": 1702846980, "Timestamp": 1702846980,
"Clients": 2,
"Duration": [80, 80, 240] "Duration": [80, 80, 240]
} }
``` ```
This represents a transmission at Sun 17 Dec 2023 09:03:00 PM UTC, consisting of an 80ms tone, an 80ms silence, and a 240ms tone. This represents a transmission at Sun 17 Dec 2023 09:03:00 PM UTC, consisting of an 80ms tone, an 80ms silence, and a 240ms tone.
2 clients were connectd to the repeater at this time.
Binary Marshalling Binary Marshalling
@ -38,11 +40,12 @@ Binary Marshalling
The binary marshalled version of a Vail message is encoded big-endian: The binary marshalled version of a Vail message is encoded big-endian:
00 00 00 00 65 7f 62 04 00 50 00 50 00 f0 00 00 00 00 65 7f 62 04 00 02 00 50 00 50 00 f0
Is decoded as: Is decoded as:
* Timestamp (int64): `00 00 00 00 65 7f 62 04` = 1702846980 * Timestamp (int64): `00 00 00 00 65 7f 62 04` = 1702846980
* Clients (uint16): `00 02` = 02
* Duration ([]uint16): * Duration ([]uint16):
* `00 50` = 80 * `00 50` = 80
* `00 50` = 80 * `00 50` = 80