Elaborate on 'name' field for diagnostic requests.

[apps/agl-service-can-low-level.git] / README.md

diff --git a/README.md b/README.md
index 65f0d19..cef6ea3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ with this command format:
           "pid": 5,
           "payload": "0x1234",
           "parse_payload": true,
-          "multiple_response": false,
+          "multiple_responses": false,
           "factor": 1.0,
           "offset": 0,
           "frequency": 1,
@@ -84,12 +84,17 @@ with this command format:
     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
-    the response. The 'payload' field will be omitted in responses with a
-    'value'.
+**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 the response. The `payload` field will be omitted in
+    responses with a `value`.
 
-**multiple_response** - (optional, false by default) if true, request will stay
+**name** - (optional, defaults to nothing) A human readable, string name for
+  this request. If provided, the response will have a `name` field (much like a
+  normal translated message) with this value in place of `bus`, `id`, `mode` and
+  `pid`.
+
+**multiple_responses** - (optional, false by default) if true, request will stay
   active for a full 100ms, even after receiving a diagnostic response message.
   This is useful for requests to the functional broadcast arbitration ID
   (`0x7df`) when you need to get responses from multiple modules. It's possible
@@ -108,11 +113,6 @@ with this command format:
 **frequency** - (optional, defaults to 0) The frequency in Hz to send this
     request. To send a single request, set this to 0 or leave it out.
 
-**name** - (optional, defaults to nothing) A human readable, string name for
-    this request. If provided, the response will have a `name` field (much like a
-    normal translated message) in place of the request details (i.e. the bus,
-    id, mode and pid).  TODO elaborate on this.
-
 The `bus+id+mode+pid` key is unique, so if you send a create request with that
 key twice, it'll overwrite the existing one (i.e. it will change the frequency,
 the only other parameter). To cancel a recurring request, send this command with
@@ -125,14 +125,24 @@ If you're just requesting a PID, you can use this minimal field set for the
 
 ### Responses
 
+The response to a successful request:
+
     {"bus": 1,
       "id": 1234,
       "mode": 1,
       "pid": 5,
       "success": true,
-      "negative_response_code": 17,
       "payload": "0x1234",
-      "parsed_payload": 4660}
+      "value": 4660}
+
+and to an unsuccessful request, with the `negative_response_code` and no `pid`
+echo:
+
+    {"bus": 1,
+      "id": 1234,
+      "mode": 1,
+      "success": false,
+      "negative_response_code": 17}
 
 **bus** - the numerical identifier of the CAN bus where this response was
     received.