From dba666430d276753f6a0c648cf4711860bc0753a Mon Sep 17 00:00:00 2001 From: Romain Forlot Date: Fri, 17 Mar 2017 10:20:44 +0100 Subject: Adding some abstract to the READme. Present the CAN binding architecture. Change-Id: I7ab2a96e468a57e882a2eca93aedaacdc057794b Signed-off-by: Romain Forlot --- README.md | 25 +- images/CAN_bindings_communication.svg | 575 ++++++++++++++++++++++++++++++++++ images/CAN_level_mapping.svg | 297 ++++++++++++++++++ images/OpenXC_to_AGL.svg | 236 ++++++++++++++ 4 files changed, 1132 insertions(+), 1 deletion(-) create mode 100644 images/CAN_bindings_communication.svg create mode 100644 images/CAN_level_mapping.svg create mode 100644 images/OpenXC_to_AGL.svg diff --git a/README.md b/README.md index 7039915..8d396e7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ # Low level CAN signaling binder -Low level CAN bus binder. Based upon OpenXC vi-firmware project. Purpose of this project is to offer a low level binding to an AGL platform, idea remains the same than the vi-firmware project. It's meant to generate from a JSON file describing CAN messages and diagnostic message (OBD2 for now) present in a car, a cpp file to integrate with the project and compile all together. Result will be a widget file to install on an AGL target system. +## Abstract + +Low level CAN bus binder. Based upon OpenXC vi-firmware project. Purpose of this project is to offer a low level binding to an AGL platform, idea remains the same than OpenXC project. It's meant to generate from a JSON file describing CAN messages and diagnostic message (OBD2 for now), a cpp file to integrate with the project. Once generated binding is built with it and result will be a widget file to install on an AGL target system. + +![OpenXC_to_AGL][OpenXC_to_AGL] + +## AGL CAN binding architecture proposal + +Bring CAN management into the AGL project is not simply could decode an print CAN messages, any dump tools can do that, Wireshark do that, CAN-utils do that. The goal is to provide a common API and abstraction to the CAN bus then you can bring some more high level functionnalities to the system. + +CAN binding will be separated in two parts: + +![CAN_mapping][CAN_mapping] + +- High level one will be the binding from which others applications will connect to. It will provides valuable access to the CAN bus by aggregate signals or providing new signals from several originals. By example, a signal exposing whether or not a door is open, no matter which one it is. Also, we can imagine an application which supervise if there is no one in the car but moving (1m, 2m ?) then it send an event to the application which will send a phone message to the owner to alert him of an unexpected behavior. +- The low level one will be one the bus to decode messages that transit and send event through **Application Framework** to the subscribers with human readable message. It will provide some basic access to the bus + some basic mathematical, statistical features (last_values, min, max, timestamps, averaging) as well as basic filter to get discerning signal only. This part are not implemented yet in the low level. + +![Binding_architecture][CAN_bindings_communication] + +Last be not least, the low level binding can be shipped as binary only using OpenXC inspired [generator][generator]. # Prerequirements @@ -256,6 +275,10 @@ low-can unsubscribe { "event" : "doors*" } ON-REPLY 3:low-can/unsubscribe: {"jtype":"afb-reply","request":{"status":"success"}} ``` +[OpenXC_to_AGL]: images/OpenXC_to_AGL.svg "From OpenXC firmware to AGL binding" +[CAN_bindings_communication]: images/CAN_bindings_communication.svg "Communication between CAN bindings and third applications" +[CAN_mapping]: images/CAN_level_mapping.svg "CAN low and high level bindings mapping" + [USB_CAN]: http://reference.com/ "USB CAN adapter recommended" [OBD2_cable]: http://foo.bar/ "OBD2<->DB9 recommended cable" [SDK_instructions]: http://docs.iot.bzh/docs/getting_started/en/dev/reference/setup-sdk-environment.html "Setup SDK environment" diff --git a/images/CAN_bindings_communication.svg b/images/CAN_bindings_communication.svg new file mode 100644 index 0000000..7929e63 --- /dev/null +++ b/images/CAN_bindings_communication.svg @@ -0,0 +1,575 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Security Context + + + + + + + + Security Context + + + + + + + + UI + + + + + + + + Binder + + + + + + + + CAN Low Level Binding(s) + + + + + + + + CAN High Level Binding(s) + + + + + + + + Binder + + + + + + + + + + + + + + + CAN API + + + + + + + + + + + + + + + XXXXX API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Transport Layer + + + + + + + + CynaraSecurity Check + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/images/CAN_level_mapping.svg b/images/CAN_level_mapping.svg new file mode 100644 index 0000000..1e44ba7 --- /dev/null +++ b/images/CAN_level_mapping.svg @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Feb-2017 + + + + + + <footer> + + + + + + <number> + + + + + + + + + + + + + + + + + + + + + + + + + + + AGL CAN Mapping + + + + + + + + Binder + + + CAN Low Level Binding(s)●Decoding / Encoding●Authentication / Crypto / Firewalling●Transaction (set… ack ...)●Stats & Maths●Caching (low freq. Signals, get() call)●Debug + + + CAN High Level Binding(s)●Logic●Aggregation (« vehicle.doors.any.open »)●Advanced Ops + + CAN BUS + + + + + CAN frames - 011010010 + + + + Signals - « vehicle.doors.left.open »(Binder Events) + + + UI + + + Publish Subscribe + + + + + + + + + \ No newline at end of file diff --git a/images/OpenXC_to_AGL.svg b/images/OpenXC_to_AGL.svg new file mode 100644 index 0000000..4a67271 --- /dev/null +++ b/images/OpenXC_to_AGL.svg @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CAN Low Level Bindng(Shared Library) + + + + + + + + + + + + + + OPENXC SignalDescription(JSON) + + + + + + + + + + + + + + + + + + + + + Low LevelBindingStatic Code(AGL) + + + + + + + + + + + + + + CANDecoding/EncodingC Code(vendor) + + + + + + + + + + + + + + OptionalMessageHandlers(vendor) + + + + + + + + + + + + + + + Call for decode/encode + + + + + + + + + + OPENXCCodeGenerator(python) + + + + + + + + + + C/C++Compiler + + + + + + + + + + + + + + OPENXC SignalDescription(JSON) + + + + + + + + + + + + + + OPENXC SignalDescription(JSON) + + + + + + + \ No newline at end of file -- cgit 1.2.3-korg