nl::Weave::Profiles::DeviceControl

この名前空間には、Weave Device Control プロファイル用の 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 }`	enum デバイス制御ステータスコード。
`@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 デバイス制御メッセージタイプ。
`@174{ kArmMode_New = 1, kArmMode_Reset = 2, kArmMode_ResumeExisting = 3 }`	enum ArmFailSafe Mode の値
`@175{ kResetConfigFlag_All = 0x00FF, kResetConfigFlag_NetworkConfig = 0x0001, kResetConfigFlag_FabricConfig = 0x0002, kResetConfigFlag_ServiceConfig = 0x0004, kResetConfigFlag_OperationalCredentials = 0x0008, kResetConfigFlag_FactoryDefaults = 0x8000 }`	enum 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 メッセージの長さ。

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

クラス
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate	サーバーデバイス上の受信デバイスコントロール操作を実装するためのデリゲートクラス。
nl::Weave::Profiles::DeviceControl::DeviceControlServer	デバイスコントロールプロファイルを実装するためのサーバークラス。

列挙型

@172

 @172

デバイス制御ステータスコード。

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

@173

 @173

デバイス制御メッセージタイプ。

プロパティ
`kMsgType_ArmFailSafe`	デバイスで構成のフェイルセーフメカニズムを有効にします。
`kMsgType_DisableConnectionMonitor`	接続のライブネスモニタリングを無効にします。
`kMsgType_DisarmFailSafe`	アクティブな構成のフェイルセーフによる監視を解除します。
`kMsgType_EnableConnectionMonitor`	接続の実行状況のモニタリングを有効にします。
`kMsgType_LookingToRendezvous`	Rendezvouz のメッセージを探しています。ペイロードは空です。内部で意味のあるシグナルはソースノード ID のみです。
`kMsgType_RemoteConnectionComplete`	リモートパッシブランデブが正常に完了し、接続トンネルが開いていることをデバイスコントロールクライアントに知らせます。
`kMsgType_RemotePassiveRendezvous`	デバイスコントロールサーバーを使用したリモートパッシブランデブのリクエスト。
`kMsgType_ResetConfig`	デバイスの設定状態をリセットします。
`kMsgType_StartSystemTest`	システムテストを開始します。
`kMsgType_StopSystemTest`	システムテストを停止します。

@174

 @174

ArmFailSafe Mode の値

プロパティ
`kArmMode_New`	新しいフェイルセーフを有効にする。すでにアクティブになっている場合はエラーを返します。
`kArmMode_Reset`	すべてのデバイス設定をリセットし、新しいフェイルセーフを作動させます。
`kArmMode_ResumeExisting`	すでに進行中のフェイルセーフを再開する。進行中のフェイルセーフがない場合、またはフェイルセーフトークンが一致しない場合は、エラーを返します。

@175

 @175

ResetConfig フラグ。

プロパティ
`kResetConfigFlag_All`	すべてのデバイス設定情報をリセットします。
`kResetConfigFlag_FabricConfig`	ファブリック構成情報をリセットします。
`kResetConfigFlag_FactoryDefaults`	デバイスを完全に出荷時の設定にリセットします。
`kResetConfigFlag_NetworkConfig`	ネットワーク構成情報をリセットします。
`kResetConfigFlag_OperationalCredentials`	デバイスの操作認証情報をリセットします。
`kResetConfigFlag_ServiceConfig`	サービス構成情報をリセットします。

@176

 @176

メッセージの長さ。

プロパティ
`kMessageLength_ArmFailsafe`	Arm フェイルセーフメッセージの長さ。
`kMessageLength_DisableConnectionMonitor`	接続モニターのメッセージの長さを無効にします。
`kMessageLength_DisarmFailsafe`	フェイルセーフメッセージの長さに対する監視を解除します。
`kMessageLength_EnableConnectionMonitor`	接続モニターのメッセージの長さを有効にする。
`kMessageLength_RemotePassiveRendezvous`	リモートのパッシブランデブーメッセージの長さ。
`kMessageLength_ResetConfig`	設定のリセットメッセージの長さ。
`kMessageLength_StartSystemTest`	開始システムテストメッセージの長さ。
`kMessageLength_StopSystemTest`	システムテストメッセージの長さを停止。

関数

SendLookingToRendezvous

WEAVE_ERROR SendLookingToRendezvous(
  ExchangeContext *ec
)

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

詳細

パラメータ

[in] ec

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

戻り値

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