Wi-SUN API availability#

The Wi-SUN stack is distributed in three different libraries containing different capabilities:

  • FFN library containing Full Function Node capability. This library also includes LFN parenting ability for FAN1.1.

  • LFN library containing Limited Function Node capability.

  • Full library containing both of the above. This larger but more flexible library is provided as a convenience for prototyping. This library allows to choose between FFN and LFN role at runtime, but does not support switching roles on the fly and requires a full board reset to do so.

The libraries are selected using Simplicity SDK components:

  • FFN library when only wisun_stack_ffn component is selected.

  • LFN library when only wisun_stack_lfn component is selected.

  • Full library when both components are selected.

  • FFN library by default when no component is selected.

The API available to each library may vary according to the table below. A status SL_STATUS_NOT_AVAILABLE is returned if the API called with a library flavor that does not support it.

API Name

Full

FFN

LFN

sl_wisun_join

checkmark

checkmark

checkmark

sl_wisun_get_ip_address

checkmark

checkmark

checkmark

sl_wisun_disconnect

checkmark

checkmark

checkmark

sl_wisun_set_trusted_certificate

checkmark

checkmark

checkmark

sl_wisun_set_device_certificate

checkmark

checkmark

checkmark

sl_wisun_set_device_private_key

checkmark

checkmark

checkmark

sl_wisun_get_statistics

checkmark

checkmark

checkmark

sl_wisun_set_tx_power

checkmark

checkmark

checkmark

sl_wisun_set_allowed_channel_mask

checkmark

checkmark

checkmark

sl_wisun_set_channel_mask

checkmark

checkmark

checkmark

sl_wisun_allow_mac_address

checkmark

checkmark

checkmark

sl_wisun_deny_mac_address

checkmark

checkmark

checkmark

sl_wisun_get_join_state

checkmark

checkmark

checkmark

sl_wisun_clear_credential_cache

checkmark

checkmark

checkmark

sl_wisun_get_mac_address

checkmark

checkmark

checkmark

sl_wisun_set_mac_address

checkmark

checkmark

checkmark

sl_wisun_reset_statistics

checkmark

checkmark

checkmark

sl_wisun_get_neighbor_count

checkmark

checkmark

checkmark

sl_wisun_get_neighbors

checkmark

checkmark

checkmark

sl_wisun_get_neighbor_info

checkmark

checkmark

checkmark

sl_wisun_set_unicast_settings

checkmark

checkmark

Red X

sl_wisun_set_device_private_key_id

checkmark

checkmark

checkmark

sl_wisun_set_regulation

checkmark

checkmark

checkmark

sl_wisun_set_neighbor_table_size

checkmark

checkmark

checkmark

sl_wisun_set_regulation_tx_thresholds

checkmark

checkmark

checkmark

sl_wisun_set_advert_fragment_duration

checkmark

checkmark

Red X

sl_wisun_set_device_type

checkmark

checkmark

checkmark

sl_wisun_config_mode_switch

checkmark

checkmark

checkmark

sl_wisun_set_mode_switch

checkmark

checkmark

checkmark

sl_wisun_set_connection_parameters

checkmark

checkmark

Red X

sl_wisun_set_pom_ie

checkmark

checkmark

checkmark

sl_wisun_get_pom_ie

checkmark

checkmark

checkmark

sl_wisun_get_stack_version

checkmark

checkmark

checkmark

sl_wisun_set_lfn_parameters

checkmark

Red X

checkmark

sl_wisun_set_lfn_support

checkmark

checkmark

Red X

sl_wisun_set_pti_state

checkmark

checkmark

checkmark

sl_wisun_trigger_frame

checkmark

checkmark

checkmark

sl_wisun_set_security_state

checkmark

checkmark

checkmark

sl_wisun_get_network_info

checkmark

checkmark

checkmark

sl_wisun_get_rpl_info

checkmark

checkmark

Red X

sl_wisun_get_excluded_channel_mask

checkmark

checkmark

checkmark