XCORE SDK
XCORE Software Development Kit
Public Attributes | List of all members
sl_wfx_set_roam_parameters_req_body_s Struct Reference

Request message body for sl_wfx_set_roam_parameters_req_t. More...

#include <sl_wfx_cmd_api.h>

Public Attributes

uint8_t rcpi_threshold
 Received Channel Power Indicator (RCPI) limit for a roaming attempt. More...
 
uint8_t rcpi_hysteresis
 Upper RCPI limit that must be attained before triggering roaming again. More...
 
uint8_t beacon_lost_count
 Beacon loss limit for a roaming attempt. More...
 
uint8_t channel_list_count
 The amount of specific channels to scan. More...
 
uint8_t channel_number []
 List of specific channels to scan. More...
 

Detailed Description

Request message body for sl_wfx_set_roam_parameters_req_t.

Field Default value Reset to default value
rcpi_threshold 60 when device reset
rcpi_hysteresis 120 when device reset
beacon_lost_count 10 when device reset
channel_list_count 13 when device reset
channel_number 1 to 13 when device reset


Member Data Documentation

◆ beacon_lost_count

uint8_t sl_wfx_set_roam_parameters_req_body_s::beacon_lost_count

Beacon loss limit for a roaming attempt.

0: The device will set the limit value to the device default.
1 - 255: Beacon loss limit for a roaming attempt.

◆ channel_list_count

uint8_t sl_wfx_set_roam_parameters_req_body_s::channel_list_count

The amount of specific channels to scan.

0: The device will set the channel list to the device default.
1 - 13: The amount of specific channels to scan.

◆ channel_number

uint8_t sl_wfx_set_roam_parameters_req_body_s::channel_number[]

List of specific channels to scan.

1 - 13: The channel number to scan per byte.
Must contain the same number of channels as specified in channel_list_count.
See Scanning for further details.

◆ rcpi_hysteresis

uint8_t sl_wfx_set_roam_parameters_req_body_s::rcpi_hysteresis

Upper RCPI limit that must be attained before triggering roaming again.

0: The device will set the limit value to the device default.
1 - 220: RCPI limit to re-enable automatic roaming based on RCPI. This value is used to prevent automatic roaming from triggering again and again while the signal strength stays close to the rcpi_threshold value. rcpi_hysteresis should be set to a value grater than rcpi_threshold.
See Received Channel Power Indicator for further details.

◆ rcpi_threshold

uint8_t sl_wfx_set_roam_parameters_req_body_s::rcpi_threshold

Received Channel Power Indicator (RCPI) limit for a roaming attempt.

0: The device will set the limit value to the device default.
1 - 220: RCPI limit for a roaming attempt.
See Received Channel Power Indicator for further details.


The documentation for this struct was generated from the following file: