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 }`	列挙型メッセージの長さ。

Functions
`SendLookingToRendezvous(ExchangeContext *ec)`	`WEAVE_ERROR` ピアに LookingToRendezvous メッセージを送信します。

クラス
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate	受信デバイス制御オペレーションをサーバーデバイスに実装するためのデリゲートクラス。
nl::Weave::Profiles::DeviceControl::DeviceControlServer	デバイスコントロールプロファイルを実装するためのサーバークラス。

列挙型

172

 @172

デバイスコントロールのステータスコード。

Properties
`kStatusCode_FailSafeAlreadyActive`	プロビジョニングのフェイルセーフはすでに有効です。
`kStatusCode_NoFailSafeActive`	有効なプロビジョニングのフェイルセーフがありません。
`kStatusCode_NoMatchingFailSafeActive`	プロビジョニングのフェイルセーフトークンが、アクティブなフェイルセーフと一致しませんでした。
`kStatusCode_NoSystemTestDelegate`	システムテストは、デリゲートなしでは実行できません。
`kStatusCode_RemotePassiveRendezvousTimedOut`	クライアントが指定したランデブー期間中には、デバイスコントロールサーバーでランデスボネートされたデバイスはありません。
`kStatusCode_ResetNotAllowed`	デバイスがリクエストされたリセットを拒否した。
`kStatusCode_ResetSuccessCloseCon`	ResetConfig メソッドが成功しますが、最初に接続が閉じられます。
`kStatusCode_UnsecuredListenPreempted`	この Weave スタックが保護されていない接続ハンドラとして、別のアプリが強制的にデバイスコントロールサーバーに置き換えられました。
`kStatusCode_UnsupportedFailSafeMode`	指定したフェイルセーフモードはデバイスでサポートされていません。

173

 @173

デバイスコントロールメッセージのタイプ。

Properties
`kMsgType_ArmFailSafe`	デバイスでフェイルセーフメカニズムを設定する。
`kMsgType_DisableConnectionMonitor`	接続実行状況のモニタリングを無効にします。
`kMsgType_DisarmFailSafe`	アクティブな構成のフェイルセーフを解除します。
`kMsgType_EnableConnectionMonitor`	接続実行状況のモニタリングを有効にします。
`kMsgType_LookingToRendezvous`	Rendezvouz のメッセージを探しています。ペイロードは空です。ソースシグナル ID が唯一の有効なシグナルです。
`kMsgType_RemoteConnectionComplete`	リモートパッシブランデブーが正常に完了し、接続トンネルが開いていることをデバイス制御クライアントに通知します。
`kMsgType_RemotePassiveRendezvous`	デバイスコントロールサーバーに Remote Passive Rendezvous をリクエストします。
`kMsgType_ResetConfig`	デバイスの設定状態をリセットします。
`kMsgType_StartSystemTest`	システムテストを開始します。
`kMsgType_StopSystemTest`	システムテストを停止します。

174

 @174

ArmFailSafe モードの値。

Properties
`kArmMode_New`	新しいフェイルセーフ機能を適用します。すでに有効になっている場合はエラーを返します。
`kArmMode_Reset`	すべてのデバイス設定をリセットして、新しいフェイルセーフを適用します。
`kArmMode_ResumeExisting`	進行中のフェイルセーフを再開します。進行中のフェイルセーフがない場合、またはフェイルセーフトークンが一致しない場合はエラーを返します。

175

 @175

ResetConfig フラグ。

Properties
`kResetConfigFlag_All`	デバイス設定の情報をすべてリセットする。
`kResetConfigFlag_FabricConfig`	ファブリック構成情報をリセットします。
`kResetConfigFlag_FactoryDefaults`	デバイスを出荷時のデフォルト設定にリセットします。
`kResetConfigFlag_NetworkConfig`	ネットワーク設定情報をリセットします。
`kResetConfigFlag_OperationalCredentials`	デバイスの操作に関する認証情報をリセットする。
`kResetConfigFlag_ServiceConfig`	サービス構成情報をリセットします。

176

 @176

メッセージの長さ。

Properties
`kMessageLength_ArmFailsafe`	腕のフェイルセーフメッセージの長さ。
`kMessageLength_DisableConnectionMonitor`	Connection Monitor メッセージ長を無効にします。
`kMessageLength_DisarmFailsafe`	フェイルセーフメッセージの長さを解除します。
`kMessageLength_EnableConnectionMonitor`	Connection Monitor メッセージ長を有効にします。
`kMessageLength_RemotePassiveRendezvous`	リモートパッシブランデブーメッセージの長さ。
`kMessageLength_ResetConfig`	設定メッセージの長さをリセットしました。
`kMessageLength_StartSystemTest`	システムテストメッセージの長さを開始します。
`kMessageLength_StopSystemTest`	システムテストメッセージの長さを停止します。

Functions

送信 LookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

ピアに LookingToRendezvous メッセージを送信します。

詳細

パラメータ

[in] ec

メッセージの送信に使用する ExchangeContext

戻り値

`WEAVE_NO_ERROR`	成功
`WEAVE_ERROR_NO_MEMORY`	メッセージのバッファを割り当てることができなかった場合。
`other`	その他のエラー: nl::Weave::ExchangeContext::SendMessage

nl::Weave::Profiles::DeviceControl

まとめ

列挙型

Functions

クラス

列挙型

172

173

174

175

176

Functions

送信 LookingToRendezvous