nl::Weave::Profiles::DeviceControl

Ta przestrzeń nazw obejmuje wszystkie interfejsy weave dla profilu sterowania urządzeniem Weave.

Podsumowanie

Profil sterowania urządzeniem ułatwia wykonywanie działań klient-serwer, dzięki czemu klient (urządzenie sterujące) może aktywować określone funkcje narzędzi na serwerze (urządzenie jest poddawane konfiguracji), aby ułatwić konfigurowanie i uruchamianie procesu obsługi administracyjnej urządzenia. Obejmuje to na przykład zresetowanie konfiguracji urządzenia serwera i włączenie sejfów awarii, które definiują zachowanie 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ądzeniem.
@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 komunikatów dotyczących urządzeń.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
}
enum | typ wyliczeniowy
wartości trybu ArmFailSafe.
@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ść LookToRendezvous do współpracownika.

Zajęcia

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

Klasa przedstawiciela do wdrażania operacji przychodzących na urządzeniu po stronie serwera.

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

Klasa serwera do implementacji profilu sterowania urządzeniem.

Wyliczenia

@172

 @172

Kody stanu sterowania urządzeniem.

Właściwości
kStatusCode_FailSafeAlreadyActive

Obsługa administracyjna w stanie awaryjnym jest już aktywna.

kStatusCode_NoFailSafeActive

Nie jest aktywne żadne bezpieczne udostępnianie.

kStatusCode_NoMatchingFailSafeActive

Bezpieczny token obsługi administracyjnej nie był zgodny z aktywnym tokenem niebezpiecznym dla awarii.

kStatusCode_NoSystemTestDelegate

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

kStatusCode_RemotePassiveRendezvousTimedOut

W określonym przez klienta okresie nie było żadnych urządzeń, które były używane z serwerem sterowania urządzeniem.

kStatusCode_ResetNotAllowed

Urządzenie odrzuciło prośbę o zresetowanie.

kStatusCode_ResetSuccessCloseCon

Metoda ResetConfig zadziała, ale najpierw zakończy połączenie.

kStatusCode_UnsecuredListenPreempted

Inna aplikacja wymusiła zastąpienie serwera sterowania urządzeniem jako niezabezpieczonego modułu obsługi połączeń tego stosu Weave.

kStatusCode_UnsupportedFailSafeMode

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

@173

 @173

Typy komunikatów dotyczących urządzeń.

Właściwości
kMsgType_ArmFailSafe

Włącz mechanizm zabezpieczający konfiguracji na urządzeniu.

kMsgType_DisableConnectionMonitor

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

kMsgType_DisarmFailSafe

Wyłącz aktywną konfigurację, która jest niebezpieczna.

kMsgType_EnableConnectionMonitor

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

kMsgType_LookingToRendezvous

Szukam wiadomości Rendezvouz.

Ładunek jest pusty, a jedynym znaczącym sygnałem w nim jest identyfikator węzła źródłowego.

kMsgType_RemoteConnectionComplete

Poinformuj klienta Sterowanie urządzeniem, że Zdalny pasywny Rendezvous został ukończony, a tunel połączenia jest otwarty.

kMsgType_RemotePassiveRendezvous

Żądanie zdalnego pasywnego rendezvous z serwerem sterowania urządzeniem.

kMsgType_ResetConfig

Zresetuj stan konfiguracji urządzenia.

kMsgType_StartSystemTest

Rozpocznij test systemu.

kMsgType_StopSystemTest

Zatrzymaj test systemu.

@174

 @174

wartości trybu ArmFailSafe.

Właściwości
kArmMode_New

Uzbrój nową odporną na awarie; zwróć błąd, jeśli jeden jest już aktywny.

kArmMode_Reset

Zresetuj całą konfigurację urządzenia i włącz nowe, odporne na awarie.

kArmMode_ResumeExisting

Wznów trwający proces zabezpieczeń. Jeśli nie jest on w trakcie wykonywania, zwracany jest błąd lub inny token jest niezgodny.

@175

 @175

flagi ResetConfig;

Właściwości
kResetConfigFlag_All

Zresetuj wszystkie informacje dotyczące konfiguracji urządzenia.

kResetConfigFlag_FabricConfig

Zresetuj informacje o konfiguracji tkaniny.

kResetConfigFlag_FactoryDefaults

Przywróć pełne ustawienia fabryczne.

kResetConfigFlag_NetworkConfig

Zresetuj informacje o konfiguracji sieci.

kResetConfigFlag_OperationalCredentials

Zresetuj dane logowania operacyjnego urządzenia.

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

kMessageLength_DisableConnectionMonitor

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

kMessageLength_DisarmFailsafe

Długość komunikatu wyłączenia wyłączenia.

kMessageLength_EnableConnectionMonitor

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

kMessageLength_RemotePassiveRendezvous

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

kMessageLength_ResetConfig

Długość komunikatu konfiguracji dotyczącego resetowania.

kMessageLength_StartSystemTest

Rozpocznij długość komunikatu testowego systemu.

kMessageLength_StopSystemTest

Zatrzymaj długość komunikatu testowego systemu.

Funkcje

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Wyślij wiadomość LookToRendezvous do współpracownika.

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