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

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

diff --git a/JSON.mkd b/JSON.mkd
index 804efa4..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.
 
 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}
 
 
     {"name": "steering_wheel_angle", "value": 45}
 

-## Evented
+## Evented Simple Vehicle Message

 
 The expected format of an event message is:
 
 
 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.
 
 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"}
 
 
     {"bus": 1, "id": 1234, "data": "0x12345678"}
 


@@ -157,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
 
 **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
   `pid`.
 
 **multiple_responses** - (optional, false by default) if true, request will stay