PowerMeter - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki
スマートデバイスが計測した電力を取得する機能を提供するAPI。
| API | 概要 |
|---|---|
| GET /gotapi/powerMeter | スマートデバイスの電源状態を取得する。 |
| PUT /gotapi/powerMeter | スマートデバイスの電源をONにする。 |
| DELETE /gotapi/powerMeter | スマートデバイスの電源を消す。 |
| GET /gotapi/powerMeter/instantaneousCurrent | スマートデバイスが計測した瞬時電流量を取得する。 |
| GET /gotapi/powerMeter/instantaneousPower | スマートデバイスが計測した瞬時電力量を取得する。 |
| GET /gotapi/powerMeter/integratedPower | スマートデバイスが計測した積算電力量を取得する。 |
one-shot
スマートデバイスの電源状態を取得する。
状態が不明の場合はUNKNOWNを返す。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 論理名 | 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
| 電源状態 | powerstatus | string | Yes | 電源状態を示す文字列。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"powerstatus" : "OFF"
}
one-shot
スマートデバイスの電源をONにする。
既にONの場合はエラーを返す。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| 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
スマートデバイスの電源を消す。
既にOFFの場合はエラーを返す。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| 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
スマートデバイスが計測した瞬時電流量を取得する。
スマートデバイス側の計測値が仕様に合わない場合、 可能な限りデバイスプラグイン側でDeviceConnectに合わせた正規化を行うこと。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。 取得対象スマートデバイス |
| unit | string | No | 瞬時電流量単位。瞬時電流量の単位を指定。 例： 'mA' 'A' 省略時は'A' |
| 論理名 | 物理名 | データ型 | 必須 | 説明 | |
|---|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
|
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 | |
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 | |
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
|
| 瞬時電流量 | instantaneouscurrent | object | Yes | 瞬時電流量を表す実数。単位はパラメータによる。 | |
| R相瞬時電流量 | rphase | double | Yes | R相の瞬時電流量を表す実数。 | |
| T相瞬時電流量 | tphase | double | No | T相の瞬時電流量を表す実数。単相の場合は省略。 | |
| 瞬時電流量単位 | unit | string | Yes | 瞬時電流量の単位を表す。 例：'mA' 'A' |
|
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"instantaneouscurrent" : {
"rphase" : 1234.5,
"tphase" : -2345.6,
"unit" : "mA"
}
}
one-shot
スマートデバイスが計測した瞬時電力量を取得する。
スマートデバイス側の計測値が仕様に合わない場合、 可能な限りデバイスプラグイン側でDeviceConnectに合わせた正規化を行うこと。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。 取得対象スマートデバイス |
| unit | string | No | 瞬時電力量単位。瞬時電力量の単位を指定。 例： 'W' 'kW' 省略時は'W' |
| 論理名 | 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
| 瞬時電力量 | instantaneouspower | double | Yes | 瞬時電力量を表す実数。単位はパラメータ設定による。 |
| 瞬時電力量単位 | unit | string | Yes | 瞬時電力量の単位を表す。 例：'W' 'kW' |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"instantaneouspower" : 38.4,
"unit" : "W"
}
one-shot
スマートデバイスが計測した積算電力量を取得する。
指定した日時から過去24時間分の計測値を24または48分割して返す。
（1時間または30分ごとの値を返す。）
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。 取得対象スマートデバイス |
| date | dateTime | No | 取得日付。 RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」形式 省略時はAPI実行日時が指定される |
| unit | string | No | 積算電力量単位。積算電力量の単位を指定。 省略時は'Wh' |
| count | integer | No | 積算電力量コマ数。24時間分の積算電力量を指定数で返す。 24: 24分割＝１時間単位（デフォルト） 48: 48分割＝30分単位 |
| powerFlow | string | No | 積算電力量方向指定。取得する積算電力量の方向を指定。 normal : 正方向 reverse : 逆方向 省略時はnormal (正方向) |
| 論理名 | 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|---|
| 処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
| システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
| システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
| 署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
| 積算電力量 | integratedpower | array(double) | Yes | 24時間分の計測値を返す。 サイズが24または48のnumberの配列。各値は積算電力量を表す実数。 単位はパラメーター設定による。 時間順に格納されているため、最初の要素は24時間前のもの。 例: リクエストで date=2015-08-24T15:14:00+0900, count=24を指定した場合、 0から23までの各インデックスに対応する時間帯は下記のとおり。 0 : 2015-08-23T15:00 ~ 15:59 : 23 :2015-08-24T14:00 ~ 14:59 |
| 積算電力量単位 | unit | string | Yes | 積算電力量の単位を表す。例：'Wh' 'kWh' |
| 積算電力量コマ数 | count | integer | Yes | 積算電力量コマ数（24または48） |
| 積算電力量方向 | powerFlow | string | Yes | 積算電力量方向を表す。 'normal' 'reverse' |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"integratedpower" : [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 ],
"unit" : "Wh",
"count" : 24,
"powerFlow" : "normal"
}