doc: Update documentation

Bug-AGL: SPEC-2988

Change-Id: Ifbeb00ef74d7a83db66808ae59dc9422b2e8593a
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

diff --git a/docs/5-Usage.md b/docs/5-Usage.md
index 9e9841e..151b952 100644 (file)
--- 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: <NOARP,UP,LOWER_UP,ECHO> mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10
+  can0: <NOARP, UP, LOWER_UP, ECHO> 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: <NOARP,UP,LOWER_UP,ECHO> mtu 16 qdisc pfifo_fast state UNKNOWN qlen 10
+  can0: <NOARP, UP, LOWER_UP, ECHO> 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 e6d35ca..df98018 100644 (file)
--- 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 ] <br/> S. Douheret [ Iot.bzh ] |
 | 20 Jun 2017 |   4.0   | Update documentation with new v4.0 features | R. Forlot [ Iot.bzh ] <br/> S. Douheret [ Iot.bzh ] |
-| 18 Sep 2017 |   4.99-EERC1   | Update documentation with new EEL features (get,list, write)| R. Forlot [ Iot.bzh ] <br/> S. Douheret [ Iot.bzh ] |
+| 18 Sep 2017 |   4.99-EERC1   | Update documentation with new EEL features (get, list, write)| R. Forlot [ Iot.bzh ] <br/> 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 aa23e84..a52334d 100644 (file)
--- a/docs/images/logo_iot_bzh.svg
+++ b/docs/images/logo_iot_bzh.svg
@@ -27,7 +27,7 @@
       <feFlood
          id="feFlood4002"
          flood-opacity="0.475"
-         flood-color="rgb(0,0,0)"
+         flood-color="rgb(0, 0, 0)"
          result="flood" />
       <feComposite
          id="feComposite4004"
@@ -93,7 +93,7 @@
      transform="translate(-49.874326,-541.49045)">
     <g
        id="g3091"
-       transform="matrix(0.33646024,0,0,0.33646024,52.43994,405.25569)"
+       transform="matrix(0.33646024, 0, 0, 0.33646024, 52.43994, 405.25569)"
        inkscape:export-filename="/home/sdx/Pictures/Logo/logo_iot_bzh_100dpi.png"
        inkscape:export-xdpi="100.22011"
        inkscape:export-ydpi="100.22011"
@@ -112,7 +112,7 @@
            sodipodi:role="line">IOT</tspan></text>
       <path
          inkscape:connector-curvature="0"
-         d="m 286.73007,473.23356 c 28.21686,16.29102 28.75566,58.73779 0.99693,78.53831 -7.67688,5.47598 -8.77935,4.91028 -1.99529,-1.0238 17.47377,-15.28453 17.98492,-42.17775 1.08522,-57.09786 l -3.91266,-3.45435 0.72312,-3.71053 c 0.39771,-2.04076 0.5997,-5.73115 0.44885,-8.20083 -0.33876,-5.54623 0.15803,-6.49185 2.65383,-5.05094 z m -64.76568,11.40332 c 7.06047,-7.74198 18.64659,-14.16089 29.04027,-16.08874 l 6.87489,-1.27521 0.87404,2.89709 c 0.4807,1.59343 0.67439,5.2245 0.43037,8.06906 l -0.44364,5.17195 -6.13887,1.6918 c -10.91241,3.00731 -20.4022,10.85909 -25.4533,21.05979 l -2.41633,4.87984 -2.74281,-0.41238 c -5.14252,-0.77316 -12.72985,-3.97645 -12.79123,-5.40033 -0.092,-2.13451 8.34659,-15.74625 12.76661,-20.59287 z m 33.20546,36.39493 c -28.21687,16.29101 -65.24624,-4.46574 -68.51461,-38.40577 -0.9039,-9.38637 0.13723,-10.0583 1.88428,-1.21608 4.49989,22.77499 27.53453,36.66428 48.90556,29.48876 l 4.94788,-1.66128 2.85184,2.48149 c 1.56852,1.36481 4.66349,3.38493 6.87772,4.48914 4.97257,2.47973 5.54308,3.38282 3.04733,4.82374 z m 22.50729,-61.79039 c 3.17451,9.98553 2.94038,23.22889 -0.58688,33.19399 l -2.33309,6.59143 -2.94597,-0.69161 c -1.6203,-0.38041 -4.86173,-2.02821 -7.2032,-3.6618 l -4.25721,-2.97018 1.60429,-6.16234 c 2.85178,-10.95404 0.79685,-23.09833 -5.51167,-32.57307 l -3.01788,-4.53253 1.72854,-2.16916 c 3.24083,-4.06698 9.80863,-9.03614 11.07242,-8.37738 1.89457,0.98756 9.46336,15.1015 11.45065,21.35265 z m -48.80223,10.31437 c 0,-32.58201 36.49058,-54.27201 67.51771,-40.1325 8.58077,3.9104 8.6421,5.148 0.11108,2.23988 -21.97368,-7.49048 -45.51946,5.51348 -49.99082,27.6091 l -1.03521,5.11561 -3.57498,1.22902 c -1.96621,0.67596 -5.26316,2.34622 -7.32655,3.71171 -4.63379,3.06649 -5.70115,3.10904 -5.70115,0.22718 z m 42.25842,50.3871 c -10.23499,-2.24356 -21.58699,-9.06801 -28.45341,-17.10525 l -4.5418,-5.31622 2.07194,-2.20549 c 1.13957,-1.21302 4.18733,-3.19628 6.77282,-4.40726 l 4.70085,-2.20176 4.53458,4.47053 c 8.06061,7.94674 19.60535,12.23927 30.96496,11.51329 l 5.43422,-0.34731 1.01427,2.58154 c 1.90169,4.84014 2.92124,13.01261 1.71883,13.77769 -1.80254,1.14695 -17.80995,0.64475 -24.21726,-0.75976 z"
+         d="m 286.73007, 473.23356 c 28.21686, 16.29102 28.75566, 58.73779 0.99693, 78.53831 -7.67688, 5.47598 -8.77935, 4.91028 -1.99529,-1.0238 17.47377,-15.28453 17.98492,-42.17775 1.08522,-57.09786 l -3.91266,-3.45435 0.72312,-3.71053 c 0.39771,-2.04076 0.5997,-5.73115 0.44885,-8.20083 -0.33876,-5.54623 0.15803,-6.49185 2.65383,-5.05094 z m -64.76568, 11.40332 c 7.06047,-7.74198 18.64659,-14.16089 29.04027,-16.08874 l 6.87489,-1.27521 0.87404, 2.89709 c 0.4807, 1.59343 0.67439, 5.2245 0.43037, 8.06906 l -0.44364, 5.17195 -6.13887, 1.6918 c -10.91241, 3.00731 -20.4022, 10.85909 -25.4533, 21.05979 l -2.41633, 4.87984 -2.74281,-0.41238 c -5.14252,-0.77316 -12.72985,-3.97645 -12.79123,-5.40033 -0.092,-2.13451 8.34659,-15.74625 12.76661,-20.59287 z m 33.20546, 36.39493 c -28.21687, 16.29101 -65.24624,-4.46574 -68.51461,-38.40577 -0.9039,-9.38637 0.13723,-10.0583 1.88428,-1.21608 4.49989, 22.77499 27.53453, 36.66428 48.90556, 29.48876 l 4.94788,-1.66128 2.85184, 2.48149 c 1.56852, 1.36481 4.66349, 3.38493 6.87772, 4.48914 4.97257, 2.47973 5.54308, 3.38282 3.04733, 4.82374 z m 22.50729,-61.79039 c 3.17451, 9.98553 2.94038, 23.22889 -0.58688, 33.19399 l -2.33309, 6.59143 -2.94597,-0.69161 c -1.6203,-0.38041 -4.86173,-2.02821 -7.2032,-3.6618 l -4.25721,-2.97018 1.60429,-6.16234 c 2.85178,-10.95404 0.79685,-23.09833 -5.51167,-32.57307 l -3.01788,-4.53253 1.72854,-2.16916 c 3.24083,-4.06698 9.80863,-9.03614 11.07242,-8.37738 1.89457, 0.98756 9.46336, 15.1015 11.45065, 21.35265 z m -48.80223, 10.31437 c 0,-32.58201 36.49058,-54.27201 67.51771,-40.1325 8.58077, 3.9104 8.6421, 5.148 0.11108, 2.23988 -21.97368,-7.49048 -45.51946, 5.51348 -49.99082, 27.6091 l -1.03521, 5.11561 -3.57498, 1.22902 c -1.96621, 0.67596 -5.26316, 2.34622 -7.32655, 3.71171 -4.63379, 3.06649 -5.70115, 3.10904 -5.70115, 0.22718 z m 42.25842, 50.3871 c -10.23499,-2.24356 -21.58699,-9.06801 -28.45341,-17.10525 l -4.5418,-5.31622 2.07194,-2.20549 c 1.13957,-1.21302 4.18733,-3.19628 6.77282,-4.40726 l 4.70085,-2.20176 4.53458, 4.47053 c 8.06061, 7.94674 19.60535, 12.23927 30.96496, 11.51329 l 5.43422,-0.34731 1.01427, 2.58154 c 1.90169, 4.84014 2.92124, 13.01261 1.71883, 13.77769 -1.80254, 1.14695 -17.80995, 0.64475 -24.21726,-0.75976 z"
          style="display:inline;fill:#5a2ca0"
          id="path3415-4-2-2-5-0-3-7-4-4-1-5" />
       <text