diff --git a/README.md b/README.md index ce24789..d3d399c 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ The package is composed of the following components: The icwmp client is : * tested with several ACS such as **Axiros**, **AVSytem**, **GenieACS**, **OpenACS**, etc... -* supports all required TR069 RPCs. +* supports all required **TR069 RPCs**. * supports all DataModel of TR family such as **TR-181**, **TR-104**, **TR-143**, **TR-157**, **TR-098**, etc... * supports all types of connection requests such as **HTTP**, **XMPP**, **STUN**. -* supports integrated file transfer sudo as **HTTP**, **HTTPS**, **FTP**. +* supports integrated file transfer such as **HTTP**, **HTTPS**, **FTP**. ## Configuration File ## @@ -70,7 +70,7 @@ It defines **acs configuration** (like acs url, acs username, etc...). The possi | `periodic_inform_time` | integer | An absolute time reference to determine when the CPE will initiate the periodic Inform method calls. | | `ParameterKey` | string | Provides the ACS a reliable and extensible means to track changes made by the ACS. | | `dhcp_discovery` | string | if set to **enable**, the CPE will get the url of ACS from DHCP server Option 43. | -| `compression` | boolean | if set to **1**, the CPE must use the HTTP Compression when communicating with the ACS . | +| `compression` | boolean | if set to **1**, the CPE must use the HTTP Compression when communicating with the ACS. | | `retry_min_wait_interval` | integer | The min wait interval of rerty session (in seconds) as described in the standard. | | `retry_interval_multiplier` | integer | The retry interval mulpilier of rerty session as described in the standard. | | `https_ssl_capath` | string | The path of ssl certicafications files. the ssl certification is for Upload and Downlod methods. | @@ -202,7 +202,7 @@ root@iopsys:~# Each object registered with the `'tr069'` namespace has a specific functionality. -To get the status of cwmp client, use the `status` ubus method: +- To get the status of cwmp client, use the `status` ubus method: ``` root@iopsys:~# ubus call tr069 status @@ -231,7 +231,7 @@ root@iopsys:~# ubus call tr069 status root@iopsys:~# ``` -To trigger a new session of notify when a parameter is changed, then use the `notify` ubus method: +- To trigger a new session of notify when a parameter is changed, then use the `notify` ubus method: ``` root@iopsys:~# ubus call tr069 notify @@ -241,7 +241,7 @@ root@iopsys:~# ubus call tr069 notify root@iopsys:~# ``` -To trigger a new session to ACS with the event `'6 CONNECTION REQUEST'` or `'8 DIAGNOSTICS COMPLETE'`, etc.., use the `inform` ubus method with the appropriate `event` argument: +- To trigger a new session to ACS with the event `'6 CONNECTION REQUEST'` or `'8 DIAGNOSTICS COMPLETE'`, etc.., use the `inform` ubus method with the appropriate `event` argument: ``` root@iopsys:~# ubus call tr069 inform '{"event":"6 CONNECTION REQUEST"}' @@ -264,7 +264,7 @@ root@iopsys:~# ubus call tr069 inform '{"GetRPCMethods":"1"}' root@iopsys:~# ``` -To reload the icwmp config, use the `command` ubus method with `reload` argument: +- To reload the icwmp config, use the `command` ubus method with `reload` argument: ``` root@iopsys:~# ubus call tr069 command '{"command":"reload"}' @@ -274,7 +274,7 @@ root@iopsys:~# ubus call tr069 command '{"command":"reload"}' } root@iopsys:~# ``` -To exit the icwmpd daemod, use the `command` ubus method with `exit` argument: +- To exit the icwmpd daemod, use the `command` ubus method with `exit` argument: ``` root@iopsys:~# ubus call tr069 command '{"command":"exit"}' diff --git a/bulkdata/bulkdata.md b/bulkdata/bulkdata.md index eeeade5..421575a 100644 --- a/bulkdata/bulkdata.md +++ b/bulkdata/bulkdata.md @@ -36,7 +36,7 @@ It defines **bulkdata configuration**: enable and log\_level. | Name | Type | Description | | ----------- | ------- | ----------------------------------------------------------------------------------------------- | -| `enable` | boolean | Enables the BulkData feature if set to "1". | +| `enable` | boolean | Enables the BulkData feature if set to **1**. | | `log_level` | integer | Specifies the log type to use, by default **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**. | ### profile section ### diff --git a/twamp/twamp.md b/twamp/twamp.md index 0d5cdf7..829fecb 100644 --- a/twamp/twamp.md +++ b/twamp/twamp.md @@ -5,7 +5,7 @@ icwmp_twampd is an implementation of the Two-Way Active Measurement Protocol (TW ## Configuration File ## -The icwmp_twampd UCI configuration is located in **'/etc/config/cwmp\_twamp'**, and contains 2 sections the **twam** and the **twamp\_reflector**. +The icwmp_twampd UCI configuration is located in **'/etc/config/cwmp\_twamp'**, and contains 2 sections the **twamp** and the **twamp\_reflector**. ``` config cwmp 'twamp' @@ -30,8 +30,8 @@ It defines **the twamp configuration**: id, log_level. The possible options for | Name | Type | Description | | --------- | ------- | ------------------------------------------- | -| id | integer | Specifies the id of TWAMP reflector to use. | -| log_level | integer | Specifies the log type to use, by default **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**. | +| `id` | integer | Specifies the id of TWAMP reflector to use. | +| `log_level` | integer | Specifies the log type to use, by default **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**. | ### twamp_reflector section ### @@ -39,13 +39,13 @@ It describes **the twamp reflector configuration**: id, ip\_version, etc... The | Name | Type | Description | | ---------- | ------- | ------------------------------ | -| id | integer | Specifies the TWAMP id to use. | -| enable | boolean | If set to **1**, it enables the TWAMP reflector. | -| ip_version | integer | Specifies the IP version to use, 4 by default. The possible versions are 4 and 6. | -| port | integer | Specifies the port to listen on. | -| max_ttl | integer | Specifies the maximum TTL of a received packet, that the TWAMP reflector will reflect to the TWAMP controller. | -| ip_list | string | Specifies the allowed source IP addresses and subnets to handle test packets. | -| port_list | string | Specifies the range of source ports allowed to use for twamp\_reflector tests. | +| `id` | integer | Specifies the TWAMP id to use. | +| `enable` | boolean | If set to **1**, it enables the TWAMP reflector. | +| `ip_version` | integer | Specifies the IP version to use, **4** by default. The possible versions are **4** and **6**. | +| `port` | integer | Specifies the port to listen on. | +| `max_ttl` | integer | Specifies the maximum TTL of a received packet, that the TWAMP reflector will reflect to the TWAMP controller. | +| `ip_list` | string | Specifies the allowed source IP addresses and subnets to handle test packets. | +| `port_list` | string | Specifies the range of source ports allowed to use for twamp\_reflector tests. | ## Dependencies ## diff --git a/udpechoserver/udpechoserver.md b/udpechoserver/udpechoserver.md index bea4fe0..1b5185f 100644 --- a/udpechoserver/udpechoserver.md +++ b/udpechoserver/udpechoserver.md @@ -26,7 +26,7 @@ It defines **the udpechoserver configuration** such as enable, interface, addres | `interface` | string | Specifies the interface on which the CPE MUST listen and receive UDP echo requests. | | `address` | string | Specifies the source IP address which can make an UDP echo requests. | | `server_port` | integer | The UDP port on which the UDP Echo server MUST listen and respond to UDP echo requests. | -| `plus` | boolean | If set to 1, the CPE will perform necessary packet processing for UDP Echo Plus packets. | +| `plus` | boolean | If set to **1**, the CPE will perform necessary packet processing for UDP Echo Plus packets. | | `log_level` | integer | Specifies the log type to use, by default it is set to **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**. |