From 7d9324e95abdb505a8f422251b751b3af2cbcff4 Mon Sep 17 00:00:00 2001 From: Romain Forlot Date: Tue, 12 Nov 2019 12:16:53 +0100 Subject: doc: Update documentation Bug-AGL: SPEC-2988 Change-Id: Ifbeb00ef74d7a83db66808ae59dc9422b2e8593a Signed-off-by: Romain Forlot --- docs/5-Usage.md | 14 +++++++------- docs/Doc-Revisions.md | 2 +- docs/images/logo_iot_bzh.svg | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/5-Usage.md b/docs/5-Usage.md index 9e9841e8..151b9527 100644 --- a/docs/5-Usage.md +++ b/docs/5-Usage.md @@ -52,7 +52,7 @@ others supported bitrate like 125000, 250000 if 500000 doesn't work: ip link set can0 type can bitrate 500000 ip link set can0 up ip link show can0 - can0: mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10 + can0: mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10 link/can can state ERROR-ACTIVE (berr-counter tx 0 rx 0) restart-ms 0 bitrate 500000 sample-point 0.875 @@ -70,7 +70,7 @@ The instructions will be the same: ip link set can1 type can bitrate 500000 ip link set can1 up ip link show can1 - can0: mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10 + can0: mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10 link/can can state ERROR-ACTIVE (berr-counter tx 0 rx 0) restart-ms 0 bitrate 500000 sample-point 0.875 @@ -354,17 +354,17 @@ Examples: # Authentification low-can auth # Write a raw can frame to the CAN id 0x620 -low-can write { "bus_name": "hs", "frame": { "can_id": 1568, "can_dlc": 8, "can_data": [ 255,255,255,255,255,255,255,255]} } +low-can write { "bus_name": "hs", "frame": { "can_id": 1568, "can_dlc": 8, "can_data": [ 255, 255, 255, 255, 255, 255, 255, 255]} } # 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": 61442, "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": 61442, "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]} } +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]} } +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/Doc-Revisions.md b/docs/Doc-Revisions.md index e6d35cad..df980181 100644 --- a/docs/Doc-Revisions.md +++ b/docs/Doc-Revisions.md @@ -5,5 +5,5 @@ Document revisions |-------------|---------|--------------------------------------|-------------------------| | 20 Mar 2017 | 1.0 | Initial release | R. Forlot [ Iot.bzh ]
S. Douheret [ Iot.bzh ] | | 20 Jun 2017 | 4.0 | Update documentation with new v4.0 features | R. Forlot [ Iot.bzh ]
S. Douheret [ Iot.bzh ] | -| 18 Sep 2017 | 4.99-EERC1 | Update documentation with new EEL features (get,list, write)| R. Forlot [ Iot.bzh ]
S. Douheret [ Iot.bzh ] | +| 18 Sep 2017 | 4.99-EERC1 | Update documentation with new EEL features (get, list, write)| R. Forlot [ Iot.bzh ]
S. Douheret [ Iot.bzh ] | | 20 Dec 2017 | 5.0-EE | Update version for EE| R. Forlot [ Iot.bzh ] | diff --git a/docs/images/logo_iot_bzh.svg b/docs/images/logo_iot_bzh.svg index aa23e848..a52334d5 100644 --- a/docs/images/logo_iot_bzh.svg +++ b/docs/images/logo_iot_bzh.svg @@ -27,7 +27,7 @@ IOT