nl::Weave::Profiles::DeviceControl

Dieser Namespace enthält alle Schnittstellen in Weave für das Weave Device Control-Profil.

Zusammenfassung

Das Gerätesteuerungsprofil ermöglicht Client-Server-Vorgänge, sodass der Client (das steuernde Gerät) auf dem Server (dem Gerät, das gerade eingerichtet wird) bestimmte Dienstfunktionen auslösen kann, um den Einrichtungs- und Bereitstellungsprozess des Geräts zu unterstützen und zu aktivieren. Dazu gehören beispielsweise das Zurücksetzen der Konfiguration des Servergeräts und die Aktivierung von Fail Safes, die das Verhalten beim vorzeitigen Abbruch des Einrichtungsvorgangs 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ängen.

Funktionen

SendLookingToRendezvous(ExchangeContext *ec)
Senden Sie eine LookToRendezvous-Nachricht an den Peer.

Kurse

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

Delegate-Klasse zur Implementierung eingehender Gerätesteuerungsvorgänge auf dem Servergerät.

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

Serverklasse zur Implementierung des Gerätesteuerungsprofils

Aufzählungen

@172

 @172

Statuscodes der Gerätesteuerung.

Attribute
kStatusCode_FailSafeAlreadyActive

Eine Ausfallsicherung für Nutzerverwaltung ist bereits aktiv.

kStatusCode_NoFailSafeActive

Es ist keine Ausfallsicherung bei der Bereitstellung aktiv.

kStatusCode_NoMatchingFailSafeActive

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

kStatusCode_NoSystemTestDelegate

Der Systemtest kann ohne einen Bevollmächtigten nicht ausgeführt werden.

kStatusCode_RemotePassiveRendezvousTimedOut

Während des vom Client angegebenen Übertragungszeitraums wurden keine Geräte an den Gerätesteuerungsserver übertragen.

kStatusCode_ResetNotAllowed

Das Gerät hat das angeforderte Zurücksetzen abgelehnt.

kStatusCode_ResetSuccessCloseCon

Die Methode ResetConfig ist erfolgreich, beendet jedoch zuerst die Verbindung.

kStatusCode_UnsecuredListenPreempted

Der Device Control-Server wurde durch eine andere Anwendung als ungesicherten Verbindungs-Handler dieses Weave-Stacks ersetzt.

kStatusCode_UnsupportedFailSafeMode

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

@173

 @173

Nachrichtentypen zur Gerätesteuerung.

Attribute
kMsgType_ArmFailSafe

Aktiviere den ausfallsicheren Mechanismus für die Konfiguration des Geräts.

kMsgType_DisableConnectionMonitor

Überwachung der Verbindungsaktivität deaktivieren.

kMsgType_DisarmFailSafe

Eine aktive Konfiguration ausfallsicher deaktivieren.

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 Quellknoten-ID.

kMsgType_RemoteConnectionComplete

Teilen Sie dem Gerätesteuerungsclient mit, dass Remote Passive Rendezvous erfolgreich abgeschlossen wurde und der Verbindungstunnel offen ist.

kMsgType_RemotePassiveRendezvous

Remote Passive Rendezvous mit dem Gerätesteuerungsserver anfordern.

kMsgType_ResetConfig

Konfigurationsstatus des Geräts zurücksetzen

kMsgType_StartSystemTest

Starten Sie den Systemtest.

kMsgType_StopSystemTest

Beenden Sie den Systemtest.

@174

 @174

ArmFailSafe-Modus-Werte.

Attribute
kArmMode_New

Schalte eine neue Sicherheitsmaßnahme ein und gib einen Fehler zurück, wenn bereits einer aktiv ist.

kArmMode_Reset

Alle Gerätekonfigurationen zurücksetzen und neue Ausfallsicherung aktivieren.

kArmMode_ResumeExisting

Setzen Sie eine bereits aktive Failover-Funktion fort. Geben Sie einen Fehler zurück, wenn keine Sicherheitsmaßnahme aktiv ist oder wenn kein Failover-Token nicht übereinstimmt.

@175

 @175

ResetConfig-Flags

Attribute
kResetConfigFlag_All

Setzt alle Informationen zur Gerätekonfiguration zurück.

kResetConfigFlag_FabricConfig

Informationen zur Fabric-Konfiguration zurücksetzen.

kResetConfigFlag_FactoryDefaults

Setze das Gerät auf die Werkseinstellungen zurück.

kResetConfigFlag_NetworkConfig

Informationen zur Netzwerkkonfiguration zurücksetzen.

kResetConfigFlag_OperationalCredentials

Anmeldedaten für den Gerätebetrieb zurücksetzen.

kResetConfigFlag_ServiceConfig

Informationen zur Dienstkonfiguration zurücksetzen.

@176

 @176

Nachrichtenlängen.

Attribute
kMessageLength_ArmFailsafe

Länge der Nachricht für die Aktivierung der Failsafe-Meldung.

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 Konfigurationsnachrichten zurücksetzen.

kMessageLength_StartSystemTest

Nachrichtenlänge des Systemtests starten.

kMessageLength_StopSystemTest

Länge der Systemtestnachrichten beenden.

Funktionen

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Senden Sie eine LookToRendezvous-Nachricht an den Peer.

Details
Parameter
[in] ec
ExchangeContext, der zum Senden der Nachricht verwendet werden soll.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_NO_MEMORY
Wenn für die Nachricht kein Puffer zugeordnet werden kann.
other
Andere von nl::Weave::ExchangeContext::SendMessage zurückgegebene Fehler