StressEstimation - masaru-takano/DeviceConnect-Spec GitHub Wiki

ストレス推定のイベントを通知するプロファイル。

API	概要
GET /gotapi/stressEstimation/onStressEstimation	デバイスのストレス推定計測イベントを取得する。
PUT /gotapi/stressEstimation/onStressEstimation	デバイスのストレス推定計測イベントの受信を開始する。
DELETE /gotapi/stressEstimation/onStressEstimation	当該イベントの通知を停止する。

one-shot

デバイスのストレス推定計測イベントを取得する。

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

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

物理名		データ型	必須	説明
result		integer	Yes	0:正常応答 0以外:異常応答
stress		object	Yes
	lfhf	float	Yes	ターゲットデバイスによって測定されたLFHF値。
	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	timeStampString	string	Yes	タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
product		string	Yes	DeviceConnectシステムの名前。
version		string	Yes	DeviceConnectシステムのバージョン名。
hmac		string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}

event

デバイスのストレス推定計測イベントの受信を開始する。

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

物理名		データ型	必須	説明
stress		object	Yes
	lfhf	float	Yes	ターゲットデバイスによって測定されたLFHF値。
	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	timeStampString	string	Yes	タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
attribute		string	Yes	アトリビュート名。
serviceId		string	Yes	0:正常応答 0以外:異常応答
interface		string	Yes	インターフェース名。
profile		string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "stressestimation",
  "attribute" : "onstressestimation",
  "stress" : {
    "lfhf" : 0.5,
    "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"
}