Ecg - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

デバイスのECGのイベントを通知するための機能。 ※ECG:Electrocardiogram(心電図)

目次

API 概要
GET /gotapi/ecg/onECG デバイスのECG計測通知イベントを取得する。
PUT /gotapi/ecg/onECG デバイスのECG計測値を通知するイベントを開始する。
DELETE /gotapi/ecg/onECG デバイスのECG計測値を通知するイベントを停止する。

種別

one-shot

概要

デバイスのECG計測通知イベントを取得する。

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

リクエスト

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

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0:正常応答
0以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ECG ecg object Yes ECGのオブジェクト。
ECG value integer Yes ターゲットデバイスで測定した心拍数を返す。
ECGのMDER Float値 mderFloat string Yes ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
ECGのタイプ type string Yes この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
ECGのオブジェクトのタイプのコード typeCode string Yes 「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGの単位 unit string Yes 「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
ECGの単位コード unitCode string Yes 「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGのタイムスタンプ timeStamp long Yes 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
ECGのタイムスタンプ文字列 timeStampString dateTime Yes タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "ecg" : {
    "value" : -172.40676879882812,
    "mderFloat" : "F68ED1CC",
    "type" : "ecg beat",
    "typeCode" : 663568,
    "unit" : "mVolt * milliSecond",
    "unitCode" : 3328,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

種別

event

概要

デバイスのECG計測値を通知するイベントを開始する。

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

リクエスト

物理名 データ型 必須 説明
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 アトリビュート名。
ECG ecg object Yes ECGのオブジェクト。
ECG value integer Yes ターゲットデバイスで測定した心拍数を返す。
ECGのMDER Float値 mderFloat string Yes ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
ECGのタイプ type string Yes この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
ECGのオブジェクトのタイプのコード typeCode string Yes 「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGの単位 unit string Yes 「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
ECGの単位コード unitCode string Yes 「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGのタイムスタンプ timeStamp long Yes 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
ECGのタイムスタンプ文字列 timeStampString dateTime Yes タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "ecg",
  "attribute" : "onecg",
  "ecg" : {
    "value" : -172.40676879882812,
    "mderFloat" : "F68ED1CC",
    "type" : "ecg beat",
    "typeCode" : 663568,
    "unit" : "mVolt * milliSecond",
    "unitCode" : 3328,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

種別

event

概要

デバイスのECG計測値を通知するイベントを停止する。

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

リクエスト

物理名 データ型 必須 説明
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** ⚠️