WalkState - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

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

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

one-shot

スマートデバイスの歩行状態計測情報を取得する。

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

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

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
歩行情報		walk	object	Yes
	歩数	step	double	Yes	歩数。単位は歩。
	歩行状態	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	速度	speed	double	Yes	速度。単位はkm/h。
	距離	distance	double	No	距離。単位はkm。
	左右バランス	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339 「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

{
  "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" : "2015-05-17T10:02:20+09:00"
  }
}

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	アトリビュート名。
歩行情報		walk	object	Yes
	歩数	step	double	Yes	歩数。単位は歩。
	歩行状態	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	速度	speed	double	Yes	速度。単位はkm/h。
	距離	distance	double	No	距離。単位はkm。
	左右バランス	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339 「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "walkstate",
  "attribute" : "onwalkstate",
  "walk" : {
    "step" : 123456,
    "state" : "Walking",
    "speed" : 5.799,
    "distance" : 12.3456,
    "balance" : 0.16,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

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