Battery - TakayukiHoshi1984/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システムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false
完全充電までの時間 (秒)	chargingTime	long	No	満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。
完全放電までの時間 (秒)	dischargingTime	long	No	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE
バッテリー残量	level	float	No	範囲: 0.0 <= level <= 1.0

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "charging" : true,
  "chargingTime" : 10,
  "dischargingTime" : 0,
  "level" : 0.8
}

one-shot

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

充電中:true
非充電中:false

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

{
  "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システムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
完全充電までの時間 (秒)	chargingTime	long	Yes	満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。

{
  "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システムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
完全放電までの時間 (秒)	dischargingTime	long	Yes	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "dischargingTime" : 0
}

one-shot

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

スマートデバイスのバッテリー残量は0.0〜1.0の範囲で返す。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー残量	level	float	Yes	範囲: 0.0 <= level <= 1.0

{
  "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システムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー情報		battery	object	Yes
	完全充電までの時間 (秒)	chargingTime	long	Yes	満充電、または非充電中の場合は0。 システムとして取得出来ない場合はNumber.MAX_VALUE。
	完全放電までの時間 (秒)	dischargingTime	long	Yes	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
	バッテリー残量	level	float	Yes	範囲: 0.0 <= level <= 1.0

{
  "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"
}

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	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

{
  "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システムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー情報		battery	object	Yes
	充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

{
  "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"
}

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
バッテリー情報		battery	object	Yes
	充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

{
  "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"
}