ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #14442 from artokin/update_set_network_size_doc_master 

Improve WisunInterface set_network_size docs
pull/14495/head
Anna Bridge 2021-03-29 11:22:36 +01:00 committed by GitHub
parent 7f6ff7e61b e91f9cb6a1
commit cbc6209a11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
connectivity/nanostack/mbed-mesh-api/mbed-mesh-api/WisunInterface.h
View File

@ -160,24 +160,31 @@ public:
/**
* \brief Set Wi-SUN network size.
*
* Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time.
* If device is already connected to the Wi-SUN network then device will restart network discovery after
* changing the network size.
* Function stores network size parameter to the mbed-mesh-api and uses it when connect() is called for the next
* time. If a device is already connected to the Wi-SUN network, then the device will restart network discovery
* after changing the network size.
*
* Default value: medium
* Small network size: less than hundred devices
* Medium network size: hundreds of devices
* Large network size: thousands of devices
* Certificate: used on testing
* It is recommended to set the correct network size because some Wi-SUN network configuration parameters are
* adjusted based on the selected network size. A network configured for a small amount of devices may not work
* optimally for large number of devices. This is because the network bandwidth is divided with all the devices in
* the network. Enough bandwidth must be reserved for application data usage as well as the Wi-SUN network
* operations. In addition, the application should adapt to the network characteristics by using the InternetSocket
* methods get_stagger_estimate_to_address() and get_rtt_estimate_to_address().
*
* When network size is changed, it will override all or some of the following configuration values:
* - Timing settings set by set_timing_parameters() of the Wi-SUN interface.
* - RPL settings set by rpl_parameters_set() of the Border Router interface.
* The network size is measured as hundreds of devices that are expected to join to the network. For example,
* for a 400-device network set network size to 4.
*
* When network size is changed, and if timing or RPL values should be other than defaults set by stack for the network size,
* they need to set again using above function calls.
* The Wi-SUN stack will automatically adjust timing and RPL configuration values based on the selected network
* size and data rate. If a customized timing or RPL values are needed, the APIs below should be invoked after
* changing the network size:
* - set_timing_parameters() to set timing settings to the Wi-SUN interface.
* - rpl_parameters_set() to set RPL settings to the Border Router interface.
*
* \param network_size Network size in hundreds of devices (e.g. 1200 devices is 12), 0x00 for network size certificate.
* By default the Wi-SUN stack is configured to use a few hundreds of devices.
*
* The network size should be set to 0 when running certification tests.
*
* \param network_size Network size in hundreds of devices (e.g. 12 for 1200 devices), 0 for certificate testing.
* \return MESH_ERROR_NONE on success.
* \return MESH_ERROR_UNKNOWN in case of failure.
* */

2
connectivity/nanostack/mbed-mesh-api/mbed_lib.json
View File

@ -121,7 +121,7 @@
"value": "\"Wi-SUN Network\""
},
"wisun-network-size": {
"help": "Expected amount of devices in the network as 100s of devices. with possible pre defined constants NETWORK_SIZE_SMALL, NETWORK_SIZE_MEDIUM, NETWORK_SIZE_LARGE, NETWORK_SIZE_XLARGE. if set to 0 Wi-SUN Certification configuration values are used. If don't define this(default null), then NETWORK_SIZE_MEDIUM will be used.",
"help": "Expected amount of devices in the network as hundreds of devices. Use any number or one of the predefined values NETWORK_SIZE_SMALL, NETWORK_SIZE_MEDIUM, NETWORK_SIZE_LARGE or NETWORK_SIZE_XLARGE. Set to 0 to use Wi-SUN Certification configuration values. If set to null, then NETWORK_SIZE_MEDIUM (meaning hundreds of devices in the network) will be used.",
"value": null
},
"wisun-regulatory-domain": {