Sphero - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

Spheroに搭載されているセンサーの値を通知するプロファイル。

API	概要
GET /gotapi/sphero/collision/onCollision	Spheroの衝突イベントを取得する。
PUT /gotapi/sphero/collision/onCollision	Spheroの衝突イベントの受信を開始する。
DELETE /gotapi/sphero/collision/onCollision	Spheroの衝突イベントの受信を停止する。
GET /gotapi/sphero/locator/onLocator	Spheroの位置と速度を通知するイベントを取得する。
PUT /gotapi/sphero/locator/onLocator	Spheroの位置と速度を通知するイベントの受信を開始する。
DELETE /gotapi/sphero/locator/onLocator	Spheroの位置と速度を通知するイベントの受信を停止する。
GET /gotapi/sphero/quaternion/onQuaternion	Spheroの四元数を通知するイベントを取得する。
PUT /gotapi/sphero/quaternion/onQuaternion	Spheroの四元数を通知するイベントの受信を開始する。
DELETE /gotapi/sphero/quaternion/onQuaternion	Spheroの四元数を通知するイベントの受信を停止する。

one-shot

Spheroの衝突イベントを取得する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

論理名			物理名	データ型	必須	説明
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
衝突イベント			collision	object	Yes	衝突イベントオブジェクト。
	衝突加速度		impactAcceleration	object	No	衝突加速度。
		x成分	x	float	Yes	x軸方向への加速度(cm/s2)
		y成分	y	float	Yes	y軸方向への加速度(cm/s2)
		z成分	z	float	Yes	z軸方向への加速度(cm/s2)
	衝突軸		impactAxis	object	No	衝突軸。
		x成分	x	boolean	Yes	x成分。
		y成分	y	boolean	Yes	y成分。
	衝突力		impactPower	object	No	衝突力。
		x成分	x	float	Yes	x成分。
		y成分	y	float	Yes	y成分。
	衝突速度		impactSpeed	float	No	衝突速度(単位: cm/s)
	衝突時刻		impactTimeStamp	long	No	衝突した時間のタイムスタンプ(単位: ミリ秒)
	衝突時刻の文字列		impactTimeStampString	dateTime	No	衝突した時間のタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "collision" : {
    "impactAxis" : {
      "x" : true,
      "y" : false
    },
    "impactPower" : {
      "x" : 152,
      "y" : 75
    },
    "impactSpeed" : 0,
    "impactTimestamp" : 1483241696789,
    "impactTimeStampString" : "2015-05-17T10:02:20+09:00",
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}

event

Spheroの衝突イベントの受信を開始する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

論理名	物理名	データ型	必須	説明
処理結果	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	アトリビュート名。
衝突イベント			collision	object	Yes	衝突イベントオブジェクト。
	衝突加速度		impactAcceleration	object	No	衝突加速度。
		x成分	x	float	Yes	x軸方向への加速度(cm/s2)
		y成分	y	float	Yes	y軸方向への加速度(cm/s2)
		z成分	z	float	Yes	z軸方向への加速度(cm/s2)
	衝突軸		impactAxis	object	No	衝突軸。
		x成分	x	boolean	Yes	x成分。
		y成分	y	boolean	Yes	y成分。
	衝突力		impactPower	object	No	衝突力。
		x成分	x	float	Yes	x成分。
		y成分	y	float	Yes	y成分。
	衝突速度		impactSpeed	float	No	衝突速度(単位: cm/s)
	衝突時刻		impactTimeStamp	long	No	衝突した時間のタイムスタンプ(単位: ミリ秒)
	衝突時刻の文字列		impactTimeStampString	dateTime	No	衝突した時間のタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "collision",
  "attribute" : "oncollision",
  "collision" : {
    "impactAxis" : {
      "x" : true,
      "y" : false
    },
    "impactPower" : {
      "x" : 152,
      "y" : 75
    },
    "impactSpeed" : 0,
    "impactTimeStamp" : 1483241696789,
    "impactTimeStampString" : "2015-05-17T10:02:20+09:00",
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}

event

Spheroの衝突イベントの受信を停止する。

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

物理名	データ型	必須	説明
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"
}

one-shot

Spheroの位置と速度を通知するイベントを取得する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置		locator	object	Yes	Spheroの位置座標オブジェクト。
	x座標	positionX	float	Yes	位置のx座標 (単位: cm)
	y座標	positionY	float	Yes	位置のy座標 (単位: cm)
	x成分	velocityX	float	Yes	速度のx成分 (単位:cm/s)
	y成分	velocityY	float	Yes	速度のy成分 (単位:cm/s)

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}

event

Spheroの位置と速度を通知するイベントの受信を開始する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

論理名	物理名	データ型	必須	説明
処理結果	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	アトリビュート名。
位置		locator	object	Yes	Spheroの位置座標オブジェクト。
	x座標	positionX	float	Yes	位置のx座標 (単位: cm)
	y座標	positionY	float	Yes	位置のy座標 (単位: cm)
	x成分	velocityX	float	Yes	速度のx成分 (単位:cm/s)
	y成分	velocityY	float	Yes	速度のy成分 (単位:cm/s)

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "locator",
  "attribute" : "onlocator",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}

event

Spheroの位置と速度を通知するイベントの受信を停止する。

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

物理名	データ型	必須	説明
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"
}

one-shot

Spheroの四元数を通知するイベントを取得する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
四元数		quaternion	object	Yes	四元数オブジェクト。
	i軸	q0	float	Yes	i軸
	j軸	q1	float	Yes	j軸
	k軸	q2	float	Yes	k軸
	s軸	q3	float	Yes	s軸
	インターバル	interval	long	Yes	計測のインターバル。(単位: ミリ秒)

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "quaternion" : {
    "q0" : 0.9998000264167786,
    "q1" : -0.0027000000700354576,
    "q2" : -0.010099999606609344,
    "q3" : 0.010900000110268593,
    "interval" : 220
  }
}

event

Spheroの四元数を通知するイベントの受信を開始する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

論理名	物理名	データ型	必須	説明
処理結果	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	アトリビュート名。
四元数		quaternion	object	Yes	四元数オブジェクト。
	i軸	q0	float	Yes	i軸
	j軸	q1	float	Yes	j軸
	k軸	q2	float	Yes	k軸
	s軸	q3	float	Yes	s軸
	インターバル	interval	long	Yes	計測のインターバル。(単位: ミリ秒)

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "quaternion",
  "attribute" : "onquaternion",
  "quaternion" : {
    "q0" : 0.9998000264167786,
    "q1" : -0.0027000000700354576,
    "q2" : -0.010099999606609344,
    "q3" : 0.010900000110268593,
    "interval" : 220
  }
}

event

Spheroの四元数を通知するイベントの受信を停止する。

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

物理名	データ型	必須	説明
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"
}