Wi-SUN Util API#

The Util Functions component provides helper functions to inform the application about the Wi-SUN PHY configured in the RAIL configuration file.

Functions#

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.

sl_status_t
sl_wisun_util_connect(const uint8_t *network_name)

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.

Parameters
[out]reg_domain

Regulatory domain of the Wi-SUN network

[out]op_class

Operational class of the Wi-SUN network

[out]op_mode

Operational mode of the Wi-SUN network

Returns

  • SL_STATUS_OK if successful, an error code otherwise


Definition at line 50 of file /mnt/raid/workspaces/ws.fy2OGuDyK/overlay/super/protocol/wisun/stack/inc/sl_wisun_util.h

sl_wisun_util_connect#

sl_status_t sl_wisun_util_connect (const uint8_t *network_name)

Connect to a Wi-SUN network.

Parameters
[in]network_name

Name of the Wi-SUN network as a zero-terminated string

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. Returns

  • SL_STATUS_OK if successful, an error code otherwise


Definition at line 61 of file /mnt/raid/workspaces/ws.fy2OGuDyK/overlay/super/protocol/wisun/stack/inc/sl_wisun_util.h