Wi-SUN API availability#

Availability of Wi-SUN API capabilities depends on the library used by the application:

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

  • LFN library contains Limited Function Node capability.

  • Full library contains 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.

  • BR library contains Border Router functionality.

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.

  • BR library when wisun_br_stack component is selected. This library cannot be combined with the other libraries.

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

BR

sl_wisun_join

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

sl_wisun_get_ip_address

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

sl_wisun_disconnect

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

sl_wisun_set_trusted_certificate

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_device_certificate

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

sl_wisun_set_device_private_key

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_statistics

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_tx_power

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_allowed_channel_mask

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_channel_mask

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_allow_mac_address

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_deny_mac_address

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_join_state

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

sl_wisun_clear_credential_cache

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_mac_address

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_mac_address

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_reset_statistics

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_neighbor_count

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_neighbors

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_neighbor_info

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_unicast_settings

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

checkmarkcheckmark

sl_wisun_set_device_private_key_id

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_regulation

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_neighbor_table_size

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_regulation_tx_thresholds

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_advert_fragment_duration

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

checkmarkcheckmark

sl_wisun_set_device_type

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_config_mode_switch

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_mode_switch

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_connection_parameters

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_set_pom_ie

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_pom_ie

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_stack_version

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_lfn_parameters

checkmarkcheckmark

Red XRed X

checkmarkcheckmark

Red XRed X

sl_wisun_set_lfn_support

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_set_pti_state

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_trigger_frame

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_security_state

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_network_info

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_get_rpl_info

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

checkmarkcheckmark

sl_wisun_get_excluded_channel_mask

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_tx_power_ddbm

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_set_leaf

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_set_direct_connect_state

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_accept_direct_connect_link

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_set_direct_connect_pmk

checkmarkcheckmark

checkmarkcheckmark

Red XRed X

Red XRed X

sl_wisun_set_phy_sensitivity

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

checkmarkcheckmark

sl_wisun_br_start

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_stop

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_gtk

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_network_size

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_get_ip_addresses

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_get_gak

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_get_state

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_device_certificate

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_broadcast_settings

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_connection_parameters

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_lfn_parameters

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_lfn_support

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_dhcp_vendor_data

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_pan_defect_advertise

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_ipv6_prefix

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_set_ipv6_up_handler

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark

sl_wisun_br_ipv6_down

Red XRed X

Red XRed X

Red XRed X

checkmarkcheckmark