StressEstimation - TakayukiHoshi1984/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以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ストレス情報 stress object Yes
LFHF値 lfhf float Yes ターゲットデバイスによって測定されたLFHF値。
タイムスタンプ (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",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

種別

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

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
ストレス情報 stress object Yes
LFHF値 lfhf float Yes ターゲットデバイスによって測定されたLFHF値。
タイムスタンプ (Unix時刻) timeStamp long Yes 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
タイムスタンプ (日付) timeStampString dateTime Yes タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "stressestimation",
  "attribute" : "onstressestimation",
  "stress" : {
    "lfhf" : 0.5,
    "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"
}
⚠️ **GitHub.com Fallback** ⚠️