nl::Weave::Profiles::DeviceControl

Không gian tên này bao gồm tất cả giao diện trong Weave dành cho cấu hình Weave Device Control.

Tóm tắt

Hồ sơ điều khiển thiết bị hỗ trợ các hoạt động của máy khách-máy chủ sao cho máy khách (thiết bị đang kiểm soát) có thể kích hoạt chức năng tiện ích cụ thể trên máy chủ (thiết bị đang được thiết lập) để hỗ trợ và bật quá trình thiết lập và cấp phép thiết bị. Ví dụ: việc đặt lại cấu hình của thiết bị máy chủ và bật tính năng bảo vệ không an toàn sẽ xác định hành vi khi quy trình thiết lập bị huỷ sớm.

Liệt kê
@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
Mã trạng thái điều khiển thiết bị.
@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
Các loại thông báo điều khiển thiết bị.
@174{
  kArmMode_New = 1,
  kArmMode_Reset = 2,
  kArmMode_ResumeExisting = 3
} 		enum
Các giá trị của chế độ ArmFailSafe.
@175{
  kResetConfigFlag_All = 0x00FF,
  kResetConfigFlag_NetworkConfig = 0x0001,
  kResetConfigFlag_FabricConfig = 0x0002,
  kResetConfigFlag_ServiceConfig = 0x0004,
  kResetConfigFlag_OperationalCredentials = 0x0008,
  kResetConfigFlag_FactoryDefaults = 0x8000
} 		enum
Cờ Đặt lại cấu hình.
@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
Độ dài tin nhắn.

Hàm
SendLookingToRendezvous(ExchangeContext *ec)
Gửi tin nhắn LookToRendezvous cho đồng nghiệp.

Lớp
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Lớp uỷ quyền triển khai các thao tác Điều khiển thiết bị đến trên thiết bị máy chủ.

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

Lớp máy chủ để triển khai hồ sơ Kiểm soát thiết bị.

Liệt kê

@172

 @172

Mã trạng thái điều khiển thiết bị.

Thuộc tính
kStatusCode_FailSafeAlreadyActive

Tính năng cấp phép không an toàn đang hoạt động.

kStatusCode_NoFailSafeActive

Không có tính năng cấp phép nào không an toàn đang hoạt động.

kStatusCode_NoMatchingFailSafeActive

Mã thông báo đảm bảo an toàn khi cấp phép không khớp với trạng thái không an toàn đang hoạt động.

kStatusCode_NoSystemTestDelegate

Bài kiểm thử hệ thống không thể chạy nếu không có thành phần được uỷ quyền.

kStatusCode_RemotePassiveRendezvousTimedOut

Không có thiết bị nào kết nối với máy chủ Điều khiển thiết bị trong khoảng thời gian hẹn do ứng dụng chỉ định.

kStatusCode_ResetNotAllowed

Thiết bị đã từ chối cho phép yêu cầu đặt lại.

kStatusCode_ResetSuccessCloseCon

Phương thức ResetConfig sẽ thành công, nhưng sẽ đóng kết nối trước.

kStatusCode_UnsecuredListenPreempted

Một ứng dụng khác đã buộc thay thế máy chủ Điều khiển thiết bị làm trình xử lý kết nối không an toàn của ngăn xếp Weave này.

kStatusCode_UnsupportedFailSafeMode

Thiết bị không hỗ trợ chế độ đảm bảo an toàn đã chỉ định.

@173

 @173

Các loại thông báo điều khiển thiết bị.

Thuộc tính
kMsgType_ArmFailSafe

Bật cơ chế an toàn cho cấu hình trên thiết bị.

kMsgType_DisableConnectionMonitor

Tắt tính năng giám sát trực tiếp kết nối.

kMsgType_DisarmFailSafe

Tắt chuông báo động của một cấu hình đang hoạt động không an toàn.

kMsgType_EnableConnectionMonitor

Bật tính năng giám sát trực tiếp kết nối.

kMsgType_LookingToRendezvous

Đang tìm tin nhắn Rendezvouz.

Tải trọng trống, tín hiệu có ý nghĩa duy nhất bên trong là mã nhận dạng nút nguồn.

kMsgType_RemoteConnectionComplete

Cho ứng dụng Kiểm soát thiết bị biết rằng Giao thức thụ động từ xa đã hoàn tất thành công và đường hầm kết nối đang mở.

kMsgType_RemotePassiveRendezvous

Yêu cầu Kết nối thụ động từ xa với máy chủ Điều khiển thiết bị.

kMsgType_ResetConfig

Đặt lại trạng thái cấu hình của thiết bị.

kMsgType_StartSystemTest

Bắt đầu kiểm tra hệ thống.

kMsgType_StopSystemTest

Dừng kiểm tra hệ thống.

@174

 @174

Các giá trị của chế độ ArmFailSafe.

Thuộc tính
kArmMode_New

Bật một chế độ không an toàn mới; sẽ trả về lỗi nếu một mã đã hoạt động.

kArmMode_Reset

Đặt lại tất cả cấu hình thiết bị của thiết bị và bật tính năng an toàn mới cho thiết bị này.

kArmMode_ResumeExisting

Tiếp tục quá trình đảm bảo an toàn đang diễn ra; trả về lỗi nếu không có quá trình đảm bảo an toàn nào đang diễn ra hoặc nếu mã thông báo không an toàn không khớp.

@175

 @175

Cờ Đặt lại cấu hình.

Thuộc tính
kResetConfigFlag_All

Đặt lại tất cả thông tin cấu hình thiết bị.

kResetConfigFlag_FabricConfig

Đặt lại thông tin cấu hình vải.

kResetConfigFlag_FactoryDefaults

Đặt lại thiết bị về trạng thái mặc định ban đầu.

kResetConfigFlag_NetworkConfig

Đặt lại thông tin cấu hình mạng.

kResetConfigFlag_OperationalCredentials

Đặt lại thông tin xác thực hoạt động của thiết bị.

kResetConfigFlag_ServiceConfig

Đặt lại thông tin cấu hình dịch vụ.

@176

 @176

Độ dài tin nhắn.

Thuộc tính
kMessageLength_ArmFailsafe

Tắt độ dài tin nhắn Không an toàn.

kMessageLength_DisableConnectionMonitor

Tắt độ dài tin nhắn của công cụ Giám sát kết nối.

kMessageLength_DisarmFailsafe

Độ dài của tin nhắn không an toàn khi tắt chuông báo động.

kMessageLength_EnableConnectionMonitor

Bật độ dài tin nhắn của công cụ Giám sát kết nối.

kMessageLength_RemotePassiveRendezvous

Độ dài tin nhắn hẹn hò thụ động từ xa.

kMessageLength_ResetConfig

Đặt lại độ dài của thông báo Cấu hình.

kMessageLength_StartSystemTest

Bắt đầu độ dài tin nhắn Kiểm tra hệ thống.

kMessageLength_StopSystemTest

Dừng độ dài tin nhắn Kiểm tra hệ thống.

Hàm

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

Gửi tin nhắn LookToRendezvous cho đồng nghiệp.

Chi tiết
Tham số
[in] ec
ExchangeContext sử dụng để gửi tin nhắn
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_NO_MEMORY
Nếu chúng tôi không thể phân bổ vùng đệm cho thông báo.
other
Các lỗi khác được nl::Weave::ExchangeContext::SendMessage trả về