DeviceOrientation - masaru-takano/DeviceConnect-Spec GitHub Wiki

スマートデバイスの加速度センサー機能を提供するAPI。

API	概要
GET /gotapi/deviceOrientation/onDeviceOrientation	スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを取得する。
PUT /gotapi/deviceOrientation/onDeviceOrientation	スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを開始する。
DELETE /gotapi/deviceOrientation/onDeviceOrientation	スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを停止する。

one-shot

スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを取得する。

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

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

物理名			データ型	必須	説明
result			integer	Yes	0:正常応答 0以外:異常応答
product			string	Yes	DeviceConnectシステムの名前。
orientation			object	Yes
	interval		long	Yes	インターバル インターバル (単位: ミリ秒)
	acceleration		object	No	加速度 加速度のオブジェクト。
		x	float	Yes	x軸成分 x軸方向への加速度（m/s2）。
		y	float	Yes	y軸成分 y軸方向への加速度（m/s2）。
		z	float	Yes	z軸成分 z軸方向への加速度（m/s2）。
	accelerationIncludingGravity		object	No	重力込みの加速度 重力込みの加速度のオブジェクト。
		x	float	Yes	x軸成分 x軸方向への重力込みの加速度（m/s2）。
		y	float	Yes	y軸成分 y軸方向への重力込みの加速度（m/s2）。
		z	float	Yes	z軸成分 z軸方向への重力込みの加速度（m/s2）。
	rotationRate		object	No	角速度 角速度のオブジェクト。
		alpha	float	Yes	z軸回り成分 z軸回りの角速度(degree/s)。
		beta	float	Yes	x軸回り成分 x軸回りの角速度(degree/s)。
		gamma	float	Yes	y軸回り成分 y軸回りの角速度(degree/s)。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "orientation" : {
    "acceleration" : {
      "x" : 0.12345678901234566,
      "y" : 0.9876543210987654,
      "z" : 0.24680135792468014
    },
    "rotationRate" : {
      "alpha" : -0.24680135792468014,
      "beta" : 0.12345678901234566,
      "gamma" : -0.9876543210987654
    },
    "accelerationIncludingGravity" : {
      "x" : 0.24680135792468014,
      "y" : 0.12345678901234566,
      "z" : 9.87654321098
    },
    "interval" : 0
  }
}

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"
}

物理名			データ型	必須	説明
orientation			object	Yes
	interval		long	Yes	インターバル インターバル (単位: ミリ秒)
	acceleration		object	No	加速度 加速度のオブジェクト。
		x	float	Yes	x軸成分 x軸方向への加速度（m/s2）。
		y	float	Yes	y軸成分 y軸方向への加速度（m/s2）。
		z	float	Yes	z軸成分 z軸方向への加速度（m/s2）。
	accelerationIncludingGravity		object	No	重力込みの加速度 重力込みの加速度のオブジェクト。
		x	float	Yes	x軸成分 x軸方向への重力込みの加速度（m/s2）。
		y	float	Yes	y軸成分 y軸方向への重力込みの加速度（m/s2）。
		z	float	Yes	z軸成分 z軸方向への重力込みの加速度（m/s2）。
	rotationRate		object	No	角速度 角速度のオブジェクト。
		alpha	float	Yes	z軸回り成分 z軸回りの角速度(degree/s)。
		beta	float	Yes	x軸回り成分 x軸回りの角速度(degree/s)。
		gamma	float	Yes	y軸回り成分 y軸回りの角速度(degree/s)。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "deviceorientation",
  "attribute" : "ondeviceorientation",
  "orientation" : {
    "acceleration" : {
      "x" : 0.12345678901234566,
      "y" : 0.9876543210987654,
      "z" : 0.24680135792468014
    },
    "rotationRate" : {
      "alpha" : -0.24680135792468014,
      "beta" : 0.12345678901234566,
      "gamma" : -0.9876543210987654
    },
    "accelerationIncludingGravity" : {
      "x" : 0.24680135792468014,
      "y" : 0.12345678901234566,
      "z" : 9.87654321098
    },
    "interval" : 100
  }
}

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"
}