From 8416597aecd8b3e97a016e9240d9b3fa640c0a07 Mon Sep 17 00:00:00 2001 From: Christopher Peplin Date: Sun, 21 Sep 2014 17:19:21 -0400 Subject: Deprecate "translated" and "raw" verbiage. Partway towards #16 but need to updated the binary format, too. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dd5651ed..542952de 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,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. @@ -50,7 +50,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: @@ -59,7 +59,7 @@ 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: @@ -177,7 +177,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 -- cgit 1.2.3-korg