Code Review
/
apps
/
agl-service-can-low-level.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
review
|
tree
raw
|
patch
|
inline
| side by side (parent:
6642105
)
Require byte arrays in JSON hex strings to have 2 chars per byte.
author
Christopher Peplin
<chris.peplin@rhubarbtech.com>
Thu, 20 Mar 2014 18:44:58 +0000
(14:44 -0400)
committer
Christopher Peplin
<chris.peplin@rhubarbtech.com>
Thu, 20 Mar 2014 18:44:58 +0000
(14:44 -0400)
README.md
patch
|
blob
|
history
diff --git
a/README.md
b/README.md
index
dcfee28
..
01ca5f3
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-40,7
+40,9
@@
is sent as a JSON object, separated by newlines. The format of each object is:
**data** - up to 8 bytes of data from the CAN message's payload, represented as
a hexidecimal number in a string. Many JSON parser cannot handle 64-bit
**data** - up to 8 bytes of data from the CAN message's payload, represented as
a hexidecimal number in a string. Many JSON parser cannot handle 64-bit
- integers, which is why we are not using a numerical data type.
+ integers, which is why we are not using a numerical data type. Each byte in
+ the string *must* be represented with 2 characters, e.g. `0x1` is `0x01` - the
+ complete string must have an even number of characters.
## Diagnostic Messages
## Diagnostic Messages
@@
-79,6
+81,8
@@
with this command format:
**payload** - (optional) up to 7 bytes of data for the request's payload
represented as a hexidecimal number in a string. Many JSON parser cannot
handle 64-bit integers, which is why we are not using a numerical data type.
**payload** - (optional) up to 7 bytes of data for the request's payload
represented as a hexidecimal number in a string. Many JSON parser cannot
handle 64-bit integers, which is why we are not using a numerical data type.
+ Each byte in the string *must* be represented with 2 characters, e.g. `0x1`
+ is `0x01` - the complete string must have an even number of characters.
**parse_payload** - (optional, false by default) if true, the complete payload in the
response message will be parsed as a number and returned in the 'value' field of
**parse_payload** - (optional, false by default) if true, the complete payload in the
response message will be parsed as a number and returned in the 'value' field of