Util Functions#
The Util Functions component provides helper functions to inform the application about the Wi-SUN PHY configured in the RAIL configuration file.
Functions#
Get frequency band settings of the first RAIL configuration listed in RAIL's channelConfigs array.
Get PHY settings of the first RAIL configuration listed in RAIL's channelConfigs array.
Connect to a Wi-SUN network.
Function Documentation#
sl_wisun_util_get_rf_settings#
sl_status_t sl_wisun_util_get_rf_settings (uint8_t * reg_domain, uint8_t * op_class, uint16_t * op_mode)
Get frequency band settings of the first RAIL configuration listed in RAIL's channelConfigs array.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t * | [out] | reg_domain | Regulatory domain of the Wi-SUN network |
uint8_t * | [out] | op_class | Operational class of the Wi-SUN network |
uint16_t * | [out] | op_mode | Operational mode of the Wi-SUN network |
Returns
SL_STATUS_OK if successful, an error code otherwise
One of the following:
SL_STATUS_OK if successful
SL_STATUS_INVALID_CONFIGURATION if a configuration that cannot be managed by the plugin is used
SL_STATUS_FAIL if an other error occured
Warnings
Do not call this function while the Wi-SUN stack is started.
DeprecatedThis function will be removed in the future versions of the Wi-SUN stack. See sl_wisun_util_get_phy_config() for a replacement.
sl_wisun_util_get_phy_config#
sl_status_t sl_wisun_util_get_phy_config (sl_wisun_phy_config_t * phy_config)
Get PHY settings of the first RAIL configuration listed in RAIL's channelConfigs array.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_wisun_phy_config_t * | [out] | phy_config | Pointer to PHY configuration |
Returns
SL_STATUS_OK if successful, an error code otherwise
One of the following:
SL_STATUS_OK if successful
SL_STATUS_INVALID_CONFIGURATION if a configuration that cannot be managed by the plugin is used
SL_STATUS_FAIL if an other error occured
Warnings
Do not call this function while the Wi-SUN stack is started.
sl_wisun_util_connect#
sl_status_t sl_wisun_util_connect (const uint8_t * network_name)
Connect to a Wi-SUN network.
Type | Direction | Argument Name | Description |
---|---|---|---|
const uint8_t * | [in] | network_name | Name of the Wi-SUN network as a zero-terminated string |
Returns
SL_STATUS_OK if successful, an error code otherwise
One of the following:
SL_STATUS_OK if successful
SL_STATUS_INVALID_CONFIGURATION if a configuration that cannot be managed by the plugin is used
SL_STATUS_FAIL if an other error occured
Since Wi-SUN frequency band settings are deduced from first RAIL configuration listed in RAIL's channelConfigs array, using this function is not recommended if more than one RAIL configuration is described.