Modules#
Application Core API type definitions
Application Core#
The Application Core component aims at providing utilities common to most Wi-SUN applications. Following this objective, the component offers the following features:
A Wi-SUN connection helper function app_wisun_network_connect() configures the network size setting, the TX output power, the certificates, and keys. The last function action is to start the Wi-SUN connection process. The app_wisun_network_is_connected() function provides a simple connection status getter too.
Event handlers for basic Wi-SUN network events component includes the basic event handler implementations.
Available addresses. Retrieve known IPv6 addresses with the app_wisun_get_current_addresses() function.
Error Getter. Use app_wisun_core_get_error() function to get the status of the Stack API calls.
To use the component in your application, add it to your project and initialize it with app_wisun_core_init().
#
Print Wi-SUN project information.
Wait for the connection.
Connect and wait for connection.
The network is connected.
Functions#
Initialize Wi-SUN application core.
Get application core error.
Connect to the Wi-SUN network.
Get the current addresses.
Set the regional regulation to active or passive.
Return the state of the regional regulation.
Get the remaining budget from the transmission quota.
Set up warning and alert thresholds for the regional regulation.
Get the warning and alert levels for approaching/exceeded the TX budget.
Get Wi-SUN join state.
undefined Documentation#
app_wisun_project_info_init#
void app_wisun_project_info_init (const char * app_name)
[in] | app_name | Application name |
Initialize Wi-SUN project information.
Init internal instance
94
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core_util.h
app_wisun_project_info_print#
void app_wisun_project_info_print (const bool json_format)
Print Wi-SUN project information.
[in] | json_format | Json format required indicator |
Print project info in pretty or json format.
101
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core_util.h
app_wisun_wait_for_connection#
void app_wisun_wait_for_connection (void )
Wait for the connection.
N/A |
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.
109
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core_util.h
app_wisun_connect_and_wait#
void app_wisun_connect_and_wait (void )
Connect and wait for connection.
N/A |
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.
117
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core_util.h
app_wisun_network_is_connected#
bool app_wisun_network_is_connected (void )
The network is connected.
N/A |
Wrapper function of join state getter Returns
true Connected
false Not connected
125
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core_util.h
Function Documentation#
app_wisun_core_init#
void app_wisun_core_init (void )
Initialize Wi-SUN application core.
N/A |
Initializing mutex, socket handler and set Wi-SUN settings.
123
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_core_get_error#
bool app_wisun_core_get_error (app_core_error_state_flag_t flag)
Get application core error.
[in] | flag | is the indicator of the error |
The function retrieves the application core error status based on the flag. Returns
bool True if error flag is set, otherwise false
132
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_network_connect#
void app_wisun_network_connect (void )
Connect to the Wi-SUN network.
N/A |
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.
143
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_get_current_addresses#
void app_wisun_get_current_addresses (current_addr_t *const dest_addresses)
Get the current addresses.
[out] | dest_addresses | Destination |
Copy cached addresses into destination.
150
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_set_regulation_active#
void app_wisun_set_regulation_active (bool enabled)
Set the regional regulation to active or passive.
[in] | enabled | (true = active, false = not active) |
After a stack API call for regional regulation, this function can be used to store the status of the regulation (active or not).
158
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_get_regulation_active#
bool app_wisun_get_regulation_active (void )
Return the state of the regional regulation.
N/A |
This function tells the caller if a regulation is currently active. Returns
Boolean indicating if a regional regulation is currently active.
165
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
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.
[out] | budget_out | pointer to return the remaining budget to. |
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.
174
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
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.
[in] | warning_level | new percentage for the warning threshold |
[in] | alert_level | new percentage for the alert threshold |
Sets up the percentages of warnings and alerts where the regulation indicate that the transmission quota is approached/exceeded.
183
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
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.
[out] | thresholds_out | pointer to the struct to hold the thresholds |
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
192
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h
app_wisun_get_join_state#
sl_wisun_join_state_t app_wisun_get_join_state (void )
Get Wi-SUN join state.
N/A |
Thread-safe getter to get connection state. Join state is stored in appropriate event callback. Returns
sl_wisun_join_state_t Join state value.
200
of file /mnt/raid/workspaces/ws.0wy4DfJrj/overlay/gsdk/app/wisun/component/app_core/sl_wisun_app_core.h