WalkState - masaru-takano/DeviceConnect-Spec GitHub Wiki

歩行状態を通知する機能を提供するプロファイル。

API	概要
GET /gotapi/walkState/onWalkState	該当デバイスの歩行状態計測イベントを取得する。
PUT /gotapi/walkState/onWalkState	該当デバイスの歩行状態計測イベントを通知する。
DELETE /gotapi/walkState/onWalkState	該当デバイスの歩行状態計測イベントを停止する。

one-shot

該当デバイスの歩行状態計測イベントを取得する。

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

物理名		データ型	必須	説明
result		integer	Yes	0:正常応答 0以外:異常応答
product		string	Yes	DeviceConnectシステムの名前。
version		string	Yes	DeviceConnectシステムのバージョン名。
walk		object	Yes
	step	double	Yes	歩数。単位は歩。
	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	speed	double	Yes	距離。単位はkm。
	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	timeStampString	string	Yes	タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
hmac		string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "walk" : {
    "step" : 123456,
    "state" : "Walking",
    "speed" : 5.799,
    "distance" : 12.3456,
    "balance" : 0.16,
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}

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

物理名		データ型	必須	説明
attribute		string	Yes	アトリビュート名。
serviceId		string	Yes	0:正常応答 0以外:異常応答
interface		string	Yes	インターフェース名。
walk		object	Yes
	step	double	Yes	歩数。単位は歩。
	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	speed	double	Yes	距離。単位はkm。
	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	timeStampString	string	Yes	タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
profile		string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "walkstate",
  "attribute" : "onwalkstate",
  "walk" : {
    "step" : 123456,
    "state" : "Walking",
    "speed" : 5.799,
    "distance" : 12.3456,
    "balance" : 0.16,
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}

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