Constants#

This section provides a reference to Network Management API constants.

Enumerations#

enum

sl_net_interface_t {

SL_NET_WIFI_CLIENT_INTERFACE = (1 << 3)

SL_NET_WIFI_AP_INTERFACE = (2 << 3)

SL_NET_ETHERNET_INTERFACE = (3 << 3)

SL_NET_THREAD_INTERFACE = (4 << 3)

SL_NET_BLUETOOTH_INTERFACE = (5 << 3)

SL_NET_ZWAVE_INTERFACE = (6 << 3)

SL_NET_WIFI_BTR_INTERFACE = (7 << 3)

}

Enumeration of network interfaces.

enum

sl_net_packet_type_t {

SL_NET_UDP_PACKET

SL_NET_TCP_PACKET

SL_NET_ETHERNET_PACKET

SL_NET_TLS_PACKET

SL_NET_DTLS_PACKET

SL_NET_THREAD_PACKET

SL_NET_BLUETOOTH_PACKET

SL_NET_ZWAVE_PACKET

SL_NET_ZIGBEE_PACKET

SL_NET_6LOWPAN_PACKET

SL_NET_RAW_PACKET

}

Enumeration of network packet types.

enum

sl_net_address_resolution_t {

SL_NET_AUTOMATIC_ADDRESS_RESOLUTION

SL_NET_STATIC_ADDRESS_RESOLUTION

SL_NET_DHCP_ADDRESS_RESOLUTION = SL_NET_AUTOMATIC_ADDRESS_RESOLUTION

SL_NET_LINK_LOCAL_ADDRESS_RESOLUTION

}

Enumeration of IP address resolution methods.

enum

sl_net_dns_resolution_ip_type_t {

SL_NET_DNS_TYPE_IPV4

SL_NET_DNS_TYPE_IPV6

}

Enumeration of DNS resolution IP type.

enum

sl_net_event_t {

SL_NET_PING_RESPONSE_EVENT

SL_NET_DNS_RESOLVE_EVENT

SL_NET_OTA_FW_UPDATE_EVENT

SL_NET_EVENT_COUNT

}

Enumeration of SL-Net Event.

enum

sl_net_profile_id_t {

SL_NET_PROFILE_ID_0 = 0

SL_NET_PROFILE_ID_1 = 1

SL_NET_PROFILE_ID_2 = 2

SL_NET_PROFILE_ID_3 = 3

SL_NET_PROFILE_ID_4 = 4

SL_NET_PROFILE_ID_5 = 5

SL_NET_PROFILE_ID_6 = 6

SL_NET_PROFILE_ID_7 = 7

SL_NET_PROFILE_ID_8 = 8

SL_NET_PROFILE_ID_9 = 9

SL_NET_PROFILE_ID_10 = 10

SL_NET_DEFAULT_WIFI_CLIENT_PROFILE_ID = SL_NET_PROFILE_ID_0

SL_NET_DEFAULT_WIFI_AP_PROFILE_ID = SL_NET_PROFILE_ID_0

SL_NET_DEFAULT_ETHERNET_PROFILE_ID = SL_NET_PROFILE_ID_0

SL_NET_DEFAULT_THREAD_PROFILE_ID = SL_NET_PROFILE_ID_0

SL_NET_DEFAULT_ZWAVE_PROFILE_ID = SL_NET_PROFILE_ID_0

SL_NET_DEFAULT_WIFI_BTR_PROFILE_ID = SL_NET_PROFILE_ID_0

}

SL Network profile ID.

enum

sl_net_credential_type_t {

SL_NET_INVALID_CREDENTIAL_TYPE

SL_NET_WIFI_PSK

SL_NET_WIFI_PMK

SL_NET_WIFI_WEP

SL_NET_CERTIFICATE

SL_NET_PUBLIC_KEY

SL_NET_PRIVATE_KEY

SL_NET_SIGNING_CERTIFICATE

SL_NET_HTTP_CLIENT_CREDENTIAL

SL_NET_EAP_CLIENT_CREDENTIAL

SL_NET_MQTT_CLIENT_CREDENTIAL

}

Enumeration of network credential types.

enum

sl_net_credential_id_t {

SL_NET_INVALID_CREDENTIAL_ID = 0

SL_NET_DEFAULT_WIFI_CLIENT_CREDENTIAL_ID = 1

SL_NET_DEFAULT_WIFI_AP_CREDENTIAL_ID = 2

SL_NET_WIFI_EAP_CLIENT_CREDENTIAL_ID = 3

SL_NET_WIFI_EAP_SERVER_CREDENTIAL_ID = 4

SL_NET_USER_CREDENTIAL_ID = 5

SL_NET_TLS_CLIENT_CREDENTIAL_START = (1 << 8)

SL_NET_TLS_SERVER_CREDENTIAL_START = (2 << 8)

SL_NET_MQTT_SERVER_CREDENTIAL_START = (3 << 8)

SL_NET_MQTT_CLIENT_CREDENTIAL_START = (4 << 8)

SL_NET_HTTP_SERVER_CREDENTIAL_START = (5 << 8)

SL_NET_HTTP_CLIENT_CREDENTIAL_START = (6 << 8)

}

Enumeration of network credential identifiers.

Typedefs#

typedef uint32_t

sl_net_certificate_id_t

Unique Certificate store Id.

Macros#

#define

SL_NET_CREDENTIAL_GROUP_MASK 0xFF00

Credential Group Mask.

#define

SL_NET_TLS_CLIENT_CREDENTIAL_ID (x)

TLS Client Credential ID.

#define

SL_NET_TLS_SERVER_CREDENTIAL_ID (x)

TLS Server Credential ID.

#define

SL_NET_MQTT_SERVER_CREDENTIAL_ID (x)

MQTT Server Credential ID.

#define

SL_NET_MQTT_CLIENT_CREDENTIAL_ID (x)

MQTT Client Credential ID.

#define

SL_NET_HTTP_SERVER_CREDENTIAL_ID (x)

HTTP Server Credential ID.

#define

SL_NET_HTTP_CLIENT_CREDENTIAL_ID (x)

HTTP Client Credential ID.

Enumeration Documentation#

sl_net_interface_t#

sl_net_interface_t

Enumeration of network interfaces.

Note

Only Wi-Fi client and Wi-Fi access point interfaces currently supported.

Enumerator
SL_NET_WIFI_CLIENT_INTERFACE	Wi-Fi Client Interface.
SL_NET_WIFI_AP_INTERFACE	Wi-Fi Access Point Interface.
SL_NET_ETHERNET_INTERFACE	Ethernet Interface (not currently supported)
SL_NET_THREAD_INTERFACE	Thread Interface (not currently supported)
SL_NET_BLUETOOTH_INTERFACE	Bluetooth Interface (not currently supported)
SL_NET_ZWAVE_INTERFACE	Z-Wave Interface (not currently supported)
SL_NET_WIFI_BTR_INTERFACE	Wi-Fi Basic Transceiver Mode.

Definition at line 47 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_packet_type_t#

sl_net_packet_type_t

Enumeration of network packet types.

Enumerator
SL_NET_UDP_PACKET
SL_NET_TCP_PACKET	UDP Packet.
SL_NET_ETHERNET_PACKET	TCP Packet.
SL_NET_TLS_PACKET	Ethernet Packet.
SL_NET_DTLS_PACKET	TLS Packet.
SL_NET_THREAD_PACKET	DTLS Packet.
SL_NET_BLUETOOTH_PACKET	Thread Packet.
SL_NET_ZWAVE_PACKET	Bluetooth Packet.
SL_NET_ZIGBEE_PACKET	Zwave Packet.
SL_NET_6LOWPAN_PACKET	Zigbee Packet.
SL_NET_RAW_PACKET	LOWPAN Packet.

Definition at line 84 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_address_resolution_t#

sl_net_address_resolution_t

Enumeration of IP address resolution methods.

Note

Link local address resolution not currently supported.

Enumerator
SL_NET_AUTOMATIC_ADDRESS_RESOLUTION	Automatic Address Resolution.
SL_NET_STATIC_ADDRESS_RESOLUTION	Static Address Resolution.
SL_NET_DHCP_ADDRESS_RESOLUTION	DHCP Address Resolution.
SL_NET_LINK_LOCAL_ADDRESS_RESOLUTION	Link Local Address Resolution (not currently supported)

Definition at line 100 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_dns_resolution_ip_type_t#

sl_net_dns_resolution_ip_type_t

Enumeration of DNS resolution IP type.

Enumerator
SL_NET_DNS_TYPE_IPV4	IPV4 DNS Address resolution.
SL_NET_DNS_TYPE_IPV6	IPV6 DNS Address resolution.

Definition at line 108 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_event_t#

sl_net_event_t

Enumeration of SL-Net Event.

Enumerator
SL_NET_PING_RESPONSE_EVENT	Ping Response Event.
SL_NET_DNS_RESOLVE_EVENT	DNS Address resolution Event.
SL_NET_OTA_FW_UPDATE_EVENT	OTA Firmware Update Event.
SL_NET_EVENT_COUNT	Maximum event count.

Definition at line 114 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_profile_id_t#

sl_net_profile_id_t

SL Network profile ID.

Note

Ethernet, Thread and Z-Wave profiles not currently supported.

Enumerator
SL_NET_PROFILE_ID_0	Profile Id 0.
SL_NET_PROFILE_ID_1	Profile Id 1.
SL_NET_PROFILE_ID_2	Profile Id 2.
SL_NET_PROFILE_ID_3	Profile Id 3.
SL_NET_PROFILE_ID_4	Profile Id 4.
SL_NET_PROFILE_ID_5	Profile Id 5.
SL_NET_PROFILE_ID_6	Profile Id 6.
SL_NET_PROFILE_ID_7	Profile Id 7.
SL_NET_PROFILE_ID_8	Profile Id 8.
SL_NET_PROFILE_ID_9	Profile Id 9.
SL_NET_PROFILE_ID_10	Profile Id 10.
SL_NET_DEFAULT_WIFI_CLIENT_PROFILE_ID	Wi-Fi Client Default Profile.
SL_NET_DEFAULT_WIFI_AP_PROFILE_ID	Wi-Fi Access Point Default Profile.
SL_NET_DEFAULT_ETHERNET_PROFILE_ID	Ethernet Default Profile (not currently supported)
SL_NET_DEFAULT_THREAD_PROFILE_ID	Thread Default Profile (not currently supported)
SL_NET_DEFAULT_ZWAVE_PROFILE_ID	Zwave Default Profile (not currently supported)
SL_NET_DEFAULT_WIFI_BTR_PROFILE_ID	Wi-Fi BTR Default Profile.

Definition at line 123 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_credential_type_t#

sl_net_credential_type_t

Enumeration of network credential types.

Enumerator
SL_NET_INVALID_CREDENTIAL_TYPE	Invalid Credential Type.
SL_NET_WIFI_PSK	Wi-Fi PSk Credential.
SL_NET_WIFI_PMK	Wi-Fi PMK Credential.
SL_NET_WIFI_WEP	Wi-Fi WEP Credential.
SL_NET_CERTIFICATE	TLS Client Certificate.
SL_NET_PUBLIC_KEY	TLS Certificate Public key.
SL_NET_PRIVATE_KEY	TLS Certificate Private key.
SL_NET_SIGNING_CERTIFICATE	TLS CA Certificate.
SL_NET_HTTP_CLIENT_CREDENTIAL	HTTP Client Credential.
SL_NET_EAP_CLIENT_CREDENTIAL	Wi-Fi EAP Credential.
SL_NET_MQTT_CLIENT_CREDENTIAL	MQTT Client Credential.

Definition at line 145 of file components/service/network_manager/inc/sl_net_constants.h

sl_net_credential_id_t#

sl_net_credential_id_t

Enumeration of network credential identifiers.

Enumerator
SL_NET_INVALID_CREDENTIAL_ID	Invalid Credential Id.
SL_NET_DEFAULT_WIFI_CLIENT_CREDENTIAL_ID	Wi-Fi Client Credential Id.
SL_NET_DEFAULT_WIFI_AP_CREDENTIAL_ID	Wi-Fi Access Point Credential Id.
SL_NET_WIFI_EAP_CLIENT_CREDENTIAL_ID	Wi-Fi EAP Client Credential Id.
SL_NET_WIFI_EAP_SERVER_CREDENTIAL_ID	Wi-Fi EAP Server Credential Id.
SL_NET_USER_CREDENTIAL_ID	User Credential Id.
SL_NET_TLS_CLIENT_CREDENTIAL_START	TLS Client Credential Id.
SL_NET_TLS_SERVER_CREDENTIAL_START	TLS Server Credential Id.
SL_NET_MQTT_SERVER_CREDENTIAL_START	MQTT Server Credential Id.
SL_NET_MQTT_CLIENT_CREDENTIAL_START	MQTT Client Credential Id.
SL_NET_HTTP_SERVER_CREDENTIAL_START	HTTP Server Credential Id.
SL_NET_HTTP_CLIENT_CREDENTIAL_START	HTTP Client Credential Id.

Definition at line 174 of file components/service/network_manager/inc/sl_net_constants.h

Typedef Documentation#

sl_net_certificate_id_t#

typedef uint32_t sl_net_certificate_id_t

Unique Certificate store Id.

Definition at line 189 of file components/service/network_manager/inc/sl_net_constants.h

Macro Definition Documentation#

SL_NET_CREDENTIAL_GROUP_MASK#

#define SL_NET_CREDENTIAL_GROUP_MASK

Value:

0xFF00

Credential Group Mask.

Definition at line 159 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_TLS_CLIENT_CREDENTIAL_ID#

#define SL_NET_TLS_CLIENT_CREDENTIAL_ID

Value:

(x)

TLS Client Credential ID.

Definition at line 161 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_TLS_SERVER_CREDENTIAL_ID#

#define SL_NET_TLS_SERVER_CREDENTIAL_ID

Value:

(x)

TLS Server Credential ID.

Definition at line 163 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_MQTT_SERVER_CREDENTIAL_ID#

#define SL_NET_MQTT_SERVER_CREDENTIAL_ID

Value:

(x)

MQTT Server Credential ID.

Definition at line 165 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_MQTT_CLIENT_CREDENTIAL_ID#

#define SL_NET_MQTT_CLIENT_CREDENTIAL_ID

Value:

(x)

MQTT Client Credential ID.

Definition at line 167 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_HTTP_SERVER_CREDENTIAL_ID#

#define SL_NET_HTTP_SERVER_CREDENTIAL_ID

Value:

(x)

HTTP Server Credential ID.

Definition at line 169 of file components/service/network_manager/inc/sl_net_constants.h

SL_NET_HTTP_CLIENT_CREDENTIAL_ID#

#define SL_NET_HTTP_CLIENT_CREDENTIAL_ID

Value:

(x)

HTTP Client Credential ID.

Definition at line 171 of file components/service/network_manager/inc/sl_net_constants.h