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

Commit 8dac3f3

Browse files
committed
Update serial_protocol.md
1 parent 6f30401 commit 8dac3f3

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

serial_protocol.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,20 @@ Store the data provided at the path provided. This method should be used for sim
8484
###Examples
8585
>>SET /user/aturning/first Alan
8686
<<+OK
87-
##SET_BULK
88-
Similar to SET above but used to write multiline strings or raw binary data.
87+
##SET$
88+
Similar to SET above but used to write multiline strings or raw binary data. Data format is similar to the batch string ($) return type, we specify the $DATA_BYTE_COUNT on the same line as SET$ then a newline and all data.
8989

9090
Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of data before becoming responsive again.
9191
###Usage
92-
SET_BULK $PATH $DATA_BYTE_COUNT $DATA
92+
SET$ $PATH $DATA_BYTE_COUNT
93+
$DATA
9394
###Response
9495
+OK
9596
-FAIL
9697
-FAIL_TIMEOUT
9798
###Examples
98-
>>SET /user/aturning/address 24 78 High Street,
99+
>>SET /user/aturning/address 24
100+
>>78 High Street,
99101
>>Hampton
100102
<<+OK
101103

@@ -120,16 +122,18 @@ Adds a value to the list located at the path provided and returns the key at whi
120122
>>PUSH /user/aturning/login_timestamps 1455052043
121123
<<+-K94eLnB0rAAvfkh_WC2
122124

123-
##PUSH_BULK
124-
Similar to PUSH but used to write multiline strings or raw binary data.
125+
##PUSH$
126+
Similar to PUSH but used to write multiline strings or raw binary data. Data format is similar to the batch string ($) return type, we specify the $DATA_BYTE_COUNT on the same line as SET$ then a newline and all data.
125127

126128
Receiver will wait until a timeout for client to send $DATA_BYTE_COUNT worth of data before becoming responsive again.
127129
###Usage
128-
PUSH_BULK $PATH $DATA_BYTE_COUNT $DATA
130+
PUSH_BULK $PATH $DATA_BYTE_COUNT
131+
$DATA
129132
###Response
130133
$KEY
131134
###Examples
132-
>>PUSH /user/aturning/quotes 91 We can only see a short distance ahead,
135+
>>PUSH /user/aturning/quotes 91
136+
>>We can only see a short distance ahead,
133137
>>but we can see plenty there that needs to be done.
134138
<<+-K94eLnB0rAAvfkh_WC3
135139

0 commit comments

Comments
 (0)