nl::Weave::Profiles::DeviceControl

Cet espace de noms inclut toutes les interfaces de Weave pour le profil Weave Device Control.

Résumé

Le profil de contrôle de l'appareil facilite les opérations client-serveur de sorte que le client (l'appareil de contrôle) puisse déclencher des fonctionnalités utilitaires spécifiques sur le serveur (l'appareil en cours de configuration) pour faciliter et permettre le processus de configuration et de provisionnement de l'appareil. Cela inclut, par exemple, la réinitialisation de la configuration du serveur et l'activation de coffres-forts de sécurité qui définissent le comportement en cas d'annulation prématurée de la procédure de configuration.

Énumérations
@172{
  kStatusCode_FailSafeAlreadyActive = 1,
  kStatusCode_NoFailSafeActive = 2,
  kStatusCode_NoMatchingFailSafeActive = 3,
  kStatusCode_UnsupportedFailSafeMode = 4,
  kStatusCode_RemotePassiveRendezvousTimedOut = 5,
  kStatusCode_UnsecuredListenPreempted = 6,
  kStatusCode_ResetSuccessCloseCon = 7,
  kStatusCode_ResetNotAllowed = 8,
  kStatusCode_NoSystemTestDelegate = 9
} 		énum
Codes d'état des commandes de contrôle des appareils.
@173{
  kMsgType_ResetConfig = 1,
  kMsgType_ArmFailSafe = 2,
  kMsgType_DisarmFailSafe = 3,
  kMsgType_EnableConnectionMonitor = 4,
  kMsgType_DisableConnectionMonitor = 5,
  kMsgType_RemotePassiveRendezvous = 6,
  kMsgType_RemoteConnectionComplete = 7,
  kMsgType_StartSystemTest = 8,
  kMsgType_StopSystemTest = 9,
  kMsgType_LookingToRendezvous = 10
} 		énum
Types de messages de contrôle des appareils.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
} 		énum
Valeurs du mode ArmFailSafe.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
} 		énum
Options de réinitialisation de configuration.
@176{
  kMessageLength_ResetConfig = 2,
  kMessageLength_ArmFailsafe = 5,
  kMessageLength_DisarmFailsafe = 0,
  kMessageLength_EnableConnectionMonitor = 4,
  kMessageLength_DisableConnectionMonitor = 0,
  kMessageLength_RemotePassiveRendezvous = 20,
  kMessageLength_StartSystemTest = 8,
  kMessageLength_StopSystemTest = 0
} 		énum
Longueurs des messages.

Fonctions
SendLookingToRendezvous(ExchangeContext *ec)
Envoyez un message LookToRendezVous au pair.

Classes
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Classe déléguée pour l'implémentation d'opérations entrantes de contrôle des appareils sur l'appareil serveur.

nl::Weave::Profiles::DeviceControl::DeviceControlServer

Classe serveur permettant d'implémenter le profil de contrôle des appareils.

Énumérations

@172

 @172

Codes d'état des commandes de contrôle des appareils.

Propriétés
kStatusCode_FailSafeAlreadyActive

Un provisionnement de sécurité renforcée est déjà actif.

kStatusCode_NoFailSafeActive

Aucun provisionnement de sécurité n'est actif.

kStatusCode_NoMatchingFailSafeActive

Le jeton de sécurité intégrée au provisionnement ne correspondait pas au jeton de sécurité sécurisé actif.

kStatusCode_NoSystemTestDelegate

Le test du système ne peut pas s'exécuter sans délégué.

kStatusCode_RemotePassiveRendezvousTimedOut

Aucun appareil n'a été connecté au serveur de contrôle des appareils au cours de la période de rendez-vous spécifiée par le client.

kStatusCode_ResetNotAllowed

L'appareil a refusé la réinitialisation demandée.

kStatusCode_ResetSuccessCloseCon

La méthode "ResetConfig" aboutit, mais elle ferme d'abord la connexion.

kStatusCode_UnsecuredListenPreempted

Une autre application a remplacé de force le serveur de contrôle des appareils comme gestionnaire de connexion non sécurisée de la pile Weave.

kStatusCode_UnsupportedFailSafeMode

Le mode sécurisé spécifié n'est pas compatible avec l'appareil.

@173

 @173

Types de messages de contrôle des appareils.

Propriétés
kMsgType_ArmFailSafe

Activer le mécanisme de sécurité intégrée de la configuration sur l'appareil

kMsgType_DisableConnectionMonitor

Désactiver la surveillance de l'activité de la connexion.

kMsgType_DisarmFailSafe

Désactiver une configuration active de sécurité

kMsgType_EnableConnectionMonitor

Activer la surveillance de l'activité de la connexion.

kMsgType_LookingToRendezvous

Recherche du message Rendezvouz...

La charge utile est vide, le seul signal significatif qu'elle contient est l'ID du nœud source.

kMsgType_RemoteConnectionComplete

Indiquer au client Device Control que le rendez-vous passif distant a bien été effectué et que le tunnel de connexion est ouvert.

kMsgType_RemotePassiveRendezvous

Demander un rendez-vous passif à distance avec le serveur de contrôle des appareils.

kMsgType_ResetConfig

Réinitialisez l'état de configuration de l'appareil.

kMsgType_StartSystemTest

Lancez le test du système.

kMsgType_StopSystemTest

Arrêtez le test du système.

@174

 @174

Valeurs du mode ArmFailSafe.

Propriétés
kArmMode_New

activer un nouveau dispositif de sécurité ; renvoie une erreur si elle est déjà active.

kArmMode_Reset

Réinitialisez la configuration de l'appareil pour tous les appareils et activez un nouveau dispositif de sécurité.

kArmMode_ResumeExisting

réactiver une sécurité déjà en cours ; renvoie une erreur si aucun jeton de sécurité n'est en cours ou si le jeton de sécurité ne correspond pas.

@175

 @175

Options de réinitialisation de configuration.

Propriétés
kResetConfigFlag_All

Réinitialisez toutes les informations de configuration de l'appareil.

kResetConfigFlag_FabricConfig

Réinitialiser les informations de configuration de la structure

kResetConfigFlag_FactoryDefaults

Rétablissez la configuration d'usine de l'appareil.

kResetConfigFlag_NetworkConfig

Réinitialiser les informations de configuration du réseau

kResetConfigFlag_OperationalCredentials

Réinitialiser les identifiants opérationnels de l'appareil

kResetConfigFlag_ServiceConfig

Réinitialiser les informations de configuration du service

@176

 @176

Longueurs des messages.

Propriétés
kMessageLength_ArmFailsafe

Longueur du message avec sécurité en cas de défaillance de l'ARM.

kMessageLength_DisableConnectionMonitor

Désactiver la longueur du message de surveillance des connexions

kMessageLength_DisarmFailsafe

Longueur du message "Failsafe" pour la désactivation.

kMessageLength_EnableConnectionMonitor

Active la longueur du message de surveillance des connexions.

kMessageLength_RemotePassiveRendezvous

Longueur du message Rendezvous passif distant.

kMessageLength_ResetConfig

Réinitialiser la longueur du message Config.

kMessageLength_StartSystemTest

Longueur du message de démarrage du système test.

kMessageLength_StopSystemTest

Arrêt de la longueur du message de test du système.

Fonctions

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Envoyez un message LookToRendezVous au pair.

Détails
Paramètres
[in] ec
ExchangeContext à utiliser pour envoyer le message
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_NO_MEMORY
Si nous n'avons pas pu allouer de tampon pour le message.
other
Autres erreurs renvoyées par nl::Weave::ExchangeContext::SendMessage