You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: serial_protocol.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,8 @@ Only needs to be called when the chiplet is in a new environment and needs to co
20
20
NETWORK $SSID
21
21
NETWORK $SSID $PASSWORD
22
22
###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
25
25
###Examples
26
26
>> NETWORK home-guest
27
27
<< +CONNECTED
@@ -36,7 +36,7 @@ Must be called after creating a Serial connection, it can take either just a hos
36
36
BEGIN $Host
37
37
BEGIN $Host $Secret
38
38
###Response
39
-
OK - Accepted initialization parameters
39
+
+OK - Accepted initialization parameters
40
40
###Examples
41
41
>> BEGINhttps://samplechat.firebaseio-demo.com
42
42
<< +OK
@@ -85,14 +85,16 @@ Similar to SET above but used to write multiline strings or raw binary data. Dat
85
85
86
86
Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of data before becoming responsive again.
87
87
###Usage
88
-
SET$ $PATH $DATA_BYTE_COUNT
88
+
SET$ $PATH
89
+
$DATA_BYTE_COUNT
89
90
$DATA
90
91
###Response
91
92
+OK
92
93
-FAIL
93
94
-FAIL_TIMEOUT
94
95
###Examples
95
-
>>SET /user/aturing/address 24
96
+
>>SET /user/aturing/address
97
+
>>24
96
98
>>78 High Street,
97
99
>>Hampton
98
100
<<+OK
@@ -143,7 +145,7 @@ Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of
143
145
###Response
144
146
$KEY
145
147
###Examples
146
-
>>PUSH /user/aturing/quotes 91
148
+
>>PUSH$ /user/aturing/quotes 91
147
149
>>We can only see a short distance ahead,
148
150
>>but we can see plenty there that needs to be done.
149
151
<<+-K94eLnB0rAAvfkh_WC3
@@ -153,7 +155,7 @@ Used to register to receive a stream of events that occur to the object at the p
153
155
154
156
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 (&).
155
157
156
-
The event stream will continue until you sendCANCEL_STREAM.
158
+
The event stream will continue until you sendEND_STREAM.
157
159
158
160
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.