Modules#

Wi-SUN Message API#

Enumerations#

enum

sl_wisun_msg_req_id_t {

SL_WISUN_MSG_SET_NETWORK_SIZE_REQ_ID = 0x01

SL_WISUN_MSG_CONNECT_REQ_ID = 0x02

SL_WISUN_MSG_GET_IP_ADDRESS_REQ_ID = 0x03

SL_WISUN_MSG_OPEN_SOCKET_REQ_ID = 0x04

SL_WISUN_MSG_CLOSE_SOCKET_REQ_ID = 0x05

SL_WISUN_MSG_SENDTO_ON_SOCKET_REQ_ID = 0x06

SL_WISUN_MSG_LISTEN_ON_SOCKET_REQ_ID = 0x07

SL_WISUN_MSG_ACCEPT_ON_SOCKET_REQ_ID = 0x08

SL_WISUN_MSG_CONNECT_SOCKET_REQ_ID = 0x09

SL_WISUN_MSG_BIND_SOCKET_REQ_ID = 0x0A

SL_WISUN_MSG_SEND_ON_SOCKET_REQ_ID = 0x0B

SL_WISUN_MSG_RECEIVE_ON_SOCKET_REQ_ID = 0x0C

SL_WISUN_MSG_DISCONNECT_REQ_ID = 0x0D

SL_WISUN_MSG_SET_TRUSTED_CERTIFICATE_REQ_ID = 0x0E

SL_WISUN_MSG_SET_DEVICE_CERTIFICATE_REQ_ID = 0x0F

SL_WISUN_MSG_SET_DEVICE_PRIVATE_KEY_REQ_ID = 0x10

SL_WISUN_MSG_GET_STATISTICS_REQ_ID = 0x11

SL_WISUN_MSG_SET_SOCKET_OPTION_REQ_ID = 0x12

SL_WISUN_MSG_SET_TX_POWER_REQ_ID = 0x13

SL_WISUN_MSG_SET_CHANNEL_PLAN_REQ_ID = 0x14

SL_WISUN_MSG_SET_CHANNEL_MASK_REQ_ID = 0x15

SL_WISUN_MSG_ALLOW_MAC_ADDRESS_REQ_ID = 0x16

SL_WISUN_MSG_DENY_MAC_ADDRESS_REQ_ID = 0x17

SL_WISUN_MSG_GET_SOCKET_OPTION_REQ_ID = 0x18

SL_WISUN_MSG_GET_JOIN_STATE_REQ_ID = 0x19

SL_WISUN_MSG_CLEAR_CREDENTIAL_CACHE_REQ_ID = 0x1A

SL_WISUN_MSG_GET_MAC_ADDRESS_REQ_ID = 0x1B

SL_WISUN_MSG_SET_MAC_ADDRESS_REQ_ID = 0x1C

}

Wi-SUN Message API request IDs.

enum

sl_wisun_msg_cnf_id_t {

SL_WISUN_MSG_SET_NETWORK_SIZE_CNF_ID = 0x01

SL_WISUN_MSG_CONNECT_CNF_ID = 0x02

SL_WISUN_MSG_GET_IP_ADDRESS_CNF_ID = 0x03

SL_WISUN_MSG_OPEN_SOCKET_CNF_ID = 0x04

SL_WISUN_MSG_CLOSE_SOCKET_CNF_ID = 0x05

SL_WISUN_MSG_SENDTO_ON_SOCKET_CNF_ID = 0x06

SL_WISUN_MSG_LISTEN_ON_SOCKET_CNF_ID = 0x07

SL_WISUN_MSG_ACCEPT_ON_SOCKET_CNF_ID = 0x08

SL_WISUN_MSG_CONNECT_SOCKET_CNF_ID = 0x09

SL_WISUN_MSG_BIND_SOCKET_CNF_ID = 0x0A

SL_WISUN_MSG_SEND_ON_SOCKET_CNF_ID = 0x0B

SL_WISUN_MSG_RECEIVE_ON_SOCKET_CNF_ID = 0x0C

SL_WISUN_MSG_DISCONNECT_CNF_ID = 0x0D

SL_WISUN_MSG_SET_TRUSTED_CERTIFICATE_CNF_ID = 0x0E

SL_WISUN_MSG_SET_DEVICE_CERTIFICATE_CNF_ID = 0x0F

SL_WISUN_MSG_SET_DEVICE_PRIVATE_KEY_CNF_ID = 0x10

SL_WISUN_MSG_GET_STATISTICS_CNF_ID = 0x11

SL_WISUN_MSG_SET_SOCKET_OPTION_CNF_ID = 0x12

SL_WISUN_MSG_SET_TX_POWER_CNF_ID = 0x13

SL_WISUN_MSG_SET_CHANNEL_PLAN_CNF_ID = 0x14

SL_WISUN_MSG_SET_CHANNEL_MASK_CNF_ID = 0x15

SL_WISUN_MSG_ALLOW_MAC_ADDRESS_CNF_ID = 0x16

SL_WISUN_MSG_DENY_MAC_ADDRESS_CNF_ID = 0x17

SL_WISUN_MSG_GET_SOCKET_OPTION_CNF_ID = 0x18

SL_WISUN_MSG_GET_JOIN_STATE_CNF_ID = 0x19

SL_WISUN_MSG_CLEAR_CREDENTIAL_CACHE_CNF_ID = 0x1A

SL_WISUN_MSG_GET_MAC_ADDRESS_CNF_ID = 0x1B

SL_WISUN_MSG_SET_MAC_ADDRESS_CNF_ID = 0x1C

}

Wi-SUN Message API confirmation IDs.

enum

sl_wisun_msg_ind_id_t {

SL_WISUN_MSG_CONNECTED_IND_ID = 0x81

SL_WISUN_MSG_SOCKET_DATA_IND_ID = 0x82

SL_WISUN_MSG_SOCKET_DATA_AVAILABLE_IND_ID = 0x83

SL_WISUN_MSG_SOCKET_CONNECTED_IND_ID = 0x84

SL_WISUN_MSG_SOCKET_CONNECTION_AVAILABLE_IND_ID = 0x85

SL_WISUN_MSG_SOCKET_CLOSING_IND_ID = 0x86

SL_WISUN_MSG_DISCONNECTED_IND_ID = 0x87

SL_WISUN_MSG_CONNECTION_LOST_IND_ID = 0x88

SL_WISUN_MSG_SOCKET_DATA_SENT_IND_ID = 0x89

SL_WISUN_MSG_ERROR_IND_ID = 0x8A

SL_WISUN_MSG_JOIN_STATE_IND_ID = 0x8B

}

Wi-SUN Message API indication IDs.

enum

sl_wisun_network_size_t {

SL_WISUN_NETWORK_SIZE_AUTOMATIC = 0

SL_WISUN_NETWORK_SIZE_SMALL = 1

SL_WISUN_NETWORK_SIZE_MEDIUM = 2

SL_WISUN_NETWORK_SIZE_LARGE = 3

SL_WISUN_NETWORK_SIZE_TEST = 4

SL_WISUN_NETWORK_SIZE_CERTIFICATION = 5

}

Enumerations for network size.

enum

sl_wisun_ip_address_type_t {

SL_WISUN_IP_ADDRESS_TYPE_LINK_LOCAL = 0

SL_WISUN_IP_ADDRESS_TYPE_GLOBAL = 1

SL_WISUN_IP_ADDRESS_TYPE_BORDER_ROUTER = 2

SL_WISUN_IP_ADDRESS_TYPE_PRIMARY_PARENT = 3

SL_WISUN_IP_ADDRESS_TYPE_SECONDARY_PARENT = 4

}

Enumerations for IP address type.

enum

sl_wisun_socket_protocol_t {

SL_WISUN_SOCKET_PROTOCOL_UDP = 0

SL_WISUN_SOCKET_PROTOCOL_TCP = 1

SL_WISUN_SOCKET_PROTOCOL_ICMP = 2

}

Enumerations for socket protocol.

enum

sl_wisun_certificate_option_t {

SL_WISUN_CERTIFICATE_OPTION_NONE = 0

SL_WISUN_CERTIFICATE_OPTION_APPEND = 1

SL_WISUN_CERTIFICATE_OPTION_IS_REF = 2

SL_WISUN_CERTIFICATE_OPTION_HAS_KEY = 4

}

Enumerations for certificate options.

enum

sl_wisun_private_key_option_t {

SL_WISUN_PRIVATE_KEY_OPTION_NONE = 0

SL_WISUN_PRIVATE_KEY_OPTION_IS_REF = 1

}

Enumerations for private key options.

enum

sl_wisun_socket_event_mode_t {

SL_WISUN_SOCKET_EVENT_MODE_INDICATION = 0

SL_WISUN_SOCKET_EVENT_MODE_POLLING = 1

}

Enumerations for socket event mode.

enum

sl_wisun_socket_option_t {

SL_WISUN_SOCKET_OPTION_EVENT_MODE = 0

SL_WISUN_SOCKET_OPTION_MULTICAST_GROUP = 1

SL_WISUN_SOCKET_OPTION_SEND_BUFFER_LIMIT = 2

}

Enumerations for socket option.

enum

sl_wisun_statistics_type_t {

SL_WISUN_STATISTICS_TYPE_PHY = 0

SL_WISUN_STATISTICS_TYPE_MAC = 1

SL_WISUN_STATISTICS_TYPE_FHSS = 2

SL_WISUN_STATISTICS_TYPE_WISUN = 3

SL_WISUN_STATISTICS_TYPE_NETWORK = 4

}

Enumerations for statistics type.

enum

sl_wisun_regulatory_domain_t {

SL_WISUN_REGULATORY_DOMAIN_WW = 0

SL_WISUN_REGULATORY_DOMAIN_NA = 1

SL_WISUN_REGULATORY_DOMAIN_JP = 2

SL_WISUN_REGULATORY_DOMAIN_EU = 3

SL_WISUN_REGULATORY_DOMAIN_CN = 4

SL_WISUN_REGULATORY_DOMAIN_IN = 5

SL_WISUN_REGULATORY_DOMAIN_MX = 6

SL_WISUN_REGULATORY_DOMAIN_BZ = 7

SL_WISUN_REGULATORY_DOMAIN_AZ = 8

SL_WISUN_REGULATORY_DOMAIN_NZ = 8

SL_WISUN_REGULATORY_DOMAIN_KR = 9

SL_WISUN_REGULATORY_DOMAIN_PH = 10

SL_WISUN_REGULATORY_DOMAIN_MY = 11

SL_WISUN_REGULATORY_DOMAIN_HK = 12

SL_WISUN_REGULATORY_DOMAIN_SG = 13

SL_WISUN_REGULATORY_DOMAIN_TH = 14

SL_WISUN_REGULATORY_DOMAIN_VN = 15

SL_WISUN_REGULATORY_DOMAIN_APP = 255

}

Enumerations for regulatory domain.

enum

sl_wisun_operating_class_t {

SL_WISUN_OPERATING_CLASS_1 = 1

SL_WISUN_OPERATING_CLASS_2 = 2

SL_WISUN_OPERATING_CLASS_3 = 3

SL_WISUN_OPERATING_CLASS_4 = 4

SL_WISUN_OPERATING_CLASS_5 = 5

SL_WISUN_OPERATING_CLASS_APP = 255

}

Enumerations for operating class.

enum

sl_wisun_operating_mode_t {

SL_WISUN_OPERATING_MODE_1A = 0x1a

SL_WISUN_OPERATING_MODE_1B = 0x1b

SL_WISUN_OPERATING_MODE_2A = 0x2a

SL_WISUN_OPERATING_MODE_2B = 0x2b

SL_WISUN_OPERATING_MODE_3 = 0x03

SL_WISUN_OPERATING_MODE_4A = 0x4a

SL_WISUN_OPERATING_MODE_4B = 0x4b

SL_WISUN_OPERATING_MODE_5 = 0x05

}

Enumerations for operating mode.

enum

sl_wisun_multicast_group_action_t {

SL_WISUN_MULTICAST_GROUP_ACTION_JOIN = 0

SL_WISUN_MULTICAST_GROUP_ACTION_LEAVE = 1

}

Enumerations for multicast group action.

enum

sl_wisun_channel_spacing_t {

SL_WISUN_CHANNEL_SPACING_100HZ = 0

SL_WISUN_CHANNEL_SPACING_200HZ = 1

SL_WISUN_CHANNEL_SPACING_400HZ = 2

SL_WISUN_CHANNEL_SPACING_600HZ = 3

}

Enumerations for channel spacing.

enum

sl_wisun_join_state_t {

SL_WISUN_JOIN_STATE_DISCONNECTED = 0

SL_WISUN_JOIN_STATE_SELECT_PAN = 1

SL_WISUN_JOIN_STATE_AUTHENTICATE = 2

SL_WISUN_JOIN_STATE_ACQUIRE_PAN_CONFIG = 3

SL_WISUN_JOIN_STATE_CONFIGURE_ROUTING = 4

SL_WISUN_JOIN_STATE_OPERATIONAL = 5

}

Enumerations for join state.

Typedefs#

typedef uint32_t

sl_wisun_socket_id_t

ID used identify a socket.

Macros#

#define

SL_WISUN_NETWORK_NAME_SIZE 32

Maximum size of the Wi-SUN network name.

#define

SL_WISUN_MAC_ADDRESS_SIZE 8

Size of a MAC address.

#define

SL_WISUN_IP_ADDRESS_SIZE 16

Size of an IPv6 address.

#define

SL_WISUN_CHANNEL_MASK_SIZE 32

Size of a channel mask.

#define

SL_WISUN_INVALID_SOCKET_ID 255

Socket ID value for an invalid socket.

Enumeration Documentation#

sl_wisun_msg_req_id_t#

sl_wisun_msg_req_id_t

Wi-SUN Message API request IDs.

Enumerator
SL_WISUN_MSG_SET_NETWORK_SIZE_REQ_ID
SL_WISUN_MSG_CONNECT_REQ_ID
SL_WISUN_MSG_GET_IP_ADDRESS_REQ_ID
SL_WISUN_MSG_OPEN_SOCKET_REQ_ID
SL_WISUN_MSG_CLOSE_SOCKET_REQ_ID
SL_WISUN_MSG_SENDTO_ON_SOCKET_REQ_ID
SL_WISUN_MSG_LISTEN_ON_SOCKET_REQ_ID
SL_WISUN_MSG_ACCEPT_ON_SOCKET_REQ_ID
SL_WISUN_MSG_CONNECT_SOCKET_REQ_ID
SL_WISUN_MSG_BIND_SOCKET_REQ_ID
SL_WISUN_MSG_SEND_ON_SOCKET_REQ_ID
SL_WISUN_MSG_RECEIVE_ON_SOCKET_REQ_ID
SL_WISUN_MSG_DISCONNECT_REQ_ID
SL_WISUN_MSG_SET_TRUSTED_CERTIFICATE_REQ_ID
SL_WISUN_MSG_SET_DEVICE_CERTIFICATE_REQ_ID
SL_WISUN_MSG_SET_DEVICE_PRIVATE_KEY_REQ_ID
SL_WISUN_MSG_GET_STATISTICS_REQ_ID
SL_WISUN_MSG_SET_SOCKET_OPTION_REQ_ID
SL_WISUN_MSG_SET_TX_POWER_REQ_ID
SL_WISUN_MSG_SET_CHANNEL_PLAN_REQ_ID
SL_WISUN_MSG_SET_CHANNEL_MASK_REQ_ID
SL_WISUN_MSG_ALLOW_MAC_ADDRESS_REQ_ID
SL_WISUN_MSG_DENY_MAC_ADDRESS_REQ_ID
SL_WISUN_MSG_GET_SOCKET_OPTION_REQ_ID
SL_WISUN_MSG_GET_JOIN_STATE_REQ_ID
SL_WISUN_MSG_CLEAR_CREDENTIAL_CACHE_REQ_ID
SL_WISUN_MSG_GET_MAC_ADDRESS_REQ_ID
SL_WISUN_MSG_SET_MAC_ADDRESS_REQ_ID

Definition at line 42 of file protocol/wisun/wisun/inc/sl_wisun_msg_api.h

sl_wisun_msg_cnf_id_t#

sl_wisun_msg_cnf_id_t

Wi-SUN Message API confirmation IDs.

Enumerator
SL_WISUN_MSG_SET_NETWORK_SIZE_CNF_ID
SL_WISUN_MSG_CONNECT_CNF_ID
SL_WISUN_MSG_GET_IP_ADDRESS_CNF_ID
SL_WISUN_MSG_OPEN_SOCKET_CNF_ID
SL_WISUN_MSG_CLOSE_SOCKET_CNF_ID
SL_WISUN_MSG_SENDTO_ON_SOCKET_CNF_ID
SL_WISUN_MSG_LISTEN_ON_SOCKET_CNF_ID
SL_WISUN_MSG_ACCEPT_ON_SOCKET_CNF_ID
SL_WISUN_MSG_CONNECT_SOCKET_CNF_ID
SL_WISUN_MSG_BIND_SOCKET_CNF_ID
SL_WISUN_MSG_SEND_ON_SOCKET_CNF_ID
SL_WISUN_MSG_RECEIVE_ON_SOCKET_CNF_ID
SL_WISUN_MSG_DISCONNECT_CNF_ID
SL_WISUN_MSG_SET_TRUSTED_CERTIFICATE_CNF_ID
SL_WISUN_MSG_SET_DEVICE_CERTIFICATE_CNF_ID
SL_WISUN_MSG_SET_DEVICE_PRIVATE_KEY_CNF_ID
SL_WISUN_MSG_GET_STATISTICS_CNF_ID
SL_WISUN_MSG_SET_SOCKET_OPTION_CNF_ID
SL_WISUN_MSG_SET_TX_POWER_CNF_ID
SL_WISUN_MSG_SET_CHANNEL_PLAN_CNF_ID
SL_WISUN_MSG_SET_CHANNEL_MASK_CNF_ID
SL_WISUN_MSG_ALLOW_MAC_ADDRESS_CNF_ID
SL_WISUN_MSG_DENY_MAC_ADDRESS_CNF_ID
SL_WISUN_MSG_GET_SOCKET_OPTION_CNF_ID
SL_WISUN_MSG_GET_JOIN_STATE_CNF_ID
SL_WISUN_MSG_CLEAR_CREDENTIAL_CACHE_CNF_ID
SL_WISUN_MSG_GET_MAC_ADDRESS_CNF_ID
SL_WISUN_MSG_SET_MAC_ADDRESS_CNF_ID

Definition at line 74 of file protocol/wisun/wisun/inc/sl_wisun_msg_api.h

sl_wisun_msg_ind_id_t#

sl_wisun_msg_ind_id_t

Wi-SUN Message API indication IDs.

Enumerator
SL_WISUN_MSG_CONNECTED_IND_ID	This indication is sent when a connection request has been completed.
SL_WISUN_MSG_SOCKET_DATA_IND_ID	This indication is sent when data has been received on a socket.
SL_WISUN_MSG_SOCKET_DATA_AVAILABLE_IND_ID	This indication is sent when there is buffered data available on a socket.
SL_WISUN_MSG_SOCKET_CONNECTED_IND_ID	This indication is sent when a socket connect request has been completed.
SL_WISUN_MSG_SOCKET_CONNECTION_AVAILABLE_IND_ID	This indication is sent when there is a socket connection request waiting.
SL_WISUN_MSG_SOCKET_CLOSING_IND_ID	This event is sent when a socket is waiting to be closed.
SL_WISUN_MSG_DISCONNECTED_IND_ID	This event is sent when a disconnection request has been completed.
SL_WISUN_MSG_CONNECTION_LOST_IND_ID	This event is sent when a connection to Wi-SUN network has been lost and the device is trying to regain the connection.
SL_WISUN_MSG_SOCKET_DATA_SENT_IND_ID	This event is sent when part of the buffered socket data has been sent.
SL_WISUN_MSG_ERROR_IND_ID	This event is sent when an internal stack error has occurred.
SL_WISUN_MSG_JOIN_STATE_IND_ID	This event is sent when the join state changes.

Definition at line 106 of file protocol/wisun/wisun/inc/sl_wisun_msg_api.h

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.

Definition at line 52 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 68 of file protocol/wisun/wisun/inc/sl_wisun_types.h

sl_wisun_socket_protocol_t#

sl_wisun_socket_protocol_t

Enumerations for socket protocol.

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)

Definition at line 82 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 92 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 104 of file protocol/wisun/wisun/inc/sl_wisun_types.h

sl_wisun_socket_event_mode_t#

sl_wisun_socket_event_mode_t

Enumerations for socket event mode.

Enumerator
SL_WISUN_SOCKET_EVENT_MODE_INDICATION	Received data is sent in an indication.
SL_WISUN_SOCKET_EVENT_MODE_POLLING	The amount of received data is sent in an indication.

Definition at line 112 of file protocol/wisun/wisun/inc/sl_wisun_types.h

sl_wisun_socket_option_t#

sl_wisun_socket_option_t

Enumerations for socket option.

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.

Definition at line 120 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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

Definition at line 130 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 144 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 184 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 200 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 220 of file protocol/wisun/wisun/inc/sl_wisun_types.h

sl_wisun_channel_spacing_t#

sl_wisun_channel_spacing_t

Enumerations for channel spacing.

Enumerator
SL_WISUN_CHANNEL_SPACING_100HZ	100 Hz
SL_WISUN_CHANNEL_SPACING_200HZ	200 Hz
SL_WISUN_CHANNEL_SPACING_400HZ	400 Hz
SL_WISUN_CHANNEL_SPACING_600HZ	600 Hz

Definition at line 228 of file protocol/wisun/wisun/inc/sl_wisun_types.h

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.

Definition at line 240 of file protocol/wisun/wisun/inc/sl_wisun_types.h

Typedef Documentation#

sl_wisun_socket_id_t#

typedef uint32_t sl_wisun_socket_id_t

ID used identify a socket.

Definition at line 461 of file protocol/wisun/wisun/inc/sl_wisun_types.h

Macro Definition Documentation#

SL_WISUN_NETWORK_NAME_SIZE#

#define SL_WISUN_NETWORK_NAME_SIZE

Value:

Maximum size of the Wi-SUN network name.

Definition at line 43 of file protocol/wisun/wisun/inc/sl_wisun_types.h

SL_WISUN_MAC_ADDRESS_SIZE#

#define SL_WISUN_MAC_ADDRESS_SIZE

Value:

Size of a MAC address.

Definition at line 45 of file protocol/wisun/wisun/inc/sl_wisun_types.h

SL_WISUN_IP_ADDRESS_SIZE#

#define SL_WISUN_IP_ADDRESS_SIZE

Value:

Size of an IPv6 address.

Definition at line 47 of file protocol/wisun/wisun/inc/sl_wisun_types.h

SL_WISUN_CHANNEL_MASK_SIZE#

#define SL_WISUN_CHANNEL_MASK_SIZE

Value:

Size of a channel mask.

Definition at line 49 of file protocol/wisun/wisun/inc/sl_wisun_types.h

SL_WISUN_INVALID_SOCKET_ID#

#define SL_WISUN_INVALID_SOCKET_ID

Value:

Socket ID value for an invalid socket.

Definition at line 464 of file protocol/wisun/wisun/inc/sl_wisun_types.h