nl::Weave::Profiles::DeviceControl

Dieser Namespace umfasst alle Schnittstellen in Weave für das Weave Device Control-Profil.

Zusammenfassung

Das Gerätekontrollprofil ermöglicht Client-Server-Vorgänge, sodass der Client (das steuernde Gerät) bestimmte Dienstprogrammfunktionen auf dem Server (dem Gerät, das eingerichtet wird) auslösen kann, um die Geräteeinrichtung und -bereitstellung zu unterstützen und zu ermöglichen. Dazu gehört beispielsweise das Zurücksetzen der Konfiguration des Servergeräts und das Aktivieren von Fail Safes, die das Verhalten bei vorzeitigem Abbruch der Einrichtung definieren.

Aufzählungen
@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
Statuscodes der Gerätesteuerung
@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
Nachrichtentypen zur Gerätesteuerung.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
} 		enum
ArmFailSafe-Modus-Werte.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
} 		enum
ResetConfig-Flags.
@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
Nachrichtenlänge.

Funktionen
SendLookingToRendezvous(ExchangeContext *ec)
Eine „LookToRendezvous“-Nachricht an den Peer senden.

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

Delegieren Sie die Klasse für die Implementierung eingehender Gerätesteuerungsvorgänge auf dem Servergerät.

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

Serverklasse zum Implementieren des Device Control-Profils

Aufzählungen

@172

 @172

Statuscodes der Gerätesteuerung

Attribute
kStatusCode_FailSafeAlreadyActive

Eine ausfallsichere Bereitstellung ist bereits aktiv.

kStatusCode_NoFailSafeActive

Keine ausfallsichere Bereitstellung ist aktiv.

kStatusCode_NoMatchingFailSafeActive

Das Failover-Token für die Bereitstellung stimmte nicht mit dem aktiven Failover überein.

kStatusCode_NoSystemTestDelegate

Der Systemtest kann nicht ohne Zugriffsrechte ausgeführt werden.

kStatusCode_RemotePassiveRendezvousTimedOut

Während des vom Client festgelegten Rendezvous-Zeitraums wurden keine Geräte mit dem Gerätekontrollserver abgeglichen.

kStatusCode_ResetNotAllowed

Das Gerät hat die angeforderte Zurücksetzung abgelehnt.

kStatusCode_ResetSuccessCloseCon

Die ResetConfig-Methode ist erfolgreich, beendet aber zuerst die Verbindung.

kStatusCode_UnsecuredListenPreempted

Der Gerätekontrollserver wurde von einer anderen Anwendung als ungesicherten Verbindungs-Handler dieses Weave-Stacks ersetzt.

kStatusCode_UnsupportedFailSafeMode

Der angegebene Ausfallsicherheitsmodus wird vom Gerät nicht unterstützt.

@173

 @173

Nachrichtentypen zur Gerätesteuerung.

Attribute
kMsgType_ArmFailSafe

Aktivieren Sie den Failover-Mechanismus für die Konfiguration auf dem Gerät.

kMsgType_DisableConnectionMonitor

Deaktivieren Sie das Monitoring der Verbindungsaktivität.

kMsgType_DisarmFailSafe

Deaktivieren Sie eine aktive Konfiguration fehlersicher.

kMsgType_EnableConnectionMonitor

Monitoring der Verbindungsaktivität aktivieren.

kMsgType_LookingToRendezvous

Rendezvouz-Nachricht wird gesucht.

Die Nutzlast ist leer. Das einzige aussagekräftige Signal darin ist die ID des Quellknotens.

kMsgType_RemoteConnectionComplete

Teilen Sie dem Client für die Gerätesteuerung mit, dass Remote Passive Rendezvous erfolgreich abgeschlossen wurde und der Verbindungstunnel geöffnet ist.

kMsgType_RemotePassiveRendezvous

Remote-Passive Rendezvous mit dem Gerätekontrollserver anfordern.

kMsgType_ResetConfig

Setzen Sie den Konfigurationsstatus des Geräts zurück.

kMsgType_StartSystemTest

Starten Sie den Systemtest.

kMsgType_StopSystemTest

Beenden Sie den Systemtest.

@174

 @174

ArmFailSafe-Modus-Werte.

Attribute
kArmMode_New

Aktivieren Sie einen neuen Ausfallsicher. gibt einen Fehler zurück, wenn einer bereits aktiv ist.

kArmMode_Reset

Die gesamte Gerätekonfiguration wird zurückgesetzt und eine neue Ausfallsicherung scharf geschaltet.

kArmMode_ResumeExisting

Fortsetzen einer bereits aktiven Sicherung gibt einen Fehler zurück, wenn kein Failover in Bearbeitung ist oder wenn das Failover-Token nicht übereinstimmt.

@175

 @175

ResetConfig-Flags.

Attribute
kResetConfigFlag_All

Alle Informationen zur Gerätekonfiguration zurücksetzen.

kResetConfigFlag_FabricConfig

Informationen zur Strukturkonfiguration zurücksetzen.

kResetConfigFlag_FactoryDefaults

Setzen Sie das Gerät auf die Werkseinstellungen zurück.

kResetConfigFlag_NetworkConfig

Informationen zur Netzwerkkonfiguration zurücksetzen.

kResetConfigFlag_OperationalCredentials

Anmeldeinformationen für den Betrieb des Geräts zurücksetzen.

kResetConfigFlag_ServiceConfig

Dienstkonfigurationsinformationen zurücksetzen.

@176

 @176

Nachrichtenlänge.

Attribute
kMessageLength_ArmFailsafe

Länge der Failsafe-Nachricht scharf schalten.

kMessageLength_DisableConnectionMonitor

Nachrichtenlänge der Verbindungsüberwachung deaktivieren.

kMessageLength_DisarmFailsafe

Länge der Failsafe-Nachricht unscharf schalten.

kMessageLength_EnableConnectionMonitor

Nachrichtenlänge der Verbindungsüberwachung aktivieren.

kMessageLength_RemotePassiveRendezvous

Länge der passiven Remote-Rendezvous-Nachrichten.

kMessageLength_ResetConfig

Länge der Config-Nachrichten zurücksetzen.

kMessageLength_StartSystemTest

Nachrichtenlänge für Start des Systemtests.

kMessageLength_StopSystemTest

Länge der Nachrichten für den Systemtest stoppen.

Funktionen

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Eine „LookToRendezvous“-Nachricht an den Peer senden.

Details
Parameter
[in] ec
ExchangeContext zum Senden der Nachricht.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_NO_MEMORY
Wenn wir der Nachricht keinen Zwischenspeicher zuordnen konnten.
other
Andere von nl::Weave::ExchangeContext::SendMessage zurückgegebene Fehler