DeviceOrientation - TakayukiHoshi1984/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システムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
デバイスの向き			orientation	object	Yes
	インターバル		interval	long	Yes	インターバル (単位: ミリ秒)
	加速度		acceleration	object	No	加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への加速度（m/s2）。
	重力込みの加速度		accelerationIncludingGravity	object	No	重力込みの加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への重力込みの加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への重力込みの加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への重力込みの加速度（m/s2）。
	角速度		rotationRate	object	No	角速度のオブジェクト。
		z軸回り成分	alpha	float	Yes	z軸回りの角速度(degree/s)。
		x軸回り成分	beta	float	Yes	x軸回りの角速度(degree/s)。
		y軸回り成分	gamma	float	Yes	y軸回りの角速度(degree/s)。

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

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

{
  "serviceId" : "Host.exampleId.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"
}