Skip to content

Commit c5fee38

Browse files
author
Arto Kinnunen
committed
Improve WisunInterface set_network_size docs
Clarify set_network_size usage and possible parameter values.
1 parent 01b541b commit c5fee38

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunInterface.h

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -185,15 +185,22 @@ class WisunInterface : public MeshInterfaceNanostack {
185185
/**
186186
* \brief Set Wi-SUN network size.
187187
*
188-
* Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time.
189-
* If device is already connected to the Wi-SUN network then device will restart network discovery after
188+
* Function stores network size parameter to the mbed-mesh-api and uses it when connect() is called for the next
189+
* time. If device is already connected to the Wi-SUN network then device will restart network discovery after
190190
* changing the network size.
191191
*
192-
* Default value: medium
193-
* Small network size: less than hundred devices
194-
* Medium network size: hundreds of devices
195-
* Large network size: thousands of devices
196-
* Certificate: used on testing
192+
* It is recommended to set the correct network size because the Wi-SUN network configuration parameters are
193+
* adjusted based on the selected network size. A network configured for a small amount of devices may not work
194+
* optimally for large amount of devices.
195+
*
196+
* The network size is measured as hundreds of devices. For example:
197+
* - set network size to 1 to use Wi-SUN network with less than 100 devices (small).
198+
* - set network size to 8 to use Wi-SUN network with 100-800 devices (medium).
199+
* - set network size to 15 to use Wi-SUN network with 800-1500 devices (large).
200+
* - set network size to 25 to use Wi-SUN network with more than 2500 devices (xlarge).
201+
* - set network size to 0 to run certification tests.
202+
*
203+
* By default Wi-SUN stack is configured to use medium sized network.
197204
*
198205
* When network size is changed, it will override all or some of the following configuration values:
199206
* - Timing settings set by set_timing_parameters() of the Wi-SUN interface.
@@ -202,7 +209,7 @@ class WisunInterface : public MeshInterfaceNanostack {
202209
* When network size is changed, and if timing or RPL values should be other than defaults set by stack for the network size,
203210
* they need to set again using above function calls.
204211
*
205-
* \param network_size Network size in hundreds of devices (e.g. 1200 devices is 12), 0x00 for network size certificate.
212+
* \param network_size Network size in hundreds of devices (e.g. 1200 devices is 12), 0 for certificate testing.
206213
* \return MESH_ERROR_NONE on success.
207214
* \return MESH_ERROR_UNKNOWN in case of failure.
208215
* */

0 commit comments

Comments
 (0)