Constants#
This section provides a reference to Network Management API constants.
Enumerations#
Enumeration of IP address types/// Enumeration of IP address types.
Enumeration of IP Management type.
Enumeration of network interfaces.
Enumeration of DNS resolution IP types.
Enumeration of SL-Net Events.
Enumeration of SL Network profile IDs.
Enumeration of network credential types.
Enumeration of network credential identifiers.
Typedefs#
Unique identifier for a certificate in the certificate store.
Macros#
Mask for extracting the credential group from a credential ID.
Macro to generate a TLS Client Credential ID.
Macro to generate a TLS Server Credential ID.
Macro to generate an MQTT Server Credential ID.
Macro to generate an MQTT Client Credential ID.
Macro to generate an HTTP Server Credential ID.
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. |
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. |
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. |
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) |
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. |
73
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. |
85
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). |
104
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. |
131
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
In case of sl_net_credential_type_t of SL_NET_CERTIFICATE, SL_NET_PUBLIC_KEY, SL_NET_PRIVATE_KEY, SL_NET_SIGNING_CERTIFICATE, SL_NET_PACK_FILE, the user can ONLY set SL_NET_WIFI_EAP_CLIENT_CREDENTIAL_ID, SL_NET_WIFI_EAP_SERVER_CREDENTIAL_ID, SL_NET_TLS_CLIENT_CREDENTIAL_START, or SL_NET_TLS_SERVER_CREDENTIAL_START at a time for Si91x devices.
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. |
165
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.
153
of file components/service/network_manager/inc/sl_net_constants.h