Wi-SUN API type definitions#
Modules#
sl_wisun_statistics_arib_regulation_t
sl_wisun_statistics_regulation_t
sl_wisun_phy_config_explicit_t
sl_wisun_phy_config_custom_fsk_t
sl_wisun_phy_config_custom_ofdm_t
sl_wisun_phy_config_custom_oqpsk_t
sl_wisun_socket_option_event_mode_t
sl_wisun_socket_option_multicast_group_t
sl_wisun_socket_option_send_buffer_limit_t
sl_wisun_socket_option_edfe_mode_t
sl_wisun_socket_option_unicast_hop_limit
sl_wisun_socket_option_multicast_hop_limit
sl_wisun_lfn_params_connection_t
sl_wisun_lfn_params_data_layer_t
Enumerations#
Enumerations for device type.
Enumerations for network size.
Enumerations for IP address type.
Enumerations for certificate options.
Enumerations for private key options.
Enumerations for statistics type.
Enumerations for regulatory domain.
Enumerations for operating class.
Enumerations for operating mode.
Enumerations for multicast group action.
Enumerations for channel spacing.
Enumerations for join state.
Enumerations for network update flags.
Enumerations for PHY config type.
Enumeration for LFN configuration profile.
Enumeration for CRC type.
Enumerations for socket protocol Deprecated.
Enumerations for socket option Deprecated.
Enumeration for RPL neighbor types.
Enumeration for trace group.
Enumerations for trace level.
Enumerations for regional regulation.
Enumeration for Mode Switch mode.
Enumeration for regional regulation transmission level.
Enumeration for channel exlusion modes.
Enumeration for types of frame that can be triggered.
Enumeration for channel mask types.
Typedefs#
Variables#
Broadcast MAC address.
Macros#
Maximum size of the Wi-SUN network name.
Size of a MAC address.
Size of a channel mask.
Size of the filter bitfield.
Maximum fragment duration. Disables advert fragmentation.
Maximum number of PhyModeId allowed in POM-IE.
Channel spacing 100 kHz for backward compatibility.
Channel spacing 200 kHz for backward compatibility.
Channel spacing 400 kHz for backward compatibility.
Channel spacing 600 kHz for backward compatibility.
Thread identifier "Wi-SUN Task".
Thread identifier "Wi-SUN Event Task".
Thread identifier "Wi-SUN Event Loop Task".
Thread identifier "Wi-SUN RF Task".
Enumeration Documentation#
sl_wisun_device_type_t#
sl_wisun_device_type_t
Enumerations for device type.
| Enumerator | |
|---|---|
| SL_WISUN_ROUTER | FFN Router. |
| SL_WISUN_LFN | LFN Router (experimental, for evaluation purposes only) |
| SL_WISUN_BORDER_ROUTER | Border Router. |
sl_wisun_network_size_t#
sl_wisun_network_size_t
Enumerations for network size.
| Enumerator | |
|---|---|
| SL_WISUN_NETWORK_SIZE_AUTOMATIC | Determine the size from PAN advertisements. |
| SL_WISUN_NETWORK_SIZE_SMALL | Small size (less than 100 nodes) |
| SL_WISUN_NETWORK_SIZE_MEDIUM | Medium size (100 to 800 nodes) |
| SL_WISUN_NETWORK_SIZE_LARGE | Large size (800 to 1500 nodes) |
| SL_WISUN_NETWORK_SIZE_TEST | Test network (a few nodes) |
| SL_WISUN_NETWORK_SIZE_CERTIFICATION | Certification configuration. |
sl_wisun_ip_address_type_t#
sl_wisun_ip_address_type_t
Enumerations for IP address type.
| Enumerator | |
|---|---|
| SL_WISUN_IP_ADDRESS_TYPE_LINK_LOCAL | Device link-local address. |
| SL_WISUN_IP_ADDRESS_TYPE_GLOBAL | Device global unicast address. |
| SL_WISUN_IP_ADDRESS_TYPE_BORDER_ROUTER | Border router global unicast address. |
| SL_WISUN_IP_ADDRESS_TYPE_PRIMARY_PARENT | Link-local address of the primary parent. |
| SL_WISUN_IP_ADDRESS_TYPE_SECONDARY_PARENT | Link-local address of the secondary parent. |
sl_wisun_certificate_option_t#
sl_wisun_certificate_option_t
Enumerations for certificate options.
| Enumerator | |
|---|---|
| SL_WISUN_CERTIFICATE_OPTION_NONE | Empty option. |
| SL_WISUN_CERTIFICATE_OPTION_APPEND | Certificate is appended to a chain. |
| SL_WISUN_CERTIFICATE_OPTION_IS_REF | Certificate data will remain in scope. |
| SL_WISUN_CERTIFICATE_OPTION_HAS_KEY | Certificate has a private key. |
sl_wisun_private_key_option_t#
sl_wisun_private_key_option_t
Enumerations for private key options.
| Enumerator | |
|---|---|
| SL_WISUN_PRIVATE_KEY_OPTION_NONE | Empty option. |
| SL_WISUN_PRIVATE_KEY_OPTION_IS_REF | Private key data will remain in scope. |
sl_wisun_statistics_type_t#
sl_wisun_statistics_type_t
Enumerations for statistics type.
| Enumerator | |
|---|---|
| SL_WISUN_STATISTICS_TYPE_PHY | PHY/RF statistics. |
| SL_WISUN_STATISTICS_TYPE_MAC | MAC statistics. |
| SL_WISUN_STATISTICS_TYPE_FHSS | Frequency hopping statistics. |
| SL_WISUN_STATISTICS_TYPE_WISUN | Wi-SUN statistics. |
| SL_WISUN_STATISTICS_TYPE_NETWORK | 6LoWPAN/IP stack statistics |
| SL_WISUN_STATISTICS_TYPE_REGULATION | Regional regulation. |
| SL_WISUN_STATISTICS_TYPE_HEAP | Heap usage. |
sl_wisun_regulatory_domain_t#
sl_wisun_regulatory_domain_t
Enumerations for regulatory domain.
| Enumerator | |
|---|---|
| SL_WISUN_REGULATORY_DOMAIN_WW | World-wide (2.4 GHz) |
| SL_WISUN_REGULATORY_DOMAIN_NA | North America. |
| SL_WISUN_REGULATORY_DOMAIN_JP | Japan. |
| SL_WISUN_REGULATORY_DOMAIN_EU | Europe. |
| SL_WISUN_REGULATORY_DOMAIN_CN | China. |
| SL_WISUN_REGULATORY_DOMAIN_IN | India. |
| SL_WISUN_REGULATORY_DOMAIN_MX | Mexico. |
| SL_WISUN_REGULATORY_DOMAIN_BZ | Brazil. |
| SL_WISUN_REGULATORY_DOMAIN_AZ | Australia. |
| SL_WISUN_REGULATORY_DOMAIN_NZ | New Zealand. |
| SL_WISUN_REGULATORY_DOMAIN_KR | South Korea. |
| SL_WISUN_REGULATORY_DOMAIN_PH | Philippines. |
| SL_WISUN_REGULATORY_DOMAIN_MY | Malaysia. |
| SL_WISUN_REGULATORY_DOMAIN_HK | Hong Kong. |
| SL_WISUN_REGULATORY_DOMAIN_SG | Singapore. |
| SL_WISUN_REGULATORY_DOMAIN_TH | Thailand. |
| SL_WISUN_REGULATORY_DOMAIN_VN | Vietnam. |
| SL_WISUN_REGULATORY_DOMAIN_APP | Application-specific domain. |
sl_wisun_operating_class_t#
sl_wisun_operating_class_t
Enumerations for operating class.
| Enumerator | |
|---|---|
| SL_WISUN_OPERATING_CLASS_1 | Operating class# 1. |
| SL_WISUN_OPERATING_CLASS_2 | Operating class# 2. |
| SL_WISUN_OPERATING_CLASS_3 | Operating class# 3. |
| SL_WISUN_OPERATING_CLASS_4 | Operating class# 4. |
| SL_WISUN_OPERATING_CLASS_5 | Operating class# 5. |
| SL_WISUN_OPERATING_CLASS_APP | Application-specific class. |
sl_wisun_operating_mode_t#
sl_wisun_operating_mode_t
Enumerations for operating mode.
| Enumerator | |
|---|---|
| SL_WISUN_OPERATING_MODE_1A | Operating mode# 1a. |
| SL_WISUN_OPERATING_MODE_1B | Operating mode# 1b. |
| SL_WISUN_OPERATING_MODE_2A | Operating mode# 2a. |
| SL_WISUN_OPERATING_MODE_2B | Operating mode# 2b. |
| SL_WISUN_OPERATING_MODE_3 | Operating mode# 3. |
| SL_WISUN_OPERATING_MODE_4A | Operating mode# 4a. |
| SL_WISUN_OPERATING_MODE_4B | Operating mode# 4b. |
| SL_WISUN_OPERATING_MODE_5 | Operating mode# 5. |
sl_wisun_multicast_group_action_t#
sl_wisun_multicast_group_action_t
Enumerations for multicast group action.
| Enumerator | |
|---|---|
| SL_WISUN_MULTICAST_GROUP_ACTION_JOIN | Join a multicast group. |
| SL_WISUN_MULTICAST_GROUP_ACTION_LEAVE | Leave a multicast group. |
sl_wisun_channel_spacing_t#
sl_wisun_channel_spacing_t
Enumerations for channel spacing.
| Enumerator | |
|---|---|
| SL_WISUN_CHANNEL_SPACING_100KHZ | 100 kHz |
| SL_WISUN_CHANNEL_SPACING_200KHZ | 200 kHz |
| SL_WISUN_CHANNEL_SPACING_400KHZ | 400 kHz |
| SL_WISUN_CHANNEL_SPACING_600KHZ | 600 kHz |
| SL_WISUN_CHANNEL_SPACING_250KHZ | 250 kHz |
| SL_WISUN_CHANNEL_SPACING_800KHZ | 800 kHz |
| SL_WISUN_CHANNEL_SPACING_1200KHZ | 1200 kHz |
sl_wisun_join_state_t#
sl_wisun_join_state_t
Enumerations for join state.
| Enumerator | |
|---|---|
| SL_WISUN_JOIN_STATE_DISCONNECTED | Join state 0: Disconnected. |
| SL_WISUN_JOIN_STATE_SELECT_PAN | Join state 1: Select PAN. |
| SL_WISUN_JOIN_STATE_AUTHENTICATE | Join state 2: Authenticate. |
| SL_WISUN_JOIN_STATE_ACQUIRE_PAN_CONFIG | Join state 3: Acquire PAN config. |
| SL_WISUN_JOIN_STATE_CONFIGURE_ROUTING | Join state 4: Configure routing. |
| SL_WISUN_JOIN_STATE_OPERATIONAL | Join state 5: Operational. |
| SL_WISUN_JOIN_STATE_DISCONNECTING | Disconnecting. |
| SL_WISUN_JOIN_STATE_PARENT_SELECT | Join state 4: Preferred parent selection. |
| SL_WISUN_JOIN_STATE_DHCP | Join state 4: DHCP address acquisition. |
| SL_WISUN_JOIN_STATE_EARO | Join state 4: Address registration. |
| SL_WISUN_JOIN_STATE_DAO | Join state 4: DAO registration. |
sl_wisun_network_update_flags_t#
sl_wisun_network_update_flags_t
Enumerations for network update flags.
| Enumerator | |
|---|---|
| SL_WISUN_NETWORK_UPDATE_FLAGS_GLOBAL_IP | Global IP modification flag bit. |
| SL_WISUN_NETWORK_UPDATE_FLAGS_PRIMARY_PARENT | Primary Parent modification flag bit. |
| SL_WISUN_NETWORK_UPDATE_FLAGS_SECONDARY_PARENT | Secondary parent modification flag bit. |
sl_wisun_phy_config_type_t#
sl_wisun_phy_config_type_t
Enumerations for PHY config type.
| Enumerator | |
|---|---|
| SL_WISUN_PHY_CONFIG_FAN10 | FAN1.0 configuration. |
| SL_WISUN_PHY_CONFIG_FAN11 | FAN1.1 configuration. |
| SL_WISUN_PHY_CONFIG_EXPLICIT | Explicit configuration. |
| SL_WISUN_PHY_CONFIG_IDS | Specific RAIL channel configuration. |
| SL_WISUN_PHY_CONFIG_CUSTOM_FSK | FSK customization. |
| SL_WISUN_PHY_CONFIG_CUSTOM_OFDM | OFDM customization. |
| SL_WISUN_PHY_CONFIG_CUSTOM_OQPSK | OQPSK customization. |
sl_wisun_lfn_profile_t#
sl_wisun_lfn_profile_t
Enumeration for LFN configuration profile.
| Enumerator | |
|---|---|
| SL_WISUN_LFN_PROFILE_TEST | Profile for test usage, best performance but highest power consumption. |
| SL_WISUN_LFN_PROFILE_BALANCED | Profile providing balance between power consumption and performance. |
| SL_WISUN_LFN_PROFILE_ECO | Profile optimized for low power consumption. |
sl_wisun_crc_type_t#
sl_wisun_crc_type_t
Enumeration for CRC type.
| Enumerator | |
|---|---|
| SL_WISUN_NO_CRC | No CRC (OFDM and OQPSK only) |
| SL_WISUN_2_BYTES_CRC | 2 bytes CRC |
| SL_WISUN_4_BYTES_CRC | 4 bytes CRC |
sl_wisun_socket_protocol_t#
sl_wisun_socket_protocol_t
Enumerations for socket protocol Deprecated.
| Enumerator | |
|---|---|
| SL_WISUN_SOCKET_PROTOCOL_UDP | User Datagram Protocol (UDP) |
| SL_WISUN_SOCKET_PROTOCOL_TCP | Transmission Control Protocol (TCP) |
| SL_WISUN_SOCKET_PROTOCOL_ICMP | Internet Control Message Protocol (ICMP) |
sl_wisun_socket_option_t#
sl_wisun_socket_option_t
Enumerations for socket option Deprecated.
| Enumerator | |
|---|---|
| SL_WISUN_SOCKET_OPTION_EVENT_MODE | Option for socket event mode. |
| SL_WISUN_SOCKET_OPTION_MULTICAST_GROUP | Option for multicast group. |
| SL_WISUN_SOCKET_OPTION_SEND_BUFFER_LIMIT | Option for send buffer limit. |
| SL_WISUN_SOCKET_OPTION_EDFE_MODE | Option to enable/disable Extended Directed Frame Exchange mode. |
| SL_WISUN_SOCKET_OPTION_UNICAST_HOP_LIMIT | Option to set socket unicast hop limit. |
| SL_WISUN_SOCKET_OPTION_MULTICAST_HOP_LIMIT | Option to set socket multicast hop limit. |
sl_wisun_neighbor_type_t#
sl_wisun_neighbor_type_t
Enumeration for RPL neighbor types.
| Enumerator | |
|---|---|
| SL_WISUN_NEIGHBOR_TYPE_PRIMARY_PARENT | Primary parent. |
| SL_WISUN_NEIGHBOR_TYPE_SECONDARY_PARENT | Secondary parent. |
| SL_WISUN_NEIGHBOR_TYPE_CHILD | Child. |
sl_wisun_trace_group_t#
sl_wisun_trace_group_t
Enumeration for trace group.
| Enumerator | |
|---|---|
| SL_WISUN_TRACE_GROUP_MAC | Mac. |
| SL_WISUN_TRACE_GROUP_NW | Network. |
| SL_WISUN_TRACE_GROUP_LLC | LLC. |
| SL_WISUN_TRACE_GROUP_6LO | 6lowpan |
| SL_WISUN_TRACE_GROUP_IPV6 | IPV6. |
| SL_WISUN_TRACE_GROUP_TCP | TCP. |
| SL_WISUN_TRACE_GROUP_UDP | UDP. |
| SL_WISUN_TRACE_GROUP_ICMP | ICMP. |
| SL_WISUN_TRACE_GROUP_DHCP | DHCP. |
| SL_WISUN_TRACE_GROUP_MPL | MPL. |
| SL_WISUN_TRACE_GROUP_DNS | DNS. |
| SL_WISUN_TRACE_GROUP_RPL | RPL. |
| SL_WISUN_TRACE_GROUP_TRIC | Trickle. |
| SL_WISUN_TRACE_GROUP_WS | Wi-SUN Stack. |
| SL_WISUN_TRACE_GROUP_BOOT | Wi-SUN Bootstrap. |
| SL_WISUN_TRACE_GROUP_WSR | Wi-SUN Router. |
| SL_WISUN_TRACE_GROUP_WSBR | Border router. |
| SL_WISUN_TRACE_GROUP_SEC | Security. |
| SL_WISUN_TRACE_GROUP_TIME | Time and timers. |
| SL_WISUN_TRACE_GROUP_NEIGH | Neighbor. |
| SL_WISUN_TRACE_GROUP_STAT | Statistics. |
| SL_WISUN_TRACE_GROUP_BUFF | Dynamic Buffer. |
| SL_WISUN_TRACE_GROUP_ADDR | Address Manipulation. |
| SL_WISUN_TRACE_GROUP_MON | Monitoring. |
| SL_WISUN_TRACE_GROUP_SOCK | Socket. |
| SL_WISUN_TRACE_GROUP_DENY | Deny list. |
| SL_WISUN_TRACE_GROUP_ETX | ETX. |
| SL_WISUN_TRACE_GROUP_FHSS | FHSS. |
| SL_WISUN_TRACE_GROUP_ROUT | Routing table. |
| SL_WISUN_TRACE_GROUP_EVLP | Event loop. |
| SL_WISUN_TRACE_GROUP_NVM | NVM. |
| SL_WISUN_TRACE_GROUP_CRYPTO | Crypto. |
| SL_WISUN_TRACE_GROUP_RF | Wi-SUN RF Driver. |
| Sl_WISUN_TRACE_GROUP_WSIE | Wi-SUN IE. |
| SL_WISUN_TRACE_GROUP_CONFIG | Configuration. |
| SL_WISUN_TRACE_GROUP_TIM_SRV | Timer service. |
| SL_WISUN_TRACE_GROUP_LFN_TIM | LFN timing measurement. |
| SL_WISUN_TRACE_GROUP_INT | Internal usage. |
| SL_WISUN_TRACE_GROUP_COUNT | Max number of trace group in this enum. |
sl_wisun_trace_level_t#
sl_wisun_trace_level_t
Enumerations for trace level.
| Enumerator | |
|---|---|
| SL_WISUN_TRACE_LEVEL_NONE | No trace. |
| SL_WISUN_TRACE_LEVEL_ERROR | Error only. |
| SL_WISUN_TRACE_LEVEL_WARN | Warning + error. |
| SL_WISUN_TRACE_LEVEL_INFO | Info + warning + error. |
| SL_WISUN_TRACE_LEVEL_DEBUG | Debug + info + warning + error. |
sl_wisun_regulation_t#
sl_wisun_regulation_t
Enumerations for regional regulation.
| Enumerator | |
|---|---|
| SL_WISUN_REGULATION_NONE | No regulation. |
| SL_WISUN_REGULATION_ARIB | ARIB, can only be used with JP regulatory domain. |
| SL_WISUN_REGULATION_WPC | WPC, can only be used with IN regulatory domain. |
sl_wisun_mode_switch_mode_t#
sl_wisun_mode_switch_mode_t
Enumeration for Mode Switch mode.
| Enumerator | |
|---|---|
| SL_WISUN_MODE_SWITCH_DISABLED | Mode switch is not allowed. |
| SL_WISUN_MODE_SWITCH_ENABLED | Mode switch is allowed for all unicast data frames. Specified PhyModeId is used. |
| SL_WISUN_MODE_SWITCH_DEFAULT | Mode switch is allowed for all unicast data frames. Default PhyModeId is used. |
sl_wisun_regulation_tx_level_t#
sl_wisun_regulation_tx_level_t
Enumeration for regional regulation transmission level.
Thresholds are define with sl_wisun_set_regulation_tx_thresholds.
| Enumerator | |
|---|---|
| SL_WISUN_REGULATION_TX_LEVEL_LOW | Transmission duration is compliant with regional regulation. |
| SL_WISUN_REGULATION_TX_LEVEL_WARNING | Transmission duration is above warning threshold. |
| SL_WISUN_REGULATION_TX_LEVEL_ALERT | Transmission duration is above alert threshold. |
sl_wisun_channel_exclusion_mode_t#
sl_wisun_channel_exclusion_mode_t
Enumeration for channel exlusion modes.
| Enumerator | |
|---|---|
| SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_RANGE | Channels are excluded by range if possible (3 ranges maximum), otherwise channels will be excluded by mask. |
| SL_WISUN_CHANNEL_EXCLUSION_MODE_BY_MASK | Channels are excluded by mask. |
sl_wisun_frame_type_t#
sl_wisun_frame_type_t
Enumeration for types of frame that can be triggered.
| Enumerator | |
|---|---|
| SL_WISUN_FRAME_TYPE_PAS | |
| SL_WISUN_FRAME_TYPE_PA | |
| SL_WISUN_FRAME_TYPE_PCS | |
| SL_WISUN_FRAME_TYPE_PC | |
| SL_WISUN_FRAME_TYPE_DIS | |
| SL_WISUN_FRAME_TYPE_DIO | |
sl_wisun_channel_mask_type_t#
sl_wisun_channel_mask_type_t
Enumeration for channel mask types.
| Enumerator | |
|---|---|
| SL_WISUN_CHANNEL_MASK_TYPE_REGIONAL | Regional excluded channel mask (not advertised) |
| SL_WISUN_CHANNEL_MASK_TYPE_ADVERTISED_UNICAST | Excluded channel mask advertised in us-ie. |
| SL_WISUN_CHANNEL_MASK_TYPE_ADVERTISED_BROADCAST | Excluded channel mask advertised in bs-ie. |
| SL_WISUN_CHANNEL_MASK_TYPE_EFFECTIVE_ASYNC | Excluded channel mask applied to async frames. |
| SL_WISUN_CHANNEL_MASK_TYPE_EFFECTIVE_UNICAST | Excluded channel mask applied to unicast frequency hopping. |
| SL_WISUN_CHANNEL_MASK_TYPE_EFFECTIVE_BROADCAST | Excluded channel mask applied to broadcast frequency hopping. |