Back off change to CAN message ID for backwards compatibility.
[apps/agl-service-can-low-level.git] / CHANGELOG.md
1 # OpenXC Message Format Changelog
2
3 ## v0.4-dev
4
5 * BREAKING: Removed factor and offset from diagnostic requests to minimize the number of
6   fields, and since this is such an uncommon use case and one that can be
7   handled by the client receiving the data. We may add them back in the future.
8 * BREAKING: Require an 'action' to diagnostic request commands, e.g. cancel or add.
9 * BREAKING: Rename "raw" messages to the more precise "CAN messages".
10 * BREAKING: Rename "translated" messages to "simple messages".
11 * BREAKING: Remove redundant `type` field from simple messages (formerly
12   translated messages). The type can be inferred implicitly through the types of
13   the value and event fields.
14 * Feature: Add a command for controlling CAN message passthrough.
15 * Feature: Add a command for controlling CAN controller acceptance filter bypass.
16 * Feature: Add a command to change the payload format.
17 * Feature: Add a command to control whether pre-defined, recurring OBD-II
18   requests are enabled.
19 * Improvement: Add `extras` field to JSON messages.
20 * Improvement: Add an optional 'status' field to all command responses.
21 * Improvement: Build protobuf generated files with nanopb v0.3.1.
22 * Improvement: Allow explicitly setting CAN message frame format (i.e. standard
23   or extended frame).
24 * Fix: Expand range of mode field to a full byte (#10)
25
26 ## v0.3
27
28 * Add diagnostic message request/response format.
29 * Officially add Protcol Buffer encoding.
30 * Change JSON delimiter to ```\0``` for both input and output.
31 * Officially document version and device ID commands.
32
33 ## v0.2
34
35 * Add a RAW can message format.
36
37 ## v0.1
38
39 * Initial release.