Application Core#

app_wisun_project_info_init#

void app_wisun_project_info_init (const char * app_name)

Initialize Wi-SUN project information.

Init internal instance

app_wisun_project_info_print#

void app_wisun_project_info_print (const bool json_format)

Print Wi-SUN project information.

Print project info in pretty or json format.

app_wisun_project_info_get#

const app_project_info_t * app_wisun_project_info_get (void )

Get Wi-SUN Project info.

Get a constant instance of internal Wi-SUN project info Returns

• app_project_info_t * Project info

app_wisun_wait_for_connection#

void app_wisun_wait_for_connection (void )

Wait for the connection.

This function doesn't call the app_wisun_network_connect() function. The function provides a delay loop with optional heart beat printing till the connection state has not been changed.

app_wisun_connect_and_wait#

void app_wisun_connect_and_wait (void )

Connect and wait for connection.

The function calls app_wisun_network_connect() function and app_wisun_wait_for_connection() function. It can be useful at the beginning of application thread.

app_wisun_network_is_connected#

bool app_wisun_network_is_connected (void )

The network is connected.

Wrapper function of join state getter Returns

• true Connected

• false Not connected

app_wisun_dispatch_thread#

void app_wisun_dispatch_thread (void )

Thread dispatch function.

For low power LFN mode, the delay value is 'APP_THREAD_LP_DISPATCH_MS', for FFN mode, the delay is 1ms

app_wisun_core_init#

void app_wisun_core_init (void )

Initialize Wi-SUN application core.

Initializing mutex, socket handler and set Wi-SUN settings.

app_wisun_core_get_error#

bool app_wisun_core_get_error (app_core_error_state_flag_t flag)

Get application core error.

The function retrieves the application core error status based on the flag. Returns

• bool True if error flag is set, otherwise false

app_wisun_network_connect#

void app_wisun_network_connect (void )

Connect to the Wi-SUN network.

Network initialization and connection. The function initializes the network with parameters (Network name, TX Power, Network size, etc.) by the stored settings in NVM if the settings component is added to the project, otherwise with the default settings.

app_wisun_get_current_addresses#

void app_wisun_get_current_addresses (current_addr_t *const dest_addresses)

Get the current addresses.

Copy cached addresses into destination.

app_wisun_set_regulation_active#

void app_wisun_set_regulation_active (bool enabled)

Set the regional regulation to active or passive.

After a stack API call for regional regulation, this function can be used to store the status of the regulation (active or not).

app_wisun_get_regulation_active#

bool app_wisun_get_regulation_active (void )

Return the state of the regional regulation.

This function tells the caller if a regulation is currently active. Returns

• Boolean indicating if a regional regulation is currently active.

app_wisun_get_remaining_tx_budget#

bool app_wisun_get_remaining_tx_budget (uint32_t *const budget_out)

Get the remaining budget from the transmission quota.

Returns the state of the regional regulation and the remaining budget in ms if applicable, or zero budget if exceeded or not regulated. Returns

• Boolean to indicate if the returned value reflects a usable value.

app_wisun_set_regulation_thresholds#

void app_wisun_set_regulation_thresholds (const int8_t warning_level, const int8_t alert_level)

Set up warning and alert thresholds for the regional regulation.

Sets up the percentages of warnings and alerts where the regulation indicate that the transmission quota is approached/exceeded.

app_wisun_get_regulation_thresholds#

bool app_wisun_get_regulation_thresholds (regulation_thresholds_t * thresholds_out)

Get the warning and alert levels for approaching/exceeded the TX budget.

Values representing percentages of the allowed transmission quota in ms are returned for the warning and alert levels, respectively. Returns

• Boolean to indicate if the operation was successful

app_wisun_get_join_state#

sl_wisun_join_state_t app_wisun_get_join_state (void )

Get Wi-SUN join state.

Thread-safe getter to get connection state. Join state is stored in appropriate event callback. Returns

• sl_wisun_join_state_t Join state value.

app_wisun_get_time_stat#

void app_wisun_get_time_stat (app_core_time_stat_t *const tstat)

Get time statistic.

Create a copy of time statistic storage with up-to-date values