@@ -164,35 +164,26 @@ class WisunInterface final : public MeshInterfaceNanostack {
164
164
* time. If a device is already connected to the Wi-SUN network, then the device will restart network discovery
165
165
* after changing the network size.
166
166
*
167
- * It is recommended to set the correct network size because the Wi-SUN network configuration parameters are
167
+ * It is recommended to set the correct network size because some Wi-SUN network configuration parameters are
168
168
* adjusted based on the selected network size. A network configured for a small amount of devices may not work
169
169
* optimally for large number of devices. This is because the network bandwidth is divided with all the devices in
170
170
* the network. Enough bandwidth must be reserved for application data usage as well as the Wi-SUN network
171
- * operations. Application should adapt to the network characteristics by using the InternetSocket methods
172
- * get_stagger_estimate_to_address and get_rtt_estimate_to_address.
171
+ * operations. In addition, the application should adapt to the network characteristics by using the InternetSocket
172
+ * methods get_stagger_estimate_to_address() and get_rtt_estimate_to_address() .
173
173
*
174
174
* The network size is measured as hundreds of devices that are expected to join to the network. For example,
175
- * for a 400-device network set network size to 4. The Wi-SUN stack will internally use one of the four possible
176
- * configuration buckets based on the selected network size and data rate. The configuration buckets are defined
177
- * for a small, medium, large and xlarge networks.
175
+ * for a 400-device network set network size to 4.
178
176
*
179
- * For example, with 150kbs data rate set network size to:
180
- * - 1 to use small configuration bucket.
181
- * - 8 to use medium configuration bucket.
182
- * - 15 to use large configuration bucket .
183
- * - 25 to use xlarge configuration bucket .
177
+ * The Wi-SUN stack will automatically adjust timing and RPL configuration values based on the selected network
178
+ * size and data rate. If a customized timing or RPL values are needed, the APIs below should be invoked after
179
+ * changing the network size:
180
+ * - set_timing_parameters() to set timing settings to the Wi-SUN interface .
181
+ * - rpl_parameters_set() to set RPL settings to the Border Router interface .
184
182
*
185
- * By default Wi-SUN stack is configured to use medium sized network .
183
+ * By default the Wi-SUN stack is configured to use a few hundreds of devices .
186
184
*
187
185
* The network size should be set to 0 when running certification tests.
188
186
*
189
- * When the network size is changed, it will override all or some of the following configuration values:
190
- * - Timing settings set by set_timing_parameters() of the Wi-SUN interface.
191
- * - RPL settings set by rpl_parameters_set() of the Border Router interface.
192
- *
193
- * When the network size is changed, and if timing or RPL values should be other than defaults set by stack for the
194
- * network size, they need to set again using above function calls.
195
- *
196
187
* \param network_size Network size in hundreds of devices (e.g. 12 for 1200 devices), 0 for certificate testing.
197
188
* \return MESH_ERROR_NONE on success.
198
189
* \return MESH_ERROR_UNKNOWN in case of failure.
0 commit comments