@@ -189,35 +189,26 @@ class WisunInterface : public MeshInterfaceNanostack {
189
189
* time. If a device is already connected to the Wi-SUN network, then the device will restart network discovery
190
190
* after changing the network size.
191
191
*
192
- * It is recommended to set the correct network size because the Wi-SUN network configuration parameters are
192
+ * It is recommended to set the correct network size because some Wi-SUN network configuration parameters are
193
193
* adjusted based on the selected network size. A network configured for a small amount of devices may not work
194
194
* optimally for large number of devices. This is because the network bandwidth is divided with all the devices in
195
195
* the network. Enough bandwidth must be reserved for application data usage as well as the Wi-SUN network
196
- * operations. Application should adapt to the network characteristics by using the InternetSocket methods
197
- * get_stagger_estimate_to_address and get_rtt_estimate_to_address.
196
+ * operations. In addition, the application should adapt to the network characteristics by using the InternetSocket
197
+ * methods get_stagger_estimate_to_address() and get_rtt_estimate_to_address() .
198
198
*
199
199
* The network size is measured as hundreds of devices that are expected to join to the network. For example,
200
- * for a 400-device network set network size to 4. The Wi-SUN stack will internally use one of the four possible
201
- * configuration buckets based on the selected network size and data rate. The configuration buckets are defined
202
- * for a small, medium, large and xlarge networks.
200
+ * for a 400-device network set network size to 4.
203
201
*
204
- * For example, with 150kbs data rate set network size to:
205
- * - 1 to use small configuration bucket.
206
- * - 8 to use medium configuration bucket.
207
- * - 15 to use large configuration bucket .
208
- * - 25 to use xlarge configuration bucket .
202
+ * The Wi-SUN stack will automatically adjust timing and RPL configuration values based on the selected network
203
+ * size and data rate. If a customized timing or RPL values are needed, the APIs below should be invoked after
204
+ * changing the network size:
205
+ * - set_timing_parameters() to set timing settings to the Wi-SUN interface .
206
+ * - rpl_parameters_set() to set RPL settings to the Border Router interface .
209
207
*
210
- * By default Wi-SUN stack is configured to use medium sized network .
208
+ * By default the Wi-SUN stack is configured to use a few hundreds of devices .
211
209
*
212
210
* The network size should be set to 0 when running certification tests.
213
211
*
214
- * When the network size is changed, it will override all or some of the following configuration values:
215
- * - Timing settings set by set_timing_parameters() of the Wi-SUN interface.
216
- * - RPL settings set by rpl_parameters_set() of the Border Router interface.
217
- *
218
- * When the network size is changed, and if timing or RPL values should be other than defaults set by stack for the
219
- * network size, they need to set again using above function calls.
220
- *
221
212
* \param network_size Network size in hundreds of devices (e.g. 12 for 1200 devices), 0 for certificate testing.
222
213
* \return MESH_ERROR_NONE on success.
223
214
* \return MESH_ERROR_UNKNOWN in case of failure.
0 commit comments