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:
929ab4b
)
Move 'frequency' field inside 'request' object of diag command.
author
Christopher Peplin
<chris.peplin@rhubarbtech.com>
Fri, 28 Feb 2014 19:47:09 +0000
(14:47 -0500)
committer
Christopher Peplin
<chris.peplin@rhubarbtech.com>
Fri, 28 Feb 2014 19:47:09 +0000
(14:47 -0500)
README.md
patch
|
blob
|
history
diff --git
a/README.md
b/README.md
index
475ae21
..
a10fe88
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-46,15
+46,23
@@
is sent as a JSON object, separated by newlines. The format of each object is:
### Requests
### Requests
- {"bus": 1,
- "id": 1234,
- "mode": 1,
- "pid": 5,
- "payload": "0x1234",
- "parse_payload": true,
- "factor": 1.0,
- "offset": 0,
- "frequency": 0}
+A request to add or update a diagnostic request is sent to a vehicle interface
+with this command format:
+
+ { "command": "diagnostic_request",
+ "request": {
+ "bus": 1,
+ "id": 1234,
+ "mode": 1,
+ "pid": 5,
+ "payload": "0x1234",
+ "parse_payload": true,
+ "factor": 1.0,
+ "offset": 0,
+ "frequency": 1
+ }
+ }
+ }
**bus** - the numerical identifier of the CAN bus where this request should be
sent, most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
**bus** - the numerical identifier of the CAN bus where this request should be
sent, most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
@@
-89,8
+97,8
@@
is sent as a JSON object, separated by newlines. The format of each object is:
TODO it'd be nice to have the OBD-II PIDs built in, with the proper conversion
functions - that may need a different output format
TODO it'd be nice to have the OBD-II PIDs built in, with the proper conversion
functions - that may need a different output format
-If you're just requesting a PID, you can use
a simplified forma
t for the
-
reques
t:
+If you're just requesting a PID, you can use
this minimal field se
t for the
+
`request` objec
t:
{"bus": 1, "id": 1234, "mode": 1, "pid": 5}
{"bus": 1, "id": 1234, "mode": 1, "pid": 5}