diff --git a/README.md b/README.md index 7767f17e1a36714bd038e92b98c4598c0c4b1a6c..5b8849af0a8feb7a1230cc5db51757076d18b641 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# ieee1905 +# IEEE 1905 -This package provides - +IEEE1905 software stack provides - 1. **libieee1905.so** - Library to encode/decode ieee1905 CMDUs and TLVs @@ -30,10 +30,10 @@ Along with the ubus alme method, this package also provide a library **'lib1905h ---------------------------------------------------------------------------------------------------- -#### AL Ubus interface +#### AL uBus interface **ieee1905d** creates the following UBUS objects and methods - -```json +``` root@iopsys:~# root@iopsys:~# ubus -v list ieee1905 'ieee1905' @1e76a83b @@ -62,7 +62,7 @@ root@iopsys:~# ubus -v list ieee1905.al.< interface-name > #### UCI config '/etc/config/ieee1905' -```json +``` config ieee1905 'ieee1905' option enabled '1' option debug true @@ -136,7 +136,7 @@ Follow plugin specific documentation for detailed info on that plugin. * **List alme ubus object for available options** -```json +``` root@iopsys:/tmp# ubus -v list ieee1905 'ieee1905' @79d9448b "alme":{"cmd":"String","data":"String"} @@ -145,7 +145,7 @@ root@iopsys:/tmp# * **Get list of supported ALME commands** -```json +``` root@iopsys:/tmp# ubus call ieee1905 alme { "cmd(s)": [ @@ -165,7 +165,7 @@ root@iopsys:/tmp# * **Query list of configured interfaces in AL** -```json +``` root@iopsys:~# ubus call ieee1905 alme '{"cmd":"ALME-GET-INTF-LIST.request"}' { "interface_descriptors_nr": 1, @@ -186,7 +186,7 @@ root@iopsys:/tmp# * **Get metric of all the AL(s) in network** -```json +``` root@iopsys:/tmp# root@iopsys:/tmp# ubus call ieee1905 alme '{"cmd":"ALME-GET-METRIC.request"}' { @@ -235,7 +235,7 @@ root@iopsys:/tmp# * **Get metric of a specific AL having mac (02:22:07:6d:5e:d7)** -```json +``` root@iopsys:/tmp# ubus call ieee1905 alme '{"cmd":"ALME-GET-METRIC.request", "data":"02:22:07:6d:5e:d7"}' { "metrics_nr": 1, @@ -284,7 +284,7 @@ root@iopsys:/tmp# ubus call ieee1905 alme '{"cmd":"ALME-GET-METRIC.request", "da #### ieee1905 ubus examples -```json +``` root@iopsys:~# ubus call ieee1905 info { "version": "1905.1a", @@ -305,7 +305,7 @@ root@iopsys:~# ubus call ieee1905 info root@iopsys:~# ``` -```json +``` root@iopsys:~# ubus call ieee1905 interfaces { "interface_nr": 3, @@ -317,7 +317,7 @@ root@iopsys:~# ubus call ieee1905 interfaces } ``` -```json +``` root@iopsys:~# ubus call ieee1905 neighbors { "neighbors_nr": 1, @@ -336,7 +336,7 @@ root@iopsys:~# `ieee1905d` can have multiple `ieee1905.al.<interface-name>` one for each configured al interface. * **Get info of individual al interface** -```json +``` root@iopsys:~# ubus -v call ieee1905.al.br-lan info { "name": "br-lan", @@ -369,7 +369,7 @@ root@iopsys:~# ``` * **Get list of AL entity reachable via this interface** -```json +``` root@iopsys:~# ubus -v call ieee1905.al.br-lan neighbors { "neighbors_nr": 1, @@ -381,7 +381,7 @@ root@iopsys:~# ``` * **Get interface link specific information** -```json +``` root@iopsys:~# ubus -v call ieee1905.al.br-lan link_info { "links": [ @@ -408,7 +408,7 @@ root@iopsys:~# ubus -v call ieee1905.al.br-lan link_info This is a ASYNC command, on invocation ubus reply will have `status` and `mid`, rest of the output will be available on `ieee1905.event` broadcast. In below example, `ubus listen` is used in background to capture the ubus events/broadcast(s). -```json +``` root@iopsys:~# ubus listen & root@iopsys:~# ubus call ieee1905.al.br-lan topology '{"remote_mac":"00:22:07:9f:b7:fc"}' {