@@ -185,15 +185,22 @@ class WisunInterface : public MeshInterfaceNanostack {
185
185
/* *
186
186
* \brief Set Wi-SUN network size.
187
187
*
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
190
190
* changing the network size.
191
191
*
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.
197
204
*
198
205
* When network size is changed, it will override all or some of the following configuration values:
199
206
* - Timing settings set by set_timing_parameters() of the Wi-SUN interface.
@@ -202,7 +209,7 @@ class WisunInterface : public MeshInterfaceNanostack {
202
209
* When network size is changed, and if timing or RPL values should be other than defaults set by stack for the network size,
203
210
* they need to set again using above function calls.
204
211
*
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 .
206
213
* \return MESH_ERROR_NONE on success.
207
214
* \return MESH_ERROR_UNKNOWN in case of failure.
208
215
* */
0 commit comments