PowerMeter - masaru-takano/DeviceConnect-Spec GitHub Wiki
スマートデバイスが計測した電力を取得する機能を提供するAPI。
| API | 概要 |
|---|---|
| GET /gotapi/powerMeter | スマートデバイスの電源状態を取得する。 |
| PUT /gotapi/powerMeter | スマートデバイスの電源を付ける。 |
| DELETE /gotapi/powerMeter | スマートデバイスの電源を消す。 |
| GET /gotapi/powerMeter/instantaneousPower | スマートデバイスが計測した瞬間電力量を取得する。 |
| GET /gotapi/powerMeter/integratedPower | スマートデバイスが計測した積算電力量を取得する。 |
one-shot
スマートデバイスの電源状態を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
| product | string | Yes |
DeviceConnectシステムの名前 |
| version | string | Yes |
DeviceConnectシステムのバージョン名 |
| powerstate | string | Yes |
電源状態 電源状態を示す文字列。 |
| hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"powerstate" : "OFF"
}
one-shot
スマートデバイスの電源を付ける。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| 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
スマートデバイスの電源を消す。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| 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
スマートデバイスが計測した瞬間電力量を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
| product | string | Yes |
DeviceConnectシステムの名前 |
| instantaneouspowervalue | float | Yes |
瞬間電力量 瞬間電力量を表す実数。単位はW。 |
| version | string | Yes |
DeviceConnectシステムのバージョン名 |
| hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"instantaneouspowervalue" : 38.4
}
one-shot
スマートデバイスが計測した積算電力量を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| date | dateTime | No | 取得日付。RFC 3339 例: 2014-01-01T00:00:00+0900 |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
| product | string | Yes |
DeviceConnectシステムの名前 |
| integratedpowervalue | array(float) | Yes |
積算電力量 サイズが24のnumberの配列。各値は積算電力量を表す実数。単位はWh。時間順に格納されているため、最初の要素は24時間前のもの。 例: リクエストで date=2015-08-24T15:14:00+0900 を指定した場合、0から23までの各インデックスに対応する時間帯は下記のとおり。 0 : 2015-08-23T15:00 ~ 15:59 : 23 :2015-08-24T14:00 ~ 14:59 |
| version | string | Yes |
DeviceConnectシステムのバージョン名 |
| hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"integratedpowervalue" : [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304 ]
}