PoseEstimation - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

デバイスの姿勢推定のイベントを通知するための機能。

目次

API 概要
GET /gotapi/poseEstimation/onPoseEstimation デバイスの姿勢推定計測イベントを取得する。
PUT /gotapi/poseEstimation/onPoseEstimation デバイスの姿勢推定計測イベントを開始する。
DELETE /gotapi/poseEstimation/onPoseEstimation デバイスの姿勢推定計測イベントを停止する。

GET /gotapi/poseEstimation/onPoseEstimation

種別

one-shot

概要

デバイスの姿勢推定計測イベントを取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0:正常応答
0以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
姿勢情報 pose object Yes
姿勢状態 state string Yes ターゲットデバイスによって測定された姿勢状態を返す。
  • Forward:前屈
  • Backward:後屈
  • Rightside:右傾き
  • Leftside:左傾き
  • FaceUp:仰向け
  • FaceLeft:左向き
  • FaceDown:うつ伏せ
  • FaceRight:右向き
  • Standing:直立
姿勢推定のタイムスタンプ timeStamp long Yes 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
姿勢推定のタイムスタンプ文字列 timeStampString dateTime Yes タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/poseEstimation/onPoseEstimation

種別

event

概要

デバイスの姿勢推定計測イベントを開始する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
interval long No デバイスプラグインがイベントを送信する間隔。

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0:正常応答
0以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。
アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
姿勢情報 pose object Yes
姿勢状態 state string Yes ターゲットデバイスによって測定された姿勢状態を返す。
  • Forward:前屈
  • Backward:後屈
  • Rightside:右傾き
  • Leftside:左傾き
  • FaceUp:仰向け
  • FaceLeft:左向き
  • FaceDown:うつ伏せ
  • FaceRight:右向き
  • Standing:直立
姿勢推定のタイムスタンプ timeStamp long Yes 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
姿勢推定のタイムスタンプ文字列 timeStampString dateTime Yes タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "poseestimation",
  "attribute" : "onposeestimation",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/poseEstimation/onPoseEstimation

種別

event

概要

デバイスの姿勢推定計測イベントを停止する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0:正常応答
0以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。
アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️