Battery - masaru-takano/DeviceConnect-Spec GitHub Wiki
スマートデバイスのバッテリー情報を提供するAPI。
| API | 概要 |
|---|---|
| GET /gotapi/battery | スマートデバイスのバッテリー情報を取得する。 |
| GET /gotapi/battery/charging | スマートデバイスの充電状態フラグを取得する。 |
| GET /gotapi/battery/chargingTime | スマートデバイスの充電完了時間を取得する。 |
| GET /gotapi/battery/dischargingTime | スマートデバイスの放電完了時間を取得する。 |
| GET /gotapi/battery/level | スマートデバイスのバッテリー残量を取得する。 |
| GET /gotapi/battery/onBatteryChange | スマートデバイスのバッテリー状態変化通知イベントを取得する。 |
| PUT /gotapi/battery/onBatteryChange | スマートデバイスのバッテリーの状態が変化したことを通知する。 |
| DELETE /gotapi/battery/onBatteryChange | 当該イベントの通知を停止する。 |
| GET /gotapi/battery/onChargingChange | スマートデバイスのバッテリー充電状態変化通知イベントを取得する。 |
| PUT /gotapi/battery/onChargingChange | スマートフォンもしくは周辺機器へ他方のスマートデバイスのバッテリーの充電状態が変化したことを通知する。 |
| DELETE /gotapi/battery/onChargingChange | 当該イベントの通知を停止する。 |
one-shot
スマートデバイスのバッテリー情報を取得する。
スマートデバイスのバッテリー情報として取得できない値がある場合は適切な値を代入してレスポンスを返却する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
| product | string | Yes | DeviceConnectシステムの名前。 |
| level | float | No |
バッテリー残量。 範囲: 0.0 <= level <= 1.0 |
| chargingTime | long | No |
完全充電までの時間(秒)。 満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。 |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
| charging | boolean | Yes |
充電状態フラグ。 充電中:true 非充電中:false |
| version | string | Yes | DeviceConnectシステムのバージョン名。 |
| dischargingTime | long | No |
完全放電までの時間(秒)。 充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"charging" : true,
"chargingTime" : 10,
"dischargingTime" : 0,
"level" : 0.8
}
one-shot
スマートデバイスの充電状態フラグを取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
| charging | boolean | Yes |
充電状態フラグ 充電中:true 非充電中:false |
| product | string | Yes | DeviceConnectシステムの名前。 |
| version | string | Yes | DeviceConnectシステムのバージョン名。 |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"charging" : true
}
one-shot
スマートデバイスの充電完了時間を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
| product | string | Yes | DeviceConnectシステムの名前。 |
| version | string | Yes | DeviceConnectシステムのバージョン名。 |
| chargingTime | long | Yes |
完全充電までの時間(秒)。 満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。 |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"chargingTime" : 10
}
one-shot
スマートデバイスの放電完了時間を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
| product | string | Yes | DeviceConnectシステムの名前。 |
| version | string | Yes | DeviceConnectシステムのバージョン名。 |
| dischargingTime | long | Yes |
完全放電までの時間(秒)。 充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。 |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"dischargingTime" : 0
}
one-shot
スマートデバイスのバッテリー残量を取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
| product | string | Yes | DeviceConnectシステムの名前。 |
| version | string | Yes | DeviceConnectシステムのバージョン名。 |
| level | float | Yes |
バッテリー残量。 範囲: 0.0 <= level <= 1.0 |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"level" : 0.8
}
one-shot
スマートデバイスのバッテリー状態変化通知イベントを取得する。
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| serviceId | string | Yes | サービスID。取得対象スマートデバイス |
| 物理名 | データ型 | 必須 | 説明 | |
|---|---|---|---|---|
| result | integer | Yes | 0:正常応答 0以外:異常応答 |
|
| product | string | Yes | DeviceConnectシステムの名前。 | |
| battery | object | Yes | ||
| chargingTime | long | Yes |
完全充電までの時間(秒)。 満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。 |
|
| dischargingTime | long | Yes |
完全放電までの時間(秒)。 充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。 |
|
| level | float | Yes |
バッテリー残量。 範囲: 0.0 <= level <= 1.0 |
|
| version | string | Yes | DeviceConnectシステムのバージョン名。 | |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 | |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"battery" : {
"chargingTime" : 10,
"dischargingTime" : 0,
"level" : 0.8
}
}
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"
}
| 物理名 | データ型 | 必須 | 説明 | |
|---|---|---|---|---|
| attribute | string | Yes | アトリビュート名。 | |
| serviceId | string | Yes | 0:正常応答 0以外:異常応答 |
|
| interface | string | Yes | インターフェース名。 | |
| battery | object | Yes | ||
| chargingTime | long | Yes |
完全充電までの時間(秒)。 満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。 |
|
| dischargingTime | long | Yes |
完全放電までの時間(秒)。 充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。 |
|
| level | float | Yes |
バッテリー残量。 範囲: 0.0 <= level <= 1.0 |
|
| profile | string | Yes | プロファイル名。 | |
{
"serviceId" : "example-service-id",
"profile" : "battery",
"attribute" : "onBatteryChange",
"battery" : {
"chargingTime" : 10,
"dischargingTime" : 0,
"level" : 0.8
}
}
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システムの名前。 | |
| battery | object | Yes | ||
| charging | boolean | Yes |
充電状態フラグ 充電中:true 非充電中:false |
|
| version | string | Yes | DeviceConnectシステムのバージョン名。 | |
| hmac | string | No | レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。 | |
{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"battery" : {
"charging" : true
}
}
event
スマートフォンもしくは周辺機器へ他方のスマートデバイスのバッテリーの充電状態が変化したことを通知する。
充電中フラグの値がtrueからfalse、もしくは、falseからtrueへ変わった時にイベントが発行される。
| 物理名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| 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"
}
| 物理名 | データ型 | 必須 | 説明 | |
|---|---|---|---|---|
| attribute | string | Yes | アトリビュート名。 | |
| serviceId | string | Yes | 0:正常応答 0以外:異常応答 |
|
| interface | string | Yes | インターフェース名。 | |
| battery | object | Yes | ||
| charging | boolean | Yes |
充電状態フラグ 充電中:true 非充電中:false |
|
| profile | string | Yes | プロファイル名。 | |
{
"serviceId" : "example-service-id",
"profile" : "battery",
"attribute" : "onChargingChange",
"battery" : {
"charging" : true
}
}
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"
}