Merge remote-tracking branch 'origin/16-new-names' into next

[apps/low-level-can-service.git] / JSON.mkd

diff --git a/JSON.mkd b/JSON.mkd
index 4704574..7bf0ce5 100644 (file)
--- a/JSON.mkd
+++ b/JSON.mkd
@@ -16,9 +16,9 @@ to your application. For example:
         }
     }
 
-## Single Valued
+## Simple Vehicle Message
 
-There may not be a 1:1 relationship between input and output signals - i.e. raw
+There may not be a 1:1 relationship between input and output signals - i.e.
 engine timing CAN signals may be summarized in an "engine performance" metric on
 the abstract side of the interface.
 
@@ -26,7 +26,7 @@ The expected format of a single valued message is:
 
     {"name": "steering_wheel_angle", "value": 45}
 
-## Evented
+## Evented Simple Vehicle Message
 
 The expected format of an event message is:
 
@@ -35,9 +35,9 @@ The expected format of an event message is:
 This format is good for something like a button event, where there are two
 discrete pieces of information in the measurement.
 
-## Raw CAN Message format
+## CAN Message
 
-The format for a raw CAN message:
+The format for a plain CAN message:
 
     {"bus": 1, "id": 1234, "data": "0x12345678"}
 
@@ -53,6 +53,10 @@ The format for a raw CAN message:
   complete string must have an even number of characters. The `0x` prefix is
   optional.
 
+**format** - (optional) explicitly set the frame format for the CAN message, one
+  of `standard` or `extended`. If the `id` is greater than `0x7ff`, the extended
+  frame format will be selected automatically.
+
 ## Diagnostic Messages
 
 ### Requests
@@ -153,7 +157,7 @@ exist in parallel with a recurring request for the same key.
 
 **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
+  simple vehicle message) with this value in place of `bus`, `id`, `mode` and
   `pid`.
 
 **multiple_responses** - (optional, false by default) if true, request will stay