nl::Weave::Profiles::DeviceControl

此命名空间包含 Weave 中用于 Weave 设备控制配置文件的所有接口。

摘要

设备控制配置文件可协助客户端-服务器操作，以便客户端（控制设备）可以在服务器上（正在设置的设备）触发特定实用功能，以协助和启用设备设置和配置过程。例如，这包括重置服务器设备的配置，以及启用故障保险（定义过早取消设置流程时的行为）。

枚举
`@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 }`	枚举设备控制状态代码。
`@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 }`	枚举设备控制消息类型。
`@174{ kArmMode_New = 1, kArmMode_Reset = 2, kArmMode_ResumeExisting = 3 }`	枚举 ArmFailSafe 模式值。
`@175{ kResetConfigFlag_All = 0x00FF, kResetConfigFlag_NetworkConfig = 0x0001, kResetConfigFlag_FabricConfig = 0x0002, kResetConfigFlag_ServiceConfig = 0x0004, kResetConfigFlag_OperationalCredentials = 0x0008, kResetConfigFlag_FactoryDefaults = 0x8000 }`	枚举 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 }`	枚举消息长度。

函数
`SendLookingToRendezvous(ExchangeContext *ec)`	`WEAVE_ERROR` 向对等端发送 LookToRendezvous 消息。

类
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate	用于在服务器设备上实现传入的设备控制操作的委托类。
nl::Weave::Profiles::DeviceControl::DeviceControlServer	用于实现设备控制配置文件的服务器类。

 @172

设备控制状态代码。

属性
`kStatusCode_FailSafeAlreadyActive`	配置故障安全模式已启用。
`kStatusCode_NoFailSafeActive`	没有任何配置处于故障安全模式。
`kStatusCode_NoMatchingFailSafeActive`	预配的故障安全令牌与有效的故障安全令牌不匹配。
`kStatusCode_NoSystemTestDelegate`	如果没有委托，系统测试无法运行。
`kStatusCode_RemotePassiveRendezvousTimedOut`	在客户端指定的集合期间，没有设备与设备控制服务器进行集合。
`kStatusCode_ResetNotAllowed`	设备拒绝了所请求的重置操作。
`kStatusCode_ResetSuccessCloseCon`	ResetConfig 方法将会成功，但会先关闭连接。
`kStatusCode_UnsecuredListenPreempted`	此 Weave 堆栈的不安全连接处理程序已被另一个应用强制替换了设备控制服务器。
`kStatusCode_UnsupportedFailSafeMode`	设备不支持指定的故障安全模式。

 @173

设备控制消息类型。

属性
`kMsgType_ArmFailSafe`	在设备上开启配置故障安全机制。
`kMsgType_DisableConnectionMonitor`	停用连接活跃性监控。
`kMsgType_DisarmFailSafe`	通过故障安全模式关闭活跃配置。
`kMsgType_EnableConnectionMonitor`	启用连接活跃性监控。
`kMsgType_LookingToRendezvous`	正在寻找 Rendezvouz 邮件。载荷为空，其中唯一有意义的信号是来源节点 ID。
`kMsgType_RemoteConnectionComplete`	向设备控制客户端指示远程被动 Rendezvous 已成功完成且连接隧道已打开。
`kMsgType_RemotePassiveRendezvous`	请求使用设备控制服务器远程被动 Rendezvous。
`kMsgType_ResetConfig`	重置设备的配置状态。
`kMsgType_StartSystemTest`	启动系统测试。
`kMsgType_StopSystemTest`	停止系统测试。

 @174

ArmFailSafe 模式值。

属性
`kArmMode_New`	配置新的防故障设备；则会返回错误。
`kArmMode_Reset`	重置所有设备配置并开启新的故障安全模式。
`kArmMode_ResumeExisting`	恢复已在进行中的故障安全模式；如果正在进行任何防故障操作，或故障安全令牌不匹配，则返回错误。

 @175

ResetConfig 标志。

属性
`kResetConfigFlag_All`	重置所有设备配置信息。
`kResetConfigFlag_FabricConfig`	重置结构脉络配置信息。
`kResetConfigFlag_FactoryDefaults`	将设备重置为完整的出厂默认设置。
`kResetConfigFlag_NetworkConfig`	重置网络配置信息。
`kResetConfigFlag_OperationalCredentials`	重置设备操作凭据。
`kResetConfigFlag_ServiceConfig`	重置服务配置信息。

 @176

消息长度。

属性
`kMessageLength_ArmFailsafe`	Arm 故障安全消息长度。
`kMessageLength_DisableConnectionMonitor`	禁用连接监视器消息长度。
`kMessageLength_DisarmFailsafe`	解除故障安全消息报警器的时长。
`kMessageLength_EnableConnectionMonitor`	启用连接监控器消息长度。
`kMessageLength_RemotePassiveRendezvous`	远程被动 Rendezvous 消息长度。
`kMessageLength_ResetConfig`	重置配置消息长度。
`kMessageLength_StartSystemTest`	开始系统测试消息长度。
`kMessageLength_StopSystemTest`	停止系统测试消息长度。

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

向对等端发送 LookToRendezvous 消息。

详细信息

参数

[in] ec

用于发送邮件的 ExchangeContext

返回值

`WEAVE_NO_ERROR`	成功时。
`WEAVE_ERROR_NO_MEMORY`	如果无法为消息分配缓冲区。
`other`	nl::Weave::ExchangeContext::SendMessage 返回的其他错误