nl::Weave::Profiles::DeviceControl

Cet espace de noms inclut toutes les interfaces de Weave associées au profil de contrôle des appareils Weave.

Résumé

Le profil de contrôle d'appareil facilite les opérations client-serveur de sorte que le client (l'appareil de contrôle) puisse déclencher une fonctionnalité utilitaire spécifique sur le serveur (appareil en cours de configuration) pour faciliter et activer le processus de configuration et de provisionnement de l'appareil. Cela inclut, par exemple, la réinitialisation de la configuration de l'appareil serveur et l'activation de coffres-forts 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
}
enum
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
}
enum
Types de messages de contrôle de périphérique.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
}
enum
Valeurs en mode ArmFailSafe.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
}
enum
Indicateurs ResetConfig.
@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
}
enum
Longueur des messages.

distantes

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

Classes

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

Classe déléguée permettant d'implémenter des opérations de contrôle de périphériques entrantes sur l'appareil serveur.

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

Classe de serveur permettant d'implémenter le profil Device Control.

Énumérations

@172

 @172

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

Propriétés
kStatusCode_FailSafeAlreadyActive

Un provisionnement sécurisé est déjà actif.

kStatusCode_NoFailSafeActive

Aucun provisionnement sécurisé n'est actif.

kStatusCode_NoMatchingFailSafeActive

Le jeton de sécurité du provisionnement ne correspondait pas au dispositif de sécurité actif.

kStatusCode_NoSystemTestDelegate

Le test du système ne peut pas être exécuté sans délégué.

kStatusCode_RemotePassiveRendezvousTimedOut

Aucun appareil n'a été contacté avec le serveur Device Control 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 aboutira, mais elle fermera d'abord la connexion.

kStatusCode_UnsecuredListenPreempted

Une autre application a forcé le remplacement du serveur de contrôle de périphérique, le gestionnaire de connexion non sécurisée de cette pile Weave.

kStatusCode_UnsupportedFailSafeMode

Le mode de sécurité infaillible spécifié n'est pas compatible avec l'appareil.

@173

 @173

Types de messages de contrôle de périphérique.

Propriétés
kMsgType_ArmFailSafe

Activez le mécanisme de sécurité infaillible de la configuration sur l'appareil.

kMsgType_DisableConnectionMonitor

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

kMsgType_DisarmFailSafe

Désactivez une configuration active en cas de problème.

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 pertinent qu'il contient est l'ID du nœud source.

kMsgType_RemoteConnectionComplete

Indiquer au client Device Control que les rendez-vous passifs distants ont bien été effectués et que le tunnel de connexion est ouvert.

kMsgType_RemotePassiveRendezvous

Demandez des rendez-vous passifs distants 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 en mode ArmFailSafe.

Propriétés
kArmMode_New

Activation d'une nouvelle sécurité intégrée ; renvoyer une erreur s'il est déjà actif.

kArmMode_Reset

Réinitialisez la configuration de tous les appareils et activez un nouvel appareil sécurisé.

kArmMode_ResumeExisting

Réactivation d'une sécurité intégrée déjà en cours ; renvoyer une erreur si aucune sécurité intégrée n'est en cours ou si le jeton de sécurité ne correspond pas.

@175

 @175

Indicateurs ResetConfig.

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

kResetConfigFlag_FactoryDefaults

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

kResetConfigFlag_NetworkConfig

Réinitialisez les informations de configuration du réseau.

kResetConfigFlag_OperationalCredentials

Réinitialisez les identifiants de fonctionnement de l'appareil.

kResetConfigFlag_ServiceConfig

Réinitialiser les informations de configuration du service.

@176

 @176

Longueur des messages.

Propriétés
kMessageLength_ArmFailsafe

Longueur du message de type Failsafe

kMessageLength_DisableConnectionMonitor

Désactivez la longueur du message de surveillance de connexion.

kMessageLength_DisarmFailsafe

Désactivez la longueur du message de sécurité défaillante.

kMessageLength_EnableConnectionMonitor

Activation de la longueur du message de surveillance des connexions.

kMessageLength_RemotePassiveRendezvous

Longueur du message des rendez-vous passives distants.

kMessageLength_ResetConfig

Longueur du message de réinitialisation de la configuration.

kMessageLength_StartSystemTest

Longueur du message de test du système.

kMessageLength_StopSystemTest

Longueur du message d'arrêt du test du système.

distantes

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Envoyez un message FollowToRendezvous au pair.

Détails
Paramètres
[in] ec
ExchangeContext à utiliser pour envoyer le message
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
WEAVE_ERROR_NO_MEMORY
Si nous ne pouvions pas allouer un tampon pour le message.
other
Autres erreurs renvoyées par nl::Weave::ExchangeContext::SendMessage