nl::Weave::Profiles::NetworkProvisioning

Cet espace de noms inclut toutes les interfaces de Weave pour le profil de provisionnement Weave Network, le premier des trois profils de provisionnement Weave.

Résumé

Les interfaces définissent des codes d'état, des types de messages, des tags d'éléments de données, d'autres constantes, un objet serveur et un objet délégué.

Le profil de provisionnement réseau Nest Weave vise à fournir les données permettant d'obtenir les interfaces réseau, telles que 802.15.4/Thread et 802.11/Wi-Fi, pour un appareil Weave provisionné de sorte que l'appareil puisse participer à ces réseaux.

Énumérations
@212{
  kStatusCode_UnknownNetwork = 1,
  kStatusCode_TooManyNetworks = 2,
  kStatusCode_InvalidNetworkConfiguration = 3,
  kStatusCode_UnsupportedNetworkType = 4,
  kStatusCode_UnsupportedWiFiMode = 5,
  kStatusCode_UnsupportedWiFiRole = 6,
  kStatusCode_UnsupportedWiFiSecurityType = 7,
  kStatusCode_InvalidState = 8,
  kStatusCode_TestNetworkFailed = 9,
  kStatusCode_NetworkConnectFailed = 10,
  kStatusCode_NoRouterAvailable = 11,
  kStatusCode_UnsupportedRegulatoryDomain = 12,
  kStatusCode_UnsupportedOperatingLocation = 13
} 		énum
Codes d'état de provisionnement du réseau.
@213 énum
Types de messages de provisionnement réseau.
@214{
  kTag_Networks = 1,
  kTag_EnabledNetworks = 2,
  kTag_RendezvousMode = 3,
  kTag_NetworkInformation = 32,
  kTag_NetworkId = 33,
  kTag_NetworkType = 34,
  kTag_WirelessSignalStrength = 35,
  kTag_WiFiSSID = 64,
  kTag_WiFiMode = 65,
  kTag_WiFiRole = 66,
  kTag_WiFiSecurityType = 67,
  kTag_WiFiPreSharedKey = 68,
  kTag_ThreadExtendedPANId = 80,
  kTag_ThreadNetworkName = 81,
  kTag_ThreadNetworkKey = 82,
  kTag_ThreadMeshPrefix = 83,
  kTag_ThreadChannel = 84,
  kTag_ThreadPANId = 85,
  kTag_ThreadPSKc = 86,
  kTag_WirelessRegConfig_RegulatoryDomain = 1,
  kTag_WirelessRegConfig_OperatingLocation = 2,
  kTag_WirelessRegConfig_SupportedRegulatoryDomains = 3
} 		énum
@215 énum
ID PAN du thread.
@216 énum
Canal Thread.
GetNetworkFlags énum
Obtenir les indicateurs de réseau.
NetworkType énum
Types de réseaux.
RendezvousModeFlags énum
Indicateurs du mode RendezVous.
WiFiMode énum
Modes de fonctionnement Wi-Fi.
WiFiRole énum
Rôle Wi-Fi de l'appareil.
WiFiSecurityType énum
Modes de sécurité Wi-Fi.
WirelessOperatingLocation{
  kWirelessOperatingLocation_NotSpecified = 0x00,
  kWirelessOperatingLocation_Unknown = 0x01,
  kWirelessOperatingLocation_Indoors = 0x02,
  kWirelessOperatingLocation_Outdoors = 0x03
} 		énum
Emplacement du fonctionnement de l'appareil, conformément aux réglementations sur les réseaux sans fil

Fonctions
ReplaceValue(char *& dest, const char *src)
ReplaceValue(uint8_t *& dest, uint32_t & destLen, const uint8_t *src, uint32_t srcLen)

Classes
nl::Weave::Profiles::NetworkProvisioning::NetworkInfo

Classe utilitaire permettant de sérialiser et désérialiser les charges utiles communiquées via le profil NetworkProvisioning: elle encapsule les informations pertinentes pour la détection et la configuration des réseaux.

nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

Déléguez la classe pour l'implémentation d'opérations de provisionnement du réseau.

nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

Classe serveur permettant d'implémenter le profil de provisionnement du réseau.

nl::Weave::Profiles::NetworkProvisioning::WirelessRegConfig

Conteneur pour les informations de configuration réglementaire sur les réseaux sans fil.

Structs
nl::Weave::Profiles::NetworkProvisioning::WirelessRegDomain

Code à deux caractères identifiant un domaine réglementaire pour les réseaux sans fil.

Énumérations

@212

 @212

Codes d'état de provisionnement du réseau.

Propriétés
kStatusCode_InvalidNetworkConfiguration

La configuration réseau spécifiée n'est pas valide.

kStatusCode_InvalidState

Impossible d'effectuer l'opération de provisionnement du réseau dans l'état actuel.

kStatusCode_NetworkConnectFailed

La tentative de connexion au réseau spécifié a échoué.

kStatusCode_NoRouterAvailable

Aucun routeur réseau approprié n'a été trouvé.

kStatusCode_TestNetworkFailed

Échec du test de connectivité du réseau spécifié.

kStatusCode_TooManyNetworks

Le nombre maximal de réseaux provisionnés a été atteint.

kStatusCode_UnknownNetwork

Impossible de trouver un réseau provisionné correspondant à l'ID de réseau spécifié.

kStatusCode_UnsupportedNetworkType

Le type de réseau spécifié est inconnu ou non compatible.

kStatusCode_UnsupportedOperatingLocation

L'emplacement de fonctionnement sans fil spécifié n'est pas pris en charge.

kStatusCode_UnsupportedRegulatoryDomain

Le domaine de réglementation sur les réseaux sans fil spécifié n'est pas pris en charge.

kStatusCode_UnsupportedWiFiMode

Le mode Wi-Fi spécifié n'est pas pris en charge.

kStatusCode_UnsupportedWiFiRole

Le rôle Wi-Fi spécifié n'est pas compatible.

kStatusCode_UnsupportedWiFiSecurityType

Le type de sécurité Wi-Fi spécifié n'est pas pris en charge.

@213

 @213

Types de messages de provisionnement réseau.

@214

 @214

Tags d'élément de données de provisionnement réseau.

Propriétés
kTag_EnabledNetworks

[ array ] Tableau d'ID réseau identifiant les réseaux actuellement activés sur l'appareil.

kTag_NetworkId

[ uint, 32-bit max ] Entier identifiant de manière unique un réseau provisionné.

kTag_NetworkInformation

[ struct ] Structure contenant des informations pour un réseau.

kTag_NetworkType

[ uint, 8-bit max ] Valeur entière non signée identifiant le type d'un réseau.

kTag_Networks

[ array ] Tableau des structures NetworkConfiguration.

kTag_RendezvousMode

[ uint ] Champ de bits indiquant le mode de rendez-vous actuellement actif.

kTag_ThreadChannel

[ uint, 8-bit max ] Numéro de canal de thread (facultatif).

kTag_ThreadExtendedPANId

[ byte string ] ID de PAN étendu Thread.

kTag_ThreadMeshPrefix

[ bytes string, specific 8 bytes ] Préfixe IPv6 /64 du maillage de threads (facultatif)

kTag_ThreadNetworkKey

[ bytes string ] Clé de réseau maître Thread.

kTag_ThreadNetworkName

[ UTF-8 string ] Chaîne UTF-8 contenant le nom du réseau Thread.

kTag_ThreadPANId

[ uint, 16-bit max ] ID de PAN du thread (facultatif).

kTag_ThreadPSKc

[ uint, 16-bit max ] PSKc thread (facultatif).

kTag_WiFiMode

[ uint, 8-bit max ] Nombre entier identifiant le mode de fonctionnement du réseau Wi-Fi.

kTag_WiFiPreSharedKey

[ byte string ] Chaîne d'octets contenant le mot de passe ou la clé pré-partagée du réseau Wi-Fi.

kTag_WiFiRole

[ uint, 8-bit max ] Nombre entier permettant d'identifier le rôle de l'appareil sur le réseau Wi-Fi.

kTag_WiFiSSID

[ UTF-8 string ] Chaîne contenant un SSID Wi-Fi.

kTag_WiFiSecurityType

[ uint, 8-bit max ] Valeur entière identifiant le type de sécurité utilisé par un réseau Wi-Fi.

kTag_WirelessRegConfig_OperatingLocation

[ uint enum, 8-bit max ] Lieu d'exploitation conformément aux réglementations sur les réseaux sans fil

kTag_WirelessRegConfig_RegulatoryDomain

[ UTF-8 string, len 2 ] Domaine de réglementation des réseaux sans fil.

kTag_WirelessRegConfig_SupportedRegulatoryDomains

[ array of string len 2 ] Liste des domaines de réglementation pris en charge.

kTag_WirelessSignalStrength

[ int, 16-bit max ] Valeur entière signée indiquant l'intensité du signal d'un réseau sans fil en dBm.

@215

 @215

ID PAN du thread.

@216

 @216

Canal Thread.

GetNetworkFlags

 GetNetworkFlags

Obtenir des indicateurs de réseau.

NetworkType

 NetworkType

Types de réseaux.

RendezvousModeFlags

 RendezvousModeFlags

Indicateurs du mode RendezVous.

WiFiMode

 WiFiMode

Modes de fonctionnement Wi-Fi.

WiFiRole

 WiFiRole

Rôle Wi-Fi de l'appareil.

WiFiSecurityType

 WiFiSecurityType

Modes de sécurité Wi-Fi.

WirelessOperatingLocation

 WirelessOperatingLocation

Emplacement du fonctionnement de l'appareil, conformément aux réglementations sur les réseaux sans fil

Propriétés
kWirelessOperatingLocation_Indoors

Utilisation à l'intérieur.

Indique que l'appareil doit être utilisé à l'intérieur.

kWirelessOperatingLocation_NotSpecified

Valeur réservée.

Ils ne peuvent pas être envoyés par e-mail.

kWirelessOperatingLocation_Outdoors

Utilisation à l'extérieur.

Indique que l'appareil doit être utilisé à l'extérieur.

kWirelessOperatingLocation_Unknown

Lieu de fonctionnement inconnu.

Indique que l'emplacement de fonctionnement attendu de l'appareil est inconnu ou peut changer au fil du temps.

Fonctions

ReplaceValue

WEAVE_ERROR ReplaceValue(
  char *& dest,
  const char *src
)

ReplaceValue

WEAVE_ERROR ReplaceValue(
  uint8_t *& dest,
  uint32_t & destLen,
  const uint8_t *src,
  uint32_t srcLen
)