Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit 8ced4fb

Browse files
committed
Update serial_protocol.md
1 parent bba8045 commit 8ced4fb

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

serial_protocol.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Only needs to be called when the chiplet is in a new environment and needs to co
2020
NETWORK $SSID
2121
NETWORK $SSID $PASSWORD
2222
###Response
23-
CONNECTED - When connected to new network
24-
UNABLE_TO_CONNECT - When unable to connect
23+
+CONNECTED - When connected to new network
24+
-UNABLE_TO_CONNECT - When unable to connect
2525
###Examples
2626
>> NETWORK home-guest
2727
<< +CONNECTED
@@ -36,7 +36,7 @@ Must be called after creating a Serial connection, it can take either just a hos
3636
BEGIN $Host
3737
BEGIN $Host $Secret
3838
###Response
39-
OK - Accepted initialization parameters
39+
+OK - Accepted initialization parameters
4040
###Examples
4141
>> BEGIN https://samplechat.firebaseio-demo.com
4242
<< +OK
@@ -85,14 +85,16 @@ Similar to SET above but used to write multiline strings or raw binary data. Dat
8585

8686
Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of data before becoming responsive again.
8787
###Usage
88-
SET$ $PATH $DATA_BYTE_COUNT
88+
SET$ $PATH
89+
$DATA_BYTE_COUNT
8990
$DATA
9091
###Response
9192
+OK
9293
-FAIL
9394
-FAIL_TIMEOUT
9495
###Examples
95-
>>SET /user/aturing/address 24
96+
>>SET /user/aturing/address
97+
>>24
9698
>>78 High Street,
9799
>>Hampton
98100
<<+OK
@@ -143,7 +145,7 @@ Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of
143145
###Response
144146
$KEY
145147
###Examples
146-
>>PUSH /user/aturing/quotes 91
148+
>>PUSH$ /user/aturing/quotes 91
147149
>>We can only see a short distance ahead,
148150
>>but we can see plenty there that needs to be done.
149151
<<+-K94eLnB0rAAvfkh_WC3
@@ -153,7 +155,7 @@ Used to register to receive a stream of events that occur to the object at the p
153155

154156
After registering you will start receiving events on the response line. They will be formatted as one line with the event type {PUT,PATCH,etc..} followed by the sub_path that changed and the other line with the data associated with that event type. This data will be formatted similar to GET results and can have multi-line batch strings (*) or json strings (&).
155157

156-
The event stream will continue until you send CANCEL_STREAM.
158+
The event stream will continue until you send END_STREAM.
157159

158160
When there is an ongoing event stream no other commands can be processed until you call END_STREAM as the event stream owns the return line.
159161
###Usage

0 commit comments

Comments
 (0)