summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorArthur Guyader <arthur.guyader@iot.bzh>2019-08-27 11:51:26 +0200
committerArthur Guyader <arthur.guyader@iot.bzh>2019-08-30 15:41:32 +0200
commitccf35c0dc912e9a29721fa04244fc7f932282d18 (patch)
tree86bcab2390a03d540776688d6a4c57ce80065501 /docs
parentf83aef543d0196a56bf4d7706bba79efcd73190d (diff)
Remove file socketcan-j1939 that was not removed before
Bug-AGL : SPEC-2780 Change-Id: I4ddf9389faffebe0334b0004b69bb7336277c29d Signed-off-by: Arthur Guyader <arthur.guyader@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/4-Installation-ISOTP.md50
-rw-r--r--docs/5-Usage.md (renamed from docs/4-Usage.md)12
-rw-r--r--docs/api-services-book.yml4
3 files changed, 63 insertions, 3 deletions
diff --git a/docs/4-Installation-ISOTP.md b/docs/4-Installation-ISOTP.md
new file mode 100644
index 00000000..c8fc31f6
--- /dev/null
+++ b/docs/4-Installation-ISOTP.md
@@ -0,0 +1,50 @@
+# Installation isotp for AGL
+
+## Compilation and installation of module kernel isotp
+
+##### Clone repository Linux Kernel Module for ISO 15765-2:2016 CAN transport protocol
+
+```bash
+git clone https://github.com/hartkopp/can-isotp.git
+```
+
+##### Move into the new repository
+
+```bash
+cd can-isotp
+```
+
+##### Install packages to build
+
+```bash
+sudo apt-get install build-essential linux-headers-$(uname -r)
+```
+
+##### Compile
+
+```bash
+make
+```
+
+##### Install
+
+```bash
+sudo make modules_install
+```
+
+##### Load module
+
+
+```bash
+modprobe can
+modprobe vcan
+sudo insmod ./net/can/can-isotp.ko
+```
+
+
+## Include headers files
+
+
+```bash
+sudo cp include/uapi/linux/can/isotp.h /usr/include/linux/can/
+``` \ No newline at end of file
diff --git a/docs/4-Usage.md b/docs/5-Usage.md
index 6c6d1380..9e9841e8 100644
--- a/docs/4-Usage.md
+++ b/docs/5-Usage.md
@@ -306,6 +306,8 @@ argument filter with one or more of the filters available :
the subscribed client(s).
* max: Maximum value that the decoded value needs to be below to get pushed to
the subscribed client(s)
+* rx_id : For the ISO TP protocol, define the id of source to write a message
+* tx_id : For the ISO TP protocol, define the id of emitter to receive message
Order doesn't matter neither the number of filters chosen, you can use one, two
or all of them at once.
@@ -316,6 +318,8 @@ Usage examples :
low-can subscribe {"event": "messages.engine.speed", "filter": { "frequency": 3, "min": 1250, "max": 3500}}
low-can subscribe {"event": "messages.engine.load", "filter": { "min": 30, "max": 100}}
low-can subscribe {"event": "messages.vehicle.speed", "filter": { "frequency": 2}}
+# ISOTP
+low-can subscribe {"id": 273, "filter": {"tx_id" : 562}}
```
## Get last signal value and list of configured signals
@@ -354,9 +358,13 @@ low-can write { "bus_name": "hs", "frame": { "can_id": 1568, "can_dlc": 8, "can_
# Write a signal's value.
low-can write { "signal_name": "engine.speed", "signal_value": 1256}
# Write J1939 'single frame'
-low-can write { "bus_name": "j1939", "frame": { "pgn": 62420, "length":8, "data": [ 255,255,255,255,255,255,255,255]} }
+low-can write { "bus_name": "j1939", "frame": { "pgn": 61442, "length":8, "data": [ 255,255,255,255,255,255,255,255]} }
# Write J1939 'multi frame'
-low-can write { "bus_name": "j1939", "frame": { "pgn": 62420, "length":9, "data": [ 255,255,255,255,255,255,255,255,254]} }
+low-can write { "bus_name": "j1939", "frame": { "pgn": 61442, "length":9, "data": [ 255,255,255,255,255,255,255,255,254]} }
+# Write ISOTP 'single frame'
+low-can write {"bus_name": "hs", "filter": {"rx_id" : 562}, "frame": { "can_id": 273, "can_dlc": 8, "can_data": [ 255,255,255,255,255,255,255,255]} }
+# Write ISOTP 'multi frame'
+low-can write {"bus_name": "hs", "filter": {"rx_id" : 562}, "frame": { "can_id": 273, "can_dlc": 9, "can_data": [ 255,255,255,255,255,255,255,255,25]} }
```
To be able to use write capability, you need to add the permission
diff --git a/docs/api-services-book.yml b/docs/api-services-book.yml
index 225d67b8..f2909c3c 100644
--- a/docs/api-services-book.yml
+++ b/docs/api-services-book.yml
@@ -14,5 +14,7 @@ books:
name: Installation Guide
- url: 3-Installation-J1939.md
name: Installation Guide for J1939
- - url: 4-Usage.md
+ - url: 4-Installation-ISOTP.md
+ name: Installation Guide for ISOTP
+ - url: 5-Usage.md
name: Usage Guide