Constants#

This section provides a reference to Network Management API constants.

Enumerations#

enum
SL_IPV4_VERSION = 4
SL_IPV6_VERSION = 6
}

Enumeration of IP version.

enum
SL_IPV4 = (1 << 2)
SL_IPV6 = (1 << 3)
SL_IPV6_LINK_LOCAL = SL_IPV6 + 1
SL_IPV6_SITE_LOCAL = SL_IPV6 + 2
SL_IPV6_GLOBAL = SL_IPV6 + 3
SL_INVALID_IP = 0
}

Enumeration of IP address types/// Enumeration of IP address types.

enum
SL_IP_MANAGEMENT_STATIC_IP = 1
SL_IP_MANAGEMENT_DHCP
SL_IP_MANAGEMENT_LINK_LOCAL
}

Enumeration of IP Management type.

enum
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)
}

Enumeration of network interfaces.

enum
SL_NET_DNS_TYPE_IPV4
SL_NET_DNS_TYPE_IPV6
}

Enumeration of DNS resolution IP types.

enum
SL_NET_PING_RESPONSE_EVENT
SL_NET_DNS_RESOLVE_EVENT
SL_NET_OTA_FW_UPDATE_EVENT
SL_NET_DHCP_NOTIFICATION_EVENT
SL_NET_IP_ADDRESS_CHANGE_EVENT
SL_NET_EVENT_COUNT
}

Enumeration of SL-Net Events.

enum
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
}

Enumeration of SL Network profile IDs.

enum
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_PACK_FILE
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_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

Unique identifier for a certificate in the certificate store.

Macros#

#define

Mask for extracting the credential group from a credential ID.

#define

Macro to generate a TLS Client Credential ID.

#define

Macro to generate a TLS Server Credential ID.

#define

Macro to generate an MQTT Server Credential ID.

#define

Macro to generate an MQTT Client Credential ID.

#define

Macro to generate an HTTP Server Credential ID.

#define

Macro to generate an HTTP Client Credential ID.

Enumeration Documentation#

sl_ip_version_t#

sl_ip_version_t

Enumeration of IP version.

Enumerator
SL_IPV4_VERSION

IPv4 version.

SL_IPV6_VERSION

IPv6 version.


Definition at line 39 of file components/common/inc/sl_ip_types.h

sl_ip_address_type_t#

sl_ip_address_type_t

Enumeration of IP address types/// Enumeration of IP address types.

Enumerator
SL_IPV4

IPv4 address.

SL_IPV6

IPv6, Unspecified sub-type.

SL_IPV6_LINK_LOCAL

IPv6, Link local address.

SL_IPV6_SITE_LOCAL

IPv6, Site local address.

SL_IPV6_GLOBAL

IPv6, Global address.

SL_INVALID_IP

This enumeration value represents an invalid IP address.


Definition at line 45 of file components/common/inc/sl_ip_types.h

sl_ip_management_t#

sl_ip_management_t

Enumeration of IP Management type.

Enumerator
SL_IP_MANAGEMENT_STATIC_IP

Assign STATIC IP address to an interface.

SL_IP_MANAGEMENT_DHCP

Assign IP address to an interface dynamically using DHCP.

SL_IP_MANAGEMENT_LINK_LOCAL

Assign IP address using link-local addressing.


Definition at line 55 of file components/common/inc/sl_ip_types.h

sl_net_interface_t#

sl_net_interface_t

Enumeration of network interfaces.

This enumeration defines the various network interfaces supported by the system. Currently, only SL_NET_WIFI_CLIENT_INTERFACE and SL_NET_WIFI_AP_INTERFACE are 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)


Definition at line 54 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 types.

This enumeration defines the types of IP addresses that can be resolved by DNS. It includes both IPv4 and IPv6 address types.

Enumerator
SL_NET_DNS_TYPE_IPV4

IPV4 DNS Address resolution.

SL_NET_DNS_TYPE_IPV6

IPV6 DNS Address resolution.


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

sl_net_event_t#

sl_net_event_t

Enumeration of SL-Net Events.

This enumeration defines the various network events that can be handled by the system. Each event type corresponds to a specific network-related occurrence.

Enumerator
SL_NET_PING_RESPONSE_EVENT

Event triggered when a ping response is received.

SL_NET_DNS_RESOLVE_EVENT

Event triggered when a DNS address resolution occurs.

SL_NET_OTA_FW_UPDATE_EVENT

Event triggered when an OTA firmware update is completed.

SL_NET_DHCP_NOTIFICATION_EVENT

Event triggered when a DHCP notification is received.

SL_NET_IP_ADDRESS_CHANGE_EVENT

Event triggered when there is a DHCP IP address change.

SL_NET_EVENT_COUNT

Represents the maximum count of events. Used internally by the SDK.


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

sl_net_profile_id_t#

sl_net_profile_id_t

Enumeration of SL Network profile IDs.

This enumeration defines the various profile IDs that can be used in the SL Network. Each profile ID corresponds to a specific network profile.

Note

  • Ethernet, Thread, and Z-Wave profiles are defined but 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).


Definition at line 122 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.

This enumeration defines the various types of network credentials that can be used for authentication and security purposes.

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_PACK_FILE

EAP Fast Pack File.

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 149 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.

This enumeration defines the various identifiers for network credentials used within the system. Each identifier corresponds to a specific type of credential.

Note

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 183 of file components/service/network_manager/inc/sl_net_constants.h

Typedef Documentation#

sl_net_certificate_id_t#

sl_net_certificate_id_t

Unique identifier for a certificate in the certificate store.

This defines a unique identifier for the certificates stored in the certificate store. It is used as a reference and to manage certificates within the system.


Definition at line 171 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

Mask for extracting the credential group from a credential ID.

This mask is used to extract the group portion of a credential ID. It helps in identifying the group to which a credential belongs.

The credential group can be one of the value from sl_net_credential_id_t.


Definition at line 209 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)

Macro to generate a TLS Client Credential ID.

This macro generates a unique TLS Client Credential ID by adding an offset to the base TLS Client Credential ID.

x Offset to be added to the base TLS Client Credential ID.

Note


Definition at line 224 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)

Macro to generate a TLS Server Credential ID.

This macro generates a unique TLS Server Credential ID by adding an offset to the base TLS Server Credential ID.

x Offset to be added to the base TLS Server Credential ID.

Note


Definition at line 239 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)

Macro to generate an MQTT Server Credential ID.

This macro generates a unique MQTT Server Credential ID by adding an offset to the base MQTT Server Credential ID.

x Offset to be added to the base MQTT Server Credential ID.

Note

  • The valid values for x is only 0.


Definition at line 253 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)

Macro to generate an MQTT Client Credential ID.

This macro generates a unique MQTT Client Credential ID by adding an offset to the base MQTT Client Credential ID.

x Offset to be added to the base MQTT Client Credential ID.

Note

  • The valid values for x is only 0.


Definition at line 267 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)

Macro to generate an HTTP Server Credential ID.

This macro generates a unique HTTP Server Credential ID by adding an offset to the base HTTP Server Credential ID.

x Offset to be added to the base HTTP Server Credential ID.

Note

  • The valid values for x is only 0.


Definition at line 281 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)

Macro to generate an HTTP Client Credential ID.

This macro generates a unique HTTP Client Credential ID by adding an offset to the base HTTP Client Credential ID.

x Offset to be added to the base HTTP Client Credential ID.

Note

  • The valid values for x is only 0.


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