X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=288bcc5e8f31f35bbf82574defa233ab25b4a072;hb=32b9598698dbc3ece541d64f7b6a3816f041b8d8;hp=35bccdff6694d3c0575bd1cbfc2118e38e603429;hpb=a3cbfc8490394437006dd8bedabfd336cf06fc74;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index 35bccdff..288bcc5e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -#CAN Configuration Generator +# CAN Configuration Generator -##Abstract +## Abstract -This tool is used to generate a configuration source file for the Low Level CAN bus binding. -This binding need a configuration provided as a C++ source file. +This tool is used to generate a configuration source file for the [Low Level CAN bus binding](https://github.com/iotbzh/CAN_signaling). +This binding needs a configuration provided as a C++ source file. As long this binding is based on [OpenXC vi-firmware](https://github.com/openxc/vi-firmware), this generator use the JSON format from the [python generator](https://github.com/openxc/openxc-python). The reference documentation of the JSON file can be found [here](https://github.com/openxc/vi-firmware/blob/master/docs/config/reference.rst). @@ -84,9 +84,11 @@ Use the `-h` option to display help. ## Supported OpenXC items As long as the low level CAN signaling binding doesn't fully support OpenXC yet, this generator is also limited. -For instance, `initializers`, `loopers`, `buses`, `commands` and `handlers` nodes are ignored for now. +For instance, `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now. This generator will follow OpenXC support status of the low level CAN signaling binding. +The `buses` item will not be supported by this generator because the binding use another way to declare and configure buses. Please refer to the binding's documentation. + ## Known issues * Each `diagnostic_message` must define the same `bus` as the binding will use only one bus. @@ -99,4 +101,4 @@ This generator will follow OpenXC support status of the low level CAN signaling Copyright 2017 - iotbzh -Licensed under the [Apache License 2.0](https://github.com/iotbzh/can-config-generator/blob/master/LICENSE) \ No newline at end of file +Licensed under the [Apache License 2.0](https://github.com/iotbzh/can-config-generator/blob/master/LICENSE)