Wi-SUN Stack API#

sl_wisun_on_event#

void sl_wisun_on_event (sl_wisun_evt_t * evt)

Callback handler for a single event.

This function is called when the stack sends an event to the application. The application can declare its own version this function to customize event handling. The default implementation discards all events.

See Also

• Wi-SUN API events

sl_wisun_allow_mac_address#

sl_status_t sl_wisun_allow_mac_address (const sl_wisun_mac_address_t * address)

Add a MAC address to the list of allowed addresses.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function adds a MAC address to the list of allowed addresses. When the first address is added to the list, the list of denied addresses is cleared and the device will start preventing communication with any device whose MAC address does not match any of addresses on the list. By default, all MAC addresses are allowed. Up to 10 MAC addresses may be added to the list. The access list affects only directly connected nodes such as parents, children, and neighbors.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_clear_credential_cache#

sl_status_t sl_wisun_clear_credential_cache ()

Clear the credential cache.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function clears the cached authentication credentials stored in non-volatile storage. The function is intended for test purposes. Note that clearing the credential cache may prevent the node from reconnecting to the same parent until the corresponding cache entry has expired on the parent.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_config_mode_switch#

sl_status_t sl_wisun_config_mode_switch (uint8_t mode, uint8_t phy_mode_id, const sl_wisun_mac_address_t * neighbor_address, bool reserved)

Set the mode switch configuration.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_deny_mac_address#

sl_status_t sl_wisun_deny_mac_address (const sl_wisun_mac_address_t * address)

Add a MAC address to the list of denied addresses.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function adds a MAC address to the list of denied addresses. When the first address is added to the list, the list of allowed addresses is cleared and the device will start preventing communication with any device whose MAC address matches any of the addresses on the list. By default, all MAC addresses are allowed. Up to 10 MAC addresses may be added to the list. The access list affects only directly connected nodes such as parents, children, and neighbors.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_disconnect#

sl_status_t sl_wisun_disconnect ()

Disconnect from the Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function disconnects an active connection or cancels an ongoing connection attempt.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_excluded_channel_mask#

sl_status_t sl_wisun_get_excluded_channel_mask (sl_wisun_channel_mask_type_t type, sl_wisun_channel_mask_t * channel_mask, uint8_t * channel_count)

Get the mask of channels excluded from channel plan.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_ip_address#

sl_status_t sl_wisun_get_ip_address (sl_wisun_ip_address_type_t address_type, in6_addr_t * address)

Read an IP address.

Returns

• SL_STATUS_OK if successful, an error code otherwise.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_join_state#

sl_status_t sl_wisun_get_join_state (sl_wisun_join_state_t * join_state)

Get the current join state.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function retrieves the current state of the connection process. The function can only be used once a connection has been initiated.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_mac_address#

sl_status_t sl_wisun_get_mac_address (sl_wisun_mac_address_t * address)

Get the current device MAC address in use.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_neighbor_count#

sl_status_t sl_wisun_get_neighbor_count (uint8_t * neighbor_count)

Get the number of RPL neighbors (parents and children).

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_neighbor_info#

sl_status_t sl_wisun_get_neighbor_info (const sl_wisun_mac_address_t * neighbor_mac_address, sl_wisun_neighbor_info_t * neighbor_info)

Get information about a RPL neighbor (parent or child).

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_neighbors#

sl_status_t sl_wisun_get_neighbors (uint8_t * neighbor_count, sl_wisun_mac_address_t * neighbor_mac_addresses)

Get a list of RPL neighbor (parents and children) MAC addresses.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_network_info#

sl_status_t sl_wisun_get_network_info (sl_wisun_network_info_t * network_info)

Get Wi-SUN network information.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_pom_ie#

sl_status_t sl_wisun_get_pom_ie (uint8_t * phy_mode_id_count, uint8_t * phy_mode_ids, uint8_t * is_mdr_command_capable)

Get the POM-IE configuration.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function retrieves the PHY operating mode information advertised to neighboring nodes.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_rpl_info#

sl_status_t sl_wisun_get_rpl_info (sl_wisun_rpl_info_t * rpl_info)

Get RPL information.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_get_stack_version#

sl_status_t sl_wisun_get_stack_version (uint8_t * major, uint8_t * minor, uint8_t * patch, uint16_t * build)

Get the Wi-SUN stack version.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_get_statistics#

sl_status_t sl_wisun_get_statistics (sl_wisun_statistics_type_t statistics_type, sl_wisun_statistics_t * statistics)

Read a set of statistics.

Returns

• SL_STATUS_OK if successful, an error code otherwise.

This function reads a set of statistics from the stack. Statistics are cumulative and reset when a connection is initiated or by calling sl_wisun_reset_statistics().

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_join#

sl_status_t sl_wisun_join (const uint8_t * name, sl_wisun_phy_config_t * phy_config)

Initiate a connection to a Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function initiates connection to a Wi-SUN network. Completion of the request is indicated with a SL_WISUN_MSG_CONNECTED_IND_ID event.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_reset_statistics#

sl_status_t sl_wisun_reset_statistics (sl_wisun_statistics_type_t statistics_type)

Reset a set of statistics in the stack.

Returns

• SL_STATUS_OK if successful, an error code otherwise.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_advert_fragment_duration#

sl_status_t sl_wisun_set_advert_fragment_duration (uint32_t fragment_duration_ms)

Set the async transmission fragmentation parameters.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Async transmissions, such as Wi-SUN PAN advertisement packets, are sent to every allowed operating channel and may therefore block broadcast and unicast traffic. This impact can be reduced by splitting the channel list into fragments based on the maximum transmission duration and by forcing a delay between the fragments, allowing other traffic to occur. This function sets the maximum duration of a PA, PAS, PC, and PCS advertisement period fragments. A small value trades off longer connection times for shorter latencies. Setting the duration to SL_WISUN_ADVERT_FRAGMENT_DISABLE disables async transmission fragmentation.

By default, the maximum fragment duration is set to 500 ms.

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_set_allowed_channel_mask#

sl_status_t sl_wisun_set_allowed_channel_mask (const sl_wisun_channel_mask_t * channel_mask)

Set a mask of operating channels.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets a mask of channels the device is allowed to operate in for unicast frequency hopping. By default, all channels in the channel plan are allowed. The mask can only be used to further restrict the channels. Channels outside the channel plan or channels internally excluded are ignored. This mask will be used in the following connections.

Warnings

• By comparison to the Wi-SUN FAN specification, the channel mask logic is inverted. The specification references a mask of excluded channels.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_channel_mask#

sl_status_t sl_wisun_set_channel_mask (const sl_wisun_channel_mask_t * channel_mask)

Set a mask of operating channels.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets a mask of channels the device is allowed to operate in for unicast frequency hopping. By default, all channels in the channel plan are allowed. The mask can only be used to further restrict the channels. Channels outside the channel plan or channels internally excluded are ignored. This mask will be used in the following connections.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_connection_parameters#

sl_status_t sl_wisun_set_connection_parameters (const sl_wisun_connection_params_t * params)

Configure the FFN parameter set.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the FFN parameter set. These parameters impact connection time, bandwidth usage, and latency. Use of a predefined parameter set is recommended (Predefined FFN parameter sets). The function must be called before initiating a connection.

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_set_device_certificate#

sl_status_t sl_wisun_set_device_certificate (uint16_t certificate_options, uint16_t certificate_length, const uint8_t * certificate)

Set the device certificate used to authenticate to the authentication server.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_device_private_key#

sl_status_t sl_wisun_set_device_private_key (uint16_t key_options, uint16_t key_length, const uint8_t * key)

Set the private key of the device certificate.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_device_private_key_id#

sl_status_t sl_wisun_set_device_private_key_id (uint32_t key_id)

Set the private key of the device certificate.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the device private key using a key identifier, referencing a key stored in PSA cryptography module. The corresponding device certificate must still be set using sl_wisun_set_device_certificate(). The stored key must have correct PSA key attributes, see the Wi-SUN FAN Security Concepts and Design Considerations document for details.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_device_type#

sl_status_t sl_wisun_set_device_type (sl_wisun_device_type_t device_type)

Set the device type.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the operational mode of the node.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

• This is a no-op with FFN and LFN libraries.

sl_wisun_set_leaf#

sl_status_t sl_wisun_set_leaf (bool is_leaf)

Set the RPL leaf mode.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function configures RPL leaf mode on FFNs. When enabled, it prevents the FFN from parenting other nodes (FFN or LFN).

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_set_lfn_parameters#

sl_status_t sl_wisun_set_lfn_parameters (const sl_wisun_lfn_params_t * params)

Configure the LFN parameter set.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the LFN parameter set. These parameters impact connection time, bandwidth usage, power consumption, and latency. Use of a predefined parameter set is recommended (Predefined LFN parameter sets). The function must be called before initiating a connection.

Note

• Available in libraries: Full, LFN (see Wi-SUN API availability)

sl_wisun_set_lfn_support#

sl_status_t sl_wisun_set_lfn_support (uint8_t lfn_limit)

Set the maximum number of LFN children.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the maximum number of LFN children this node can parent.

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_set_mac_address#

sl_status_t sl_wisun_set_mac_address (const sl_wisun_mac_address_t * address)

Set the device MAC address to be used.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the MAC address for use in the following connections. By default, the device will use the built-in unique device MAC address. The address is reset to the built-in value upon power up.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_mode_switch#

sl_status_t sl_wisun_set_mode_switch (uint8_t mode, uint8_t phy_mode_id, const sl_wisun_mac_address_t * neighbor_address)

Set the PHY mode switch configuration.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_neighbor_table_size#

sl_status_t sl_wisun_set_neighbor_table_size (uint8_t size)

Set neighbor table size.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the limit of regular neighbors supported by the node [1, 245], without considering temporary or RPL parents. Increasing this parameter means a higher number of potential neighbors while lowering it means reduced RAM consumption. The default value is 22.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_pom_ie#

sl_status_t sl_wisun_set_pom_ie (uint8_t phy_mode_id_count, uint8_t phy_mode_ids, uint8_t is_mdr_command_capable)

Set the POM-IE configuration.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the PHY operating mode information advertised to neighboring nodes. By default the PhyModeId list contains the first fifteen PhyModeId listed in radio multi-PHY configuration, MAC mode switch is disabled.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_pti_state#

sl_status_t sl_wisun_set_pti_state (bool pti_state)

Set the PTI state.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets Packet Trace Interface (PTI) state. PTI is enabled by default.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_regulation#

sl_status_t sl_wisun_set_regulation (sl_wisun_regulation_t regulation)

Set the regional regulation.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the regional regulation for use in the following connections. The selected regional regulation will impact both the Wi-SUN stack performance and its behavior. See regulation standards for details. No regulation is set by default.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_regulation_tx_thresholds#

sl_status_t sl_wisun_set_regulation_tx_thresholds (int8_t warning_threshold, int8_t alert_threshold)

Set the thresholds for transmission duration level event.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the thresholds for transmission duration level event. When set and when a regional regulation is enabled using sl_wisun_set_regulation(), a SL_WISUN_MSG_REGULATION_TX_LEVEL_IND_ID event is sent when one of the configured thresholds is exceeded. This can be used by the application to prevent exceeding the total transmission duration allowed in the regional regulation. Thresholds are defined as a percentage of the maximum transmission duration permitted by the regional regulation.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_security_state#

sl_status_t sl_wisun_set_security_state (uint32_t security_state)

Set the connection security state.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the connection security state. By default, authentication and link encryption are enabled. The function is intended for test purposes.

Note

• Authentication and link encryption can only be disabled when the application is linked against a library supporting this option.

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_trusted_certificate#

sl_status_t sl_wisun_set_trusted_certificate (uint16_t certificate_options, uint16_t certificate_length, const uint8_t * certificate)

Set a trusted certificate used to verify the authentication server certificate.

Returns

• SL_STATUS_OK if successful, an error code otherwise

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_tx_power#

sl_status_t sl_wisun_set_tx_power (int8_t tx_power)

Set the maximum TX power.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the maximum TX power. The device may use a lower value based on internal decision making or hardware limitations but will never exceed the given value. The function must be called before initiating a connection.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

DeprecatedThis function will be removed in the future versions of the Wi-SUN stack, use sl_wisun_set_tx_power_ddbm() instead.

sl_wisun_set_tx_power_ddbm#

sl_status_t sl_wisun_set_tx_power_ddbm (int16_t tx_power_ddbm)

Set the maximum TX power.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the maximum TX power. The device may use a lower value based on internal decision making or hardware limitations but will never exceed the given value. The function must be called before initiating a connection.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)

sl_wisun_set_unicast_settings#

sl_status_t sl_wisun_set_unicast_settings (uint8_t dwell_interval_ms)

Set unicast settings.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the parameters for unicast channel hopping to be used in the following connections. The Unicast Dwell Interval specifies the duration which the node will listen to a channel within its listening schedule. The default value is 255 ms.

Note

• Available in libraries: Full, FFN (see Wi-SUN API availability)

sl_wisun_trigger_frame#

sl_status_t sl_wisun_trigger_frame (sl_wisun_frame_type_t frame_type)

Trigger a transmission of a periodic frame (FAN Discovery, RPL).

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function causes a periodic frame (FAN Discovery, RPL) to be transmitted immediately. The frame can only be transmitted in the appropriate connection state, i.e. the associated trickle timer must be running. The function is intended for test purposes.

Note

• Available in libraries: Full, FFN, LFN (see Wi-SUN API availability)