X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=JSON.mkd;h=7bf0ce5a905dd65a292344d3aaefd2b85da4b6af;hb=fde9efb8224468dd8fb3c6204a7e80a9dd38a97c;hp=804efa45a7ba0109d068646bcaf44998643fa16d;hpb=f340bc6909f84a83dbb8a4d7ca3ba1002b31b110;p=apps%2Flow-level-can-service.git diff --git a/JSON.mkd b/JSON.mkd index 804efa4..7bf0ce5 100644 --- 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"} @@ -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 - 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