nl::Weave::Profiles::DeviceControl

Namespace ini mencakup semua antarmuka dalam Weave untuk profil Weave Device Control.

Ringkasan

Profil Kontrol Perangkat memfasilitasi operasi klien-server sehingga klien (perangkat yang mengontrol) dapat memicu fungsi utilitas khusus di server (perangkat yang menjalani penyiapan) untuk membantu dan mengaktifkan proses pengaturan dan penyediaan perangkat. Hal ini mencakup, misalnya, mereset konfigurasi perangkat server dan mengaktifkan brankas yang menentukan perilaku saat prosedur penyiapan dibatalkan sebelum waktunya.

Enumerasi
@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
Kode Status Kontrol Perangkat.
@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
Jenis Pesan Kontrol Perangkat.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
} 		enum
Nilai ArmFailSafe Mode.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
} 		enum
Tanda 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
Panjang Pesan.

Fungsi
SendLookingToRendezvous(ExchangeContext *ec)
Kirim pesan LookingToRendezvous ke peer.

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

Delegasikan class untuk menerapkan operasi Kontrol Perangkat yang masuk pada perangkat server.

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

Class server untuk menerapkan profil Kontrol Perangkat.

Enumerasi

@172

 @172

Kode Status Kontrol Perangkat.

Properti
kStatusCode_FailSafeAlreadyActive

Pengamanan gagal penyediaan sudah aktif.

kStatusCode_NoFailSafeActive

Tidak ada penyediaan keamanan gagal yang aktif.

kStatusCode_NoMatchingFailSafeActive

Token keamanan gagal penyediaan tidak cocok dengan pengamanan gagal yang aktif.

kStatusCode_NoSystemTestDelegate

Pengujian sistem tidak dapat berjalan tanpa delegasi.

kStatusCode_RemotePassiveRendezvousTimedOut

Tidak ada perangkat yang bertemu dengan server Kontrol Perangkat selama periode pertemuan yang ditentukan klien.

kStatusCode_ResetNotAllowed

Perangkat menolak untuk mengizinkan reset yang diminta.

kStatusCode_ResetSuccessCloseCon

Metode ResetConfig akan berhasil, tetapi akan menutup koneksi terlebih dahulu.

kStatusCode_UnsecuredListenPreempted

Aplikasi lain telah secara paksa menggantikan server Kontrol Perangkat sebagai pengendali koneksi tidak aman stack Weave ini.

kStatusCode_UnsupportedFailSafeMode

Mode gagal-aman yang ditentukan tidak didukung oleh perangkat.

@173

 @173

Jenis Pesan Kontrol Perangkat.

Properti
kMsgType_ArmFailSafe

Mengaktifkan mekanisme keamanan gagal konfigurasi pada perangkat.

kMsgType_DisableConnectionMonitor

Nonaktifkan pemantauan keaktifan koneksi.

kMsgType_DisarmFailSafe

Menonaktifkan keamanan dari kegagalan konfigurasi aktif.

kMsgType_EnableConnectionMonitor

Aktifkan pemantauan keaktifan koneksi.

kMsgType_LookingToRendezvous

Mencari pesan Rendezvouz.

Payload kosong, satu-satunya sinyal yang berarti di dalamnya adalah ID node sumber.

kMsgType_RemoteConnectionComplete

Beri tahu klien Kontrol Perangkat bahwa Rendezvous Pasif Jarak Jauh telah berhasil diselesaikan dan tunnel koneksi terbuka.

kMsgType_RemotePassiveRendezvous

Meminta Rendezvous Pasif Jarak Jauh dengan server Kontrol Perangkat.

kMsgType_ResetConfig

Mereset status konfigurasi perangkat.

kMsgType_StartSystemTest

Mulai pengujian sistem.

kMsgType_StopSystemTest

Hentikan pengujian sistem.

@174

 @174

Nilai ArmFailSafe Mode.

Properti
kArmMode_New

Mengaktifkan alat pengaman baru; menampilkan error jika sudah aktif.

kArmMode_Reset

Reset semua konfigurasi perangkat dan aktifkan pengamanan gagal yang baru.

kArmMode_ResumeExisting

Melanjutkan tindakan aman dari kegagalan yang sudah berlangsung; menampilkan error jika tidak ada alat pengaman yang sedang berlangsung, atau jika token pengaman tidak cocok.

@175

 @175

Tanda ResetConfig.

Properti
kResetConfigFlag_All

Reset semua informasi konfigurasi perangkat.

kResetConfigFlag_FabricConfig

Reset informasi konfigurasi fabric.

kResetConfigFlag_FactoryDefaults

Reset perangkat ke setelan default pabrik penuh.

kResetConfigFlag_NetworkConfig

Reset informasi konfigurasi jaringan.

kResetConfigFlag_OperationalCredentials

Reset kredensial operasional perangkat.

kResetConfigFlag_ServiceConfig

Reset informasi konfigurasi layanan.

@176

 @176

Panjang Pesan.

Properti
kMessageLength_ArmFailsafe

Aktifkan panjang pesan Failsafe.

kMessageLength_DisableConnectionMonitor

Nonaktifkan panjang pesan Connection Monitor.

kMessageLength_DisarmFailsafe

Nonaktifkan panjang pesan Failsafe.

kMessageLength_EnableConnectionMonitor

Aktifkan panjang pesan Connection Monitor.

kMessageLength_RemotePassiveRendezvous

Panjang pesan Rendezvous Pasif Jarak Jauh.

kMessageLength_ResetConfig

Reset panjang pesan Konfigurasi.

kMessageLength_StartSystemTest

Mulai panjang pesan Uji Sistem.

kMessageLength_StopSystemTest

Panjang pesan Hentikan Pengujian Sistem.

Fungsi

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Kirim pesan LookingToRendezvous ke peer.

Detail
Parameter
[in] ec
ExchangeContext yang akan digunakan untuk mengirim pesan
Nilai Pengembalian
WEAVE_NO_ERROR
Setelah berhasil.
WEAVE_ERROR_NO_MEMORY
Jika kita tidak dapat mengalokasikan buffer untuk pesan.
other
Error lain yang ditampilkan oleh nl::Weave::ExchangeContext::SendMessage