nl::Weave::Profiles::DeviceControl

Ta przestrzeń nazw obejmuje wszystkie interfejsy Weave dla profilu Weave Device Control.

Podsumowanie

Profil sterowania urządzeniem ułatwia wykonywanie operacji klient-serwer, dzięki czemu klient (urządzenie sterujące) może aktywować określone funkcje narzędziowe na serwerze (urządzeniu w trakcie konfiguracji) w celu ułatwienia konfiguracji i obsługi administracyjnej urządzenia. Obejmuje to na przykład resetowanie konfiguracji serwera oraz włączanie sejfów awarii, które definiują działanie w przypadku przedwczesnego przerwania procedury konfiguracji.

Wyliczenia
@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 | typ wyliczeniowy
Kody stanu sterowania urządzeniami.
@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 | typ wyliczeniowy
Typy wiadomości dotyczące sterowania urządzeniami.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
} 		enum | typ wyliczeniowy
Wartości trybu ArmFailSafe Mode.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
} 		enum | typ wyliczeniowy
Flagi 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 | typ wyliczeniowy
Długość wiadomości.

Funkcje
SendLookingToRendezvous(ExchangeContext *ec)
Wyślij wiadomość LookerToRendezvous do elementu równorzędnego.

Zajęcia
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Przekaż klasę do implementacji przychodzących operacji kontroli urządzenia na serwerze.

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

Klasa serwera do implementacji profilu kontroli urządzenia.

Wyliczenia

@172

 @172

Kody stanu sterowania urządzeniami.

Właściwości
kStatusCode_FailSafeAlreadyActive

Niezawodna obsługa administracyjna jest już aktywna.

kStatusCode_NoFailSafeActive

Brak aktywnej obsługi administracyjnej z bezpieczeństwem.

kStatusCode_NoMatchingFailSafeActive

Niezawodny token obsługi administracyjnej nie odpowiadał aktywnym tokenowi zabezpieczeń.

kStatusCode_NoSystemTestDelegate

Test systemu nie może działać bez przedstawiciela.

kStatusCode_RemotePassiveRendezvousTimedOut

Żadne urządzenia nie zostały ponownie uruchomione przy użyciu serwera sterowania urządzeniami w okresie określonym przez klienta.

kStatusCode_ResetNotAllowed

Urządzenie nie wyraziło zgody na prośbę o zresetowanie.

kStatusCode_ResetSuccessCloseCon

Metoda ResetConfig zostanie wykonana, ale najpierw zamknie połączenie.

kStatusCode_UnsecuredListenPreempted

Inna aplikacja zastąpiła serwer sterowania urządzeniem jako moduł obsługi niezabezpieczonego połączenia tego stosu Weave.

kStatusCode_UnsupportedFailSafeMode

Podany tryb awaryjny nie jest obsługiwany przez urządzenie.

@173

 @173

Typy wiadomości dotyczące sterowania urządzeniami.

Właściwości
kMsgType_ArmFailSafe

Włącz na urządzeniu mechanizm odporności na awarie.

kMsgType_DisableConnectionMonitor

Wyłącz monitorowanie żywotności połączenia.

kMsgType_DisarmFailSafe

Wyłączenie aktywnej konfiguracji jest odporna na awarie.

kMsgType_EnableConnectionMonitor

Włącz monitorowanie żywotności połączenia.

kMsgType_LookingToRendezvous

Szukam wiadomości Rendezvouz.

Ładunek jest pusty. Jedynym istotnym sygnałem w obrębie jest identyfikator węzła źródłowego.

kMsgType_RemoteConnectionComplete

Wskaż klientowi sterowania urządzeniem, że Remote Passive Rendezvous zakończyło się powodzeniem i tunel połączenia jest otwarty.

kMsgType_RemotePassiveRendezvous

Żądanie zdalnego, pasywnego Rendezvous przy użyciu serwera sterowania urządzeniem.

kMsgType_ResetConfig

Resetowanie stanu konfiguracji urządzenia.

kMsgType_StartSystemTest

Rozpocznij test systemu.

kMsgType_StopSystemTest

Zatrzymaj test systemu.

@174

 @174

Wartości trybu ArmFailSafe Mode.

Właściwości
kArmMode_New

uzbrojenie nowego systemu odpornego na awarie; zwraca błąd, jeśli jest już aktywny.

kArmMode_Reset

Zresetuj całą konfigurację urządzenia i włącz nowy, bezpieczny.

kArmMode_ResumeExisting

wznawianie działania zabezpieczeń przed awariami; zwraca błąd, jeśli w toku nie ma żadnego stanu zabezpieczeń lub jeśli token nie jest zgodny.

@175

 @175

Flagi ResetConfig.

Właściwości
kResetConfigFlag_All

Zresetuj wszystkie informacje o konfiguracji urządzenia.

kResetConfigFlag_FabricConfig

Zresetuj informacje o konfiguracji tkaniny.

kResetConfigFlag_FactoryDefaults

Przywróć pełne ustawienia fabryczne urządzenia.

kResetConfigFlag_NetworkConfig

Zresetuj informacje o konfiguracji sieci.

kResetConfigFlag_OperationalCredentials

Zresetuj dane logowania do operacji na urządzeniu.

kResetConfigFlag_ServiceConfig

Zresetuj informacje o konfiguracji usługi.

@176

 @176

Długość wiadomości.

Właściwości
kMessageLength_ArmFailsafe

Długość komunikatu informującego o błędzie.

kMessageLength_DisableConnectionMonitor

Wyłącz długość komunikatu Monitora połączeń.

kMessageLength_DisarmFailsafe

Długość komunikatu informującego o wyłączeniu alarmu.

kMessageLength_EnableConnectionMonitor

Włącz długość komunikatu Monitorowania połączeń.

kMessageLength_RemotePassiveRendezvous

Długość zdalnej pasywnej wiadomości Rendezvous.

kMessageLength_ResetConfig

Resetuj długość komunikatu konfiguracji.

kMessageLength_StartSystemTest

Rozpocznij test systemu – długość wiadomości.

kMessageLength_StopSystemTest

Zatrzymaj długość komunikatu testowego systemu.

Funkcje

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Wyślij wiadomość LookerToRendezvous do elementu równorzędnego.

Szczegóły
Parametry
[in] ec
ExchangeContext, które ma być używane do wysyłania wiadomości,
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
WEAVE_ERROR_NO_MEMORY
Gdy nie można było przydzielić bufora dla wiadomości.
other
Inne błędy zwrócone przez nl::Weave::ExchangeContext::SendMessage