Skip to content

Battery Profile

Jump to bottom
Ryo Mizuno edited this page Nov 2, 2016 · 3 revisions

目次

API 機能概要
Battery Status API スマートデバイスのバッテリー情報を取得する。
Battery Status Charging API スマートデバイスの充電状態フラグを取得する。
Battery Status Charging Time API スマートデバイスの充電完了時間を取得する。
Battery Status Discharging Time API スマートデバイスの放電完了時間を取得する。
Battery Status Level API スマートデバイスのバッテリー残量を取得する。
Battery Status Charging Change Event API スマートデバイスの充電状態変化通知を受領する。
Battery Status Change Event API スマートデバイスのバッテリー状態変化通知を受領する。

機能概要

スマートデバイスのバッテリー情報を提供するAPI。

参考API

http://www.w3.org/TR/2012/CR-battery-status-20120508/

Battery Status API

インターフェース名称 Version 種別
Battery Status API 2.0.0 同期I/F

概要

スマートデバイスのバッテリー情報を取得する。 スマートデバイスのバッテリー情報として取得できない値がある場合は適切な値を代入してレスポンスを返却する。

リクエスト

HTTPメソッド URI
GET /gotapi/battery
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
充電中フラグ charging boolean - 充電状態フラグ。
充電中:true
非充電中:false
充電時間 chargingTime number - 完全充電までの時間(秒) 満充電、もしくは、非充電中の場合は0 システムとして取得出来ない場合はNumber.MAX_VALUE
放電時間 dischargingTime number - 完全放電までの時間(秒)充電中、もしくは、システムとして取得出来ない場合はNumber.MAX_VALUE
バッテリー残量 level number - バッテリー残量をパーセンテージで示す。
範囲 0.0 <= level <= 1.0

リクエストサンプル

GET http://localhost:4035/gotapi/battery?servieId=localhost.dconnect.com&accessToken=xxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "result": 0,
    "charging": true,
    "chargingTime": 3600,
    "dischargingTime": 3600,
    "level": 0.5
}

Battery Status Charging API

インターフェース名称 Version 種別
Battery Status Charging API 2.0.0 同期I/F

概要

スマートデバイスの充電状態を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/battery/charging
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
属性値 charging boolean - 充電状態フラグ
充電中:true
非充電中:false

リクエストサンプル

GET http://localhost:4035/gotapi/battery/charging?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "result": 0,
    "charging": true
}

Battery Status Charging Time API

インターフェース名称 Version 種別
Battery Status Charging Time API 2.0.0 同期I/F

概要

スマートデバイスのバッテリーの充電状態を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/battery/chargingTime
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
充電時間 chargingTime boolean - 完全充電までの時間(秒) 満充電、もしくは、非充電中の場合は0 システムとして取得出来ない場合はNumber.MAX_VALUE

リクエストサンプル

GET http://localhost:4035/gotapi/battery/chargingTime?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "result": 0,
    "chargingTime": 3600
}

Battery Status Discharging Time API

インターフェース名称 Version 種別
Battery Status Discharging Time API 2.0.0 同期I/F

概要

スマートデバイスのバッテリーの完全放電までの時間を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/battery/dischargingTime
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
API名 api string - gotapi

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
放電時間 dischargingTime number - 完全放電までの時間(秒)充電中、もしくは、システムとして取得出来ない場合はNumber.MAX_VALUE

リクエストサンプル

GET http://localhost:4035/gotapi/battery/dischargingTime?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "result": 0,
    "dischargingTime": 3600
}

Battery Status Level API

インターフェース名称 Version 種別
Battery Status Level API 2.0.0 同期I/F

概要

スマートデバイスのバッテリー残量を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/battery/level
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
属性値 level number - バッテリー残量をパーセンテージで示す。
範囲 0.0 <= level <= 1.0

リクエストサンプル

GET http://localhost:4035/gotapi/battery/level?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "result": 0,
    "level": 0.5
}

Battery Status Charging Change Event API

インターフェース名称 Version 種別
Battery Status Charging Change Event API 2.0.0 同期I/F

概要

スマートフォンもしくは周辺機器へ他方のスマートデバイスのバッテリーの充電状態が変化したことを通知する。 充電中フラグの値がtrueからfalse、もしくは、falseからtrueへ変わった時にイベントが発行される。

イベント情報

イベント名 Content-Type
/gotapi/battery/onChargingChange application/json

メッセージ

<td>オブジェクト</td>
<td colspan="2" text-align="center">battery</td>
<td>object</td>
<td>-</td>
<td>バッテリー情報</td>

<td>充電中フラグ</td>
<td ></td>
<td >charging</td>
<td>boolean</td>
<td>-</td>
<td>充電状態フラグ。<br>充電中:true<br非充電中:false</td>
論理名 物理名 データ型 省略 設定値

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "servieId":  "device1.localhost.deviceconnect.org",
    "profile" : "battery",
    "attribute" : "onChargingChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "battery" : {
        "charging": true
    }
}

Battery Status Change Event API

インターフェース名称 Version 種別
Battery Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのバッテリーの状態が変化したことを通知する。 充電時間、放電時間、バッテリー残量の値が変わった時にイベントが発行される。

イベント情報

イベント名 Content-Type
/gotapi/battery/onBatteryChange application/json

メッセージ

<td>オブジェクト</td>
<td colspan="2" text-align="center">battery</td>
<td>object</td>
<td>-</td>
<td>バッテリー情報</td>

<td>充電時間</td>
<td rowspan=3></td>
<td >chargingTime</td>
<td>number</td>
<td>-</td>
<td>完全充電までの時間(秒)</td>

<td>放電時間</td>
<td >dischargingTime</td>
<td>number</td>
<td>-</td>
<td>完全放電までの時間(秒)</td>

<td>バッテリー残量</td>
<td >level</td>
<td>number</td>
<td>-</td>
<td>バッテリー残量をパーセンテージで示す。<br>範囲 0.0 <= level <= 1.0</td>
論理名 物理名 データ型 省略 設定値

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
        "servieId":  "device1.localhost.deviceconnect.org",
    "profile" : "battery",
    "attribute" : "onBatteryChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "battery" : {
        "chargingTime": 3600,
        "dischargintTime": 3600,
        "level" : 0.5
    }
}
  1. アプリケーション開発マニュアル
  2. 単体テスト動作マニュアル

Clone this wiki locally