Health - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki
ヘルスケア関連のデバイスから通知されるイベントを受信するAPI.
| API | 概要 |
|---|---|
| GET /gotapi/health/heart | デバイスの心拍数計測通知イベントを取得する。 |
| PUT /gotapi/health/heart | デバイスの心拍数計測通知イベントを開始する。 |
| DELETE /gotapi/health/heart | デバイスの心拍数計測通知イベントを停止する。 |
| GET /gotapi/health/heartRate | デバイスの心拍数計測通知イベントを取得する。 |
| PUT /gotapi/health/heartRate | デバイスの心拍数計測通知イベントを開始する。 |
| DELETE /gotapi/health/heartRate | デバイスの心拍数計測通知イベントを停止する。 |
| GET /gotapi/health/onheart | デバイスの心拍数計測通知イベントを取得する。 |
| PUT /gotapi/health/onheart | デバイスの心拍数計測通知イベントを開始する。 |
| DELETE /gotapi/health/onheart | デバイスの心拍数計測通知イベントを停止する。 |
one-shot
デバイスの心拍数計測通知イベントを取得する。
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 論理名 | 物理名 | データ型 | 必須 | 説明 | ||
|---|---|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0:正常応答 0以外:異常応答 |
||
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 | ||
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 | ||
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 | ||
| 心拍数計測結果 | heart | object | Yes | 検出値、検出したデバイスの情報を取得する。 | ||
| 心拍数オブジェクト | rate | object | Yes | 心拍数の情報を持つ。 | ||
| 心拍数 | value | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 | ||
| 心拍数のMDER Float値 | mderFloat | string | Yes | ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。 | ||
| 心拍数のタイプ | type | string | Yes | この値が「heart rate」であることを表す文字列を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のオブジェクトのタイプのコード | typeCode | string | Yes | 「147842」という「heart rate」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位 | unit | string | Yes | 「beat per min」のように人間がわかるように単位を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位コード | unitCode | string | Yes | 「264864」という「beat per min」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のタイムスタンプ | timeStamp | long | Yes | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 心拍数のタイムスタンプ文字列 | timeStampString | dateTime | Yes | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| RR間隔オブジェクト | rr | object | No | RR間隔値の情報を持つ。 | ||
| RR間隔値 | value | integer | No | ターゲットデバイスで測定したRR間隔を返す。 | ||
| RR間隔のMDER Float値 | mderFloat | string | No | RR間隔値のMDERFloat値を返す。 | ||
| RR間隔のタイプ | type | string | No | RR間隔を表す「RR interval」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のオブジェクトのタイプのコード | typeCode | string | No | RR間隔を表す「147240」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位 | unit | string | No | RR間隔の単位を表す「ms」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位コード | unitCode | string | No | RR間隔の単位であるmsを表す「264338」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| RR間隔のタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| 消費エネルギーオブジェクト | energy | object | No | 消費エネルギーの情報を持つ。 | ||
| 消費エネルギー | value | integer | No | ターゲットデバイスで測定した消費エネルギー値を返す。 | ||
| 消費エネルギーのMDER Float値 | mderFloat | string | No | 消費エネルギー値のMDERFloat値を返す。 | ||
| 消費エネルギーのタイプ | type | string | No | 消費エネルギー値を表す「energy expended」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイプコード | typeCode | string | No | 消費エネルギー値を表す「119」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位 | unit | string | No | 消費エネルギー値の単位を表す「Calories」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位コード | unitCode | string | No | 消費エネルギー値の単位であるCaloriesを表す「6784」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 消費エネルギーのタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| デバイスオブジェクト | device | object | Yes | 健康機器の情報を持つ。 | ||
| プロダクト名 | productName | string | Yes | ターゲットデバイスの製品名。 取得できない時は任意のアルゴリズムでデバイス名を生成。 | ||
| メーカ名 | manufacturerName | string | Yes | ターゲットデバイスのメーカ名。 取得できない場合は空文字を指定。 | ||
| モデルの番号 | modelNumber | string | Yes | ターゲットデバイスのモデル番号。 取得できない場合は空文字を指定 | ||
| ファームウェアリビジョン | firmwareRevision | string | Yes | ターゲットデバイスのファームウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| シリアルナンバー | serialNumber | string | Yes | ターゲットデバイスのシリアル番号。 取得できない場合は空文字を指定。 | ||
| ソフトウェアリビジョン | softwareRevision | string | Yes | ターゲットデバイスのソフトウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| ハードウェアリビジョン | hardwareRevision | string | Yes | ターゲットデバイスのハードウェアリビジョン。 取得できない場合は、空文字を指定。 | ||
| パートナンバー | partNumber | string | Yes | ターゲットデバイスのパート番号。 取得できない場合は、空文字を指定。 | ||
| プロトコルリビジョン | protocolRevision | string | Yes | ターゲットデバイスのプロトコルリビジョン。 取得できない場合は、空文字を指定。 | ||
| システムID | systemId | string | Yes | ターゲットデバイスのシステムID。 16進数。取得できない場合は「0x0」。 | ||
| バッテリーレベル | batteryLevel | float | Yes | ターゲットデバイスのバッテリーレベル。 取得できない場合は-1.0を返す。 範囲: 0.0〜1.0 |
||
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"heart" : {
"rate" : {
"value" : 60,
"mderFloat" : "00000042",
"type" : "heart rate",
"typeCode" : 147842,
"unit" : "beat per min",
"unitCode" : 264864,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"rr" : {
"value" : 909.1796875,
"mderFloat" : "F9E9CF8B",
"type" : "RR interval",
"typeCode" : 147240,
"unit" : "ms",
"unitCode" : 264338,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"energy" : {
"value" : 0,
"mderFloat" : "01000000",
"type" : "energy expended",
"typeCode" : 119,
"unit" : "Calories",
"unitCode" : 6784,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"device" : {
"productName" : "EXAMPLE DEVICE",
"manufacturerName" : "EXAMPLE MANUFACTURE NAME",
"modelNumber" : "EXAMPLE MODEL NUMBER",
"firmwareRevision" : "EXAMPLE FIRMWARE REVISION",
"serialNumber" : "EXAMPLE SERIAL NUMBER",
"softwareRevision" : "EXAMPLE SOFTWARE REVISION",
"hardwareRevision" : "EXAMPLE HARDWARE REVISION",
"partNumber" : "EXAMPLE PART NUMBER",
"protocolRevision" : "EXAMPLE PROTOCOL REVISION",
"systemId" : "0x0",
"batteryLevel" : -1
}
}
}
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 | アトリビュート名。 | ||
| 心拍数計測結果 | heart | object | Yes | 検出値、検出したデバイスの情報を取得する。 | ||
| 心拍数オブジェクト | rate | object | Yes | 心拍数の情報を持つ。 | ||
| 心拍数 | value | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 | ||
| 心拍数のMDER Float値 | mderFloat | string | Yes | ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。 | ||
| 心拍数のタイプ | type | string | Yes | この値が「heart rate」であることを表す文字列を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のオブジェクトのタイプのコード | typeCode | string | Yes | 「147842」という「heart rate」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位 | unit | string | Yes | 「beat per min」のように人間がわかるように単位を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位コード | unitCode | string | Yes | 「264864」という「beat per min」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のタイムスタンプ | timeStamp | long | Yes | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 心拍数のタイムスタンプ文字列 | timeStampString | dateTime | Yes | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| RR間隔オブジェクト | rr | object | No | RR間隔値の情報を持つ。 | ||
| RR間隔値 | value | integer | No | ターゲットデバイスで測定したRR間隔を返す。 | ||
| RR間隔のMDER Float値 | mderFloat | string | No | RR間隔値のMDERFloat値を返す。 | ||
| RR間隔のタイプ | type | string | No | RR間隔を表す「RR interval」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のオブジェクトのタイプのコード | typeCode | string | No | RR間隔を表す「147240」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位 | unit | string | No | RR間隔の単位を表す「ms」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位コード | unitCode | string | No | RR間隔の単位であるmsを表す「264338」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| RR間隔のタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| 消費エネルギーオブジェクト | energy | object | No | 消費エネルギーの情報を持つ。 | ||
| 消費エネルギー | value | integer | No | ターゲットデバイスで測定した消費エネルギー値を返す。 | ||
| 消費エネルギーのMDER Float値 | mderFloat | string | No | 消費エネルギー値のMDERFloat値を返す。 | ||
| 消費エネルギーのタイプ | type | string | No | 消費エネルギー値を表す「energy expended」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイプコード | typeCode | string | No | 消費エネルギー値を表す「119」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位 | unit | string | No | 消費エネルギー値の単位を表す「Calories」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位コード | unitCode | string | No | 消費エネルギー値の単位であるCaloriesを表す「6784」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 消費エネルギーのタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| デバイスオブジェクト | device | object | Yes | 健康機器の情報を持つ。 | ||
| プロダクト名 | productName | string | Yes | ターゲットデバイスの製品名。 取得できない時は任意のアルゴリズムでデバイス名を生成。 | ||
| メーカ名 | manufacturerName | string | Yes | ターゲットデバイスのメーカ名。 取得できない場合は空文字を指定。 | ||
| モデルの番号 | modelNumber | string | Yes | ターゲットデバイスのモデル番号。 取得できない場合は空文字を指定 | ||
| ファームウェアリビジョン | firmwareRevision | string | Yes | ターゲットデバイスのファームウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| シリアルナンバー | serialNumber | string | Yes | ターゲットデバイスのシリアル番号。 取得できない場合は空文字を指定。 | ||
| ソフトウェアリビジョン | softwareRevision | string | Yes | ターゲットデバイスのソフトウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| ハードウェアリビジョン | hardwareRevision | string | Yes | ターゲットデバイスのハードウェアリビジョン。 取得できない場合は、空文字を指定。 | ||
| パートナンバー | partNumber | string | Yes | ターゲットデバイスのパート番号。 取得できない場合は、空文字を指定。 | ||
| プロトコルリビジョン | protocolRevision | string | Yes | ターゲットデバイスのプロトコルリビジョン。 取得できない場合は、空文字を指定。 | ||
| システムID | systemId | string | Yes | ターゲットデバイスのシステムID。 16進数。取得できない場合は「0x0」。 | ||
| バッテリーレベル | batteryLevel | float | Yes | ターゲットデバイスのバッテリーレベル。 取得できない場合は-1.0を返す。 範囲: 0.0〜1.0 |
||
{
"serviceId" : "Host.exampleId.localhost.deviceconnect.org",
"profile" : "health",
"attribute" : "heart",
"heart" : {
"rate" : {
"value" : 60,
"mderFloat" : "00000042",
"type" : "heart rate",
"typeCode" : 147842,
"unit" : "beat per min",
"unitCode" : 264864,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"rr" : {
"value" : 909.1796875,
"mderFloat" : "F9E9CF8B",
"type" : "RR interval",
"typeCode" : 147240,
"unit" : "ms",
"unitCode" : 264338,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"energy" : {
"value" : 0,
"mderFloat" : "01000000",
"type" : "energy expended",
"typeCode" : 119,
"unit" : "Calories",
"unitCode" : 6784,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"device" : {
"productName" : "EXAMPLE DEVICE",
"manufacturerName" : "EXAMPLE MANUFACTURE NAME",
"modelNumber" : "EXAMPLE MODEL NUMBER",
"firmwareRevision" : "EXAMPLE FIRMWARE REVISION",
"serialNumber" : "EXAMPLE SERIAL NUMBER",
"softwareRevision" : "EXAMPLE SOFTWARE REVISION",
"hardwareRevision" : "EXAMPLE HARDWARE REVISION",
"partNumber" : "EXAMPLE PART NUMBER",
"protocolRevision" : "EXAMPLE PROTOCOL REVISION",
"systemId" : "0x0",
"batteryLevel" : -1
}
}
}
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"
}
one-shot
デバイスの心拍数計測通知イベントを取得する。
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 論理名 | 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0:正常応答 0以外:異常応答 |
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
| 心拍数 | heartRate | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0"
}
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 | アトリビュート名。 |
| 心拍数 | heartRate | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 |
{
"serviceId" : "Host.exampleId.localhost.deviceconnect.org",
"profile" : "health",
"attribute" : "heartrate",
"heartRate" : 80
}
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"
}
one-shot
デバイスの心拍数計測通知イベントを取得する。
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 論理名 | 物理名 | データ型 | 必須 | 説明 | ||
|---|---|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0:正常応答 0以外:異常応答 |
||
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 | ||
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 | ||
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 | ||
| 心拍数計測結果 | heart | object | Yes | 検出値、検出したデバイスの情報を取得する。 | ||
| 心拍数オブジェクト | rate | object | Yes | 心拍数の情報を持つ。 | ||
| 心拍数 | value | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 | ||
| 心拍数のMDER Float値 | mderFloat | string | Yes | ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。 | ||
| 心拍数のタイプ | type | string | Yes | この値が「heart rate」であることを表す文字列を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のオブジェクトのタイプのコード | typeCode | string | Yes | 「147842」という「heart rate」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位 | unit | string | Yes | 「beat per min」のように人間がわかるように単位を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位コード | unitCode | string | Yes | 「264864」という「beat per min」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のタイムスタンプ | timeStamp | long | Yes | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 心拍数のタイムスタンプ文字列 | timeStampString | dateTime | Yes | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| RR間隔オブジェクト | rr | object | No | RR間隔値の情報を持つ。 | ||
| RR間隔値 | value | integer | No | ターゲットデバイスで測定したRR間隔を返す。 | ||
| RR間隔のMDER Float値 | mderFloat | string | No | RR間隔値のMDERFloat値を返す。 | ||
| RR間隔のタイプ | type | string | No | RR間隔を表す「RR interval」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のオブジェクトのタイプのコード | typeCode | string | No | RR間隔を表す「147240」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位 | unit | string | No | RR間隔の単位を表す「ms」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位コード | unitCode | string | No | RR間隔の単位であるmsを表す「264338」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| RR間隔のタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| 消費エネルギーオブジェクト | energy | object | No | 消費エネルギーの情報を持つ。 | ||
| 消費エネルギー | value | integer | No | ターゲットデバイスで測定した消費エネルギー値を返す。 | ||
| 消費エネルギーのMDER Float値 | mderFloat | string | No | 消費エネルギー値のMDERFloat値を返す。 | ||
| 消費エネルギーのタイプ | type | string | No | 消費エネルギー値を表す「energy expended」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイプコード | typeCode | string | No | 消費エネルギー値を表す「119」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位 | unit | string | No | 消費エネルギー値の単位を表す「Calories」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位コード | unitCode | string | No | 消費エネルギー値の単位であるCaloriesを表す「6784」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 消費エネルギーのタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| デバイスオブジェクト | device | object | Yes | 健康機器の情報を持つ。 | ||
| プロダクト名 | productName | string | Yes | ターゲットデバイスの製品名。 取得できない時は任意のアルゴリズムでデバイス名を生成。 | ||
| メーカ名 | manufacturerName | string | Yes | ターゲットデバイスのメーカ名。 取得できない場合は空文字を指定。 | ||
| モデルの番号 | modelNumber | string | Yes | ターゲットデバイスのモデル番号。 取得できない場合は空文字を指定 | ||
| ファームウェアリビジョン | firmwareRevision | string | Yes | ターゲットデバイスのファームウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| シリアルナンバー | serialNumber | string | Yes | ターゲットデバイスのシリアル番号。 取得できない場合は空文字を指定。 | ||
| ソフトウェアリビジョン | softwareRevision | string | Yes | ターゲットデバイスのソフトウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| ハードウェアリビジョン | hardwareRevision | string | Yes | ターゲットデバイスのハードウェアリビジョン。 取得できない場合は、空文字を指定。 | ||
| パートナンバー | partNumber | string | Yes | ターゲットデバイスのパート番号。 取得できない場合は、空文字を指定。 | ||
| プロトコルリビジョン | protocolRevision | string | Yes | ターゲットデバイスのプロトコルリビジョン。 取得できない場合は、空文字を指定。 | ||
| システムID | systemId | string | Yes | ターゲットデバイスのシステムID。 16進数。取得できない場合は「0x0」。 | ||
| バッテリーレベル | batteryLevel | float | Yes | ターゲットデバイスのバッテリーレベル。 取得できない場合は-1.0を返す。 範囲: 0.0〜1.0 |
||
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"heart" : {
"rate" : {
"value" : 60,
"mderFloat" : "00000042",
"type" : "heart rate",
"typeCode" : 147842,
"unit" : "beat per min",
"unitCode" : 264864,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"rr" : {
"value" : 909.1796875,
"mderFloat" : "F9E9CF8B",
"type" : "RR interval",
"typeCode" : 147240,
"unit" : "ms",
"unitCode" : 264338,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"energy" : {
"value" : 0,
"mderFloat" : "01000000",
"type" : "energy expended",
"typeCode" : 119,
"unit" : "Calories",
"unitCode" : 6784,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"device" : {
"productName" : "EXAMPLE DEVICE",
"manufacturerName" : "EXAMPLE MANUFACTURE NAME",
"modelNumber" : "EXAMPLE MODEL NUMBER",
"firmwareRevision" : "EXAMPLE FIRMWARE REVISION",
"serialNumber" : "EXAMPLE SERIAL NUMBER",
"softwareRevision" : "EXAMPLE SOFTWARE REVISION",
"hardwareRevision" : "EXAMPLE HARDWARE REVISION",
"partNumber" : "EXAMPLE PART NUMBER",
"protocolRevision" : "EXAMPLE PROTOCOL REVISION",
"systemId" : "0x0",
"batteryLevel" : -1
}
}
}
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 | アトリビュート名。 | ||
| 心拍数計測結果 | heart | object | Yes | 検出値、検出したデバイスの情報を取得する。 | ||
| 心拍数オブジェクト | rate | object | Yes | 心拍数の情報を持つ。 | ||
| 心拍数 | value | integer | Yes | ターゲットデバイスで測定した心拍数を返す。 | ||
| 心拍数のMDER Float値 | mderFloat | string | Yes | ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。 | ||
| 心拍数のタイプ | type | string | Yes | この値が「heart rate」であることを表す文字列を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のオブジェクトのタイプのコード | typeCode | string | Yes | 「147842」という「heart rate」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位 | unit | string | Yes | 「beat per min」のように人間がわかるように単位を返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数の単位コード | unitCode | string | Yes | 「264864」という「beat per min」を意味するコードを返す。 取得できない場合は、空文字を返す。 | ||
| 心拍数のタイムスタンプ | timeStamp | long | Yes | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 心拍数のタイムスタンプ文字列 | timeStampString | dateTime | Yes | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| RR間隔オブジェクト | rr | object | No | RR間隔値の情報を持つ。 | ||
| RR間隔値 | value | integer | No | ターゲットデバイスで測定したRR間隔を返す。 | ||
| RR間隔のMDER Float値 | mderFloat | string | No | RR間隔値のMDERFloat値を返す。 | ||
| RR間隔のタイプ | type | string | No | RR間隔を表す「RR interval」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のオブジェクトのタイプのコード | typeCode | string | No | RR間隔を表す「147240」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位 | unit | string | No | RR間隔の単位を表す「ms」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔の単位コード | unitCode | string | No | RR間隔の単位であるmsを表す「264338」を返す。 取得できない場合は、空文字を返す。 | ||
| RR間隔のタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| RR間隔のタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| 消費エネルギーオブジェクト | energy | object | No | 消費エネルギーの情報を持つ。 | ||
| 消費エネルギー | value | integer | No | ターゲットデバイスで測定した消費エネルギー値を返す。 | ||
| 消費エネルギーのMDER Float値 | mderFloat | string | No | 消費エネルギー値のMDERFloat値を返す。 | ||
| 消費エネルギーのタイプ | type | string | No | 消費エネルギー値を表す「energy expended」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイプコード | typeCode | string | No | 消費エネルギー値を表す「119」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位 | unit | string | No | 消費エネルギー値の単位を表す「Calories」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーの単位コード | unitCode | string | No | 消費エネルギー値の単位であるCaloriesを表す「6784」を返す。 取得できない場合は、空文字を返す。 | ||
| 消費エネルギーのタイムスタンプ | timeStamp | long | No | 測定が行われた測定時間。 ミリ秒のUnixタイムスタンプで返す。 | ||
| 消費エネルギーのタイムスタンプ文字列 | timeStampString | dateTime | No | タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。 | ||
| デバイスオブジェクト | device | object | Yes | 健康機器の情報を持つ。 | ||
| プロダクト名 | productName | string | Yes | ターゲットデバイスの製品名。 取得できない時は任意のアルゴリズムでデバイス名を生成。 | ||
| メーカ名 | manufacturerName | string | Yes | ターゲットデバイスのメーカ名。 取得できない場合は空文字を指定。 | ||
| モデルの番号 | modelNumber | string | Yes | ターゲットデバイスのモデル番号。 取得できない場合は空文字を指定 | ||
| ファームウェアリビジョン | firmwareRevision | string | Yes | ターゲットデバイスのファームウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| シリアルナンバー | serialNumber | string | Yes | ターゲットデバイスのシリアル番号。 取得できない場合は空文字を指定。 | ||
| ソフトウェアリビジョン | softwareRevision | string | Yes | ターゲットデバイスのソフトウェアリビジョン。 取得できない場合は空文字を指定。 | ||
| ハードウェアリビジョン | hardwareRevision | string | Yes | ターゲットデバイスのハードウェアリビジョン。 取得できない場合は、空文字を指定。 | ||
| パートナンバー | partNumber | string | Yes | ターゲットデバイスのパート番号。 取得できない場合は、空文字を指定。 | ||
| プロトコルリビジョン | protocolRevision | string | Yes | ターゲットデバイスのプロトコルリビジョン。 取得できない場合は、空文字を指定。 | ||
| システムID | systemId | string | Yes | ターゲットデバイスのシステムID。 16進数。取得できない場合は「0x0」。 | ||
| バッテリーレベル | batteryLevel | float | Yes | ターゲットデバイスのバッテリーレベル。 取得できない場合は-1.0を返す。 範囲: 0.0〜1.0 |
||
{
"serviceId" : "Host.exampleId.localhost.deviceconnect.org",
"profile" : "health",
"attribute" : "heart",
"heart" : {
"rate" : {
"value" : 60,
"mderFloat" : "00000042",
"type" : "heart rate",
"typeCode" : 147842,
"unit" : "beat per min",
"unitCode" : 264864,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"rr" : {
"value" : 909.1796875,
"mderFloat" : "F9E9CF8B",
"type" : "RR interval",
"typeCode" : 147240,
"unit" : "ms",
"unitCode" : 264338,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"energy" : {
"value" : 0,
"mderFloat" : "01000000",
"type" : "energy expended",
"typeCode" : 119,
"unit" : "Calories",
"unitCode" : 6784,
"timeStamp" : 1483241696789,
"timeStampString" : "2015-05-17T10:02:20+09:00"
},
"device" : {
"productName" : "EXAMPLE DEVICE",
"manufacturerName" : "EXAMPLE MANUFACTURE NAME",
"modelNumber" : "EXAMPLE MODEL NUMBER",
"firmwareRevision" : "EXAMPLE FIRMWARE REVISION",
"serialNumber" : "EXAMPLE SERIAL NUMBER",
"softwareRevision" : "EXAMPLE SOFTWARE REVISION",
"hardwareRevision" : "EXAMPLE HARDWARE REVISION",
"partNumber" : "EXAMPLE PART NUMBER",
"protocolRevision" : "EXAMPLE PROTOCOL REVISION",
"systemId" : "0x0",
"batteryLevel" : -1
}
}
}
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"
}