Border Router API#

sl_wisun_br_get_gak#

sl_status_t sl_wisun_br_get_gak (uint8_t index, uint8_t * gak)

Get Group AES Key.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function exports (L)GAK as a plaintext key.

Note

• This functionality is only available when using the debug library.

sl_wisun_br_get_ip_addresses#

sl_status_t sl_wisun_br_get_ip_addresses (uint8_t * addr_ll, uint8_t * addr_gua, uint8_t * addr_dodagid)

Get the unicast IPv6 addresses configured in the Border Router.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_br_get_state#

sl_status_t sl_wisun_br_get_state (sl_wisun_br_state_t * state)

Get the Border Router state.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_br_ipv6_down#

sl_status_t sl_wisun_br_ipv6_down (const uint8_t * data, size_t data_length)

Forward an IPv6 packet to Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function forwards an IPv6 packet to Wi-SUN network. The destination address must belong to the DODAG prefix. This function is used for handling downlink packets from the backhaul interface, see sl_wisun_br_set_ipv6_up_handler() for uplink. It's recommended to use sl_wisun_br_ipv6_route_exists() before forwarding a packet.

sl_wisun_br_ipv6_route_exists#

sl_status_t sl_wisun_br_ipv6_route_exists (const uint8_t * ipv6_address, bool * exists)

Check if the IPv6 destination address is routable in the Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function checks if the given IPv6 address is a valid destination in the Wi-SUN network. The destination address must belong to the Border Router or one of the connected nodes.

sl_wisun_br_pan_defect_advertise#

sl_status_t sl_wisun_br_pan_defect_advertise (bool defect_advertise, uint32_t min_scan_duration_s, uint32_t max_scan_duration_s)

Start or stop PAN Defect advertisement.

Returns

• SL_STATUS_OK if successful, an error code otherwise.

Note

• The values for min_scan_duration_s and max_scan_duration_s should be chosen based on the estimated performance of the backup power source. Specifically, max_scan_duration_s should be set to a value smaller than the estimated lifetime of the backup power source to ensure a seamless transition to the alternative PAN without long connection interruptions.

sl_wisun_br_set_broadcast_settings#

sl_status_t sl_wisun_br_set_broadcast_settings (uint32_t interval_ms, uint8_t dwell_interval_ms)

Set broadcast settings.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the broadcast channel hopping schedule. The Broadcast Interval is the duration, between Broadcast Dwell Intervals within the advertising node’s broadcast schedule. Its resolution is limited to 24 bits (16777215 ms). The Broadcast Dwell Interval specifies the duration during which the node may transmit a broadcast message. It is recommended a BI value of 4.0 times the maximum of (UDI, BDI). These values affect the whole PAN, since they are propagated from parent to children. This function must be called before starting the Border Router.

sl_wisun_br_set_connection_parameters#

sl_status_t sl_wisun_br_set_connection_parameters (const sl_wisun_br_connection_params_t * params)

Configure the Border Router parameter set.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This functions sets the Border Router parameter set. These parameters impact connection time, bandwidth usage, and latency. Use of a predefined parameter set is recommended (Predefined BR parameter sets). This function must be called before starting the Border Router.

sl_wisun_br_set_device_certificate#

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

Set the Border Router device certificate.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_br_set_dhcp_vendor_data#

sl_status_t sl_wisun_br_set_dhcp_vendor_data (uint32_t enterprise_number, uint16_t data_length, const uint8_t * data)

Set DHCPv6 Vendor Data.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the vendor-specific information transmitted during DHCPv6 exchange. This function must be called before starting the Border Router.

sl_wisun_br_set_gtk#

sl_status_t sl_wisun_br_set_gtk (const uint8_t * gtk, uint8_t index)

Set Group Transient Key.

Note

• This API is provided for test and debug purposes: setting a specific key in production is not recommended. Furthermore, using this API to set a GTK or LGTK disables the rotation of this key type so the application is responsible for setting new ones when suitable.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_br_set_ipv6_prefix#

sl_status_t sl_wisun_br_set_ipv6_prefix (const uint8_t * ipv6_prefix, uint8_t prefix_length)

Set IPv6 prefix for DODAG.

Note

• Must not be called after the border router is started

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the prefix used to generate IP addresses for RPL traffic (DODAGID will derive from it). This function must be called before starting the Border Router.

sl_wisun_br_set_ipv6_up_handler#

sl_status_t sl_wisun_br_set_ipv6_up_handler (sl_wisun_ipv6_up_handler_t handler)

Register a function to handle IPv6 packets received from Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function registers a handler function that will be called when the destination address of a received IPv6 packet is outside the DODAG prefix. Setting the handler function to NULL disables the forwarding. This function is used for handling uplink packets towards the backhaul interface, see sl_wisun_br_ipv6_down() for downlink.

sl_wisun_br_set_lfn_parameters#

sl_status_t sl_wisun_br_set_lfn_parameters (const sl_wisun_br_lfn_params_t * params)

Configure LFN parenting parameter set.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the LFN parenting parameter set. These parameters impact battery life of all LFNs in the PAN. Use of a predefined parameter set is recommended (Predefined BR LFN-parenting parameter sets). This function must be called before starting the Border Router.

sl_wisun_br_set_lfn_support#

sl_status_t sl_wisun_br_set_lfn_support (uint8_t lfn_limit, bool lfn_support_pan)

Configure LFN parenting support.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function configures LFN parenting support in the Border Router and in the PAN.

sl_wisun_br_set_network_size#

sl_status_t sl_wisun_br_set_network_size (sl_wisun_network_size_t size)

Set the size of the Wi-SUN network.

Returns

• SL_STATUS_OK if successful, an error code otherwise

This function sets the size of the network. The size is to used set various stack parameters, such as timing parameters to optimize device behavior in regards to node count. The device will function with any setting but may exhibit non-optimal behavior. Setting the size too large may cause slow connection speed and increased latency. Conversely, a value too small may cause increased network traffic.

sl_wisun_br_start#

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

Start the Border Router.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_br_stop#

sl_status_t sl_wisun_br_stop (void )

Stop the Border Router.

Returns

• SL_STATUS_OK if successful, an error code otherwise

sl_wisun_set_br_device_certificate#

#define sl_wisun_set_br_device_certificate

sl_wisun_br_set_device_certificate

Define sl_wisun_set_br_device_certificate for legacy.