スマートホームの EnergyStorage トレイトのスキーマ

action.devices.traits.EnergyStorage - このトレイトは、電池にエネルギーを蓄えて再充電できるデバイス、または別のデバイスを充電できるデバイスに使用します。

デバイスの属性

このトレイトを持つデバイスは、SYNC オペレーションの一部として次の属性を報告できます。SYNC インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
queryOnlyEnergyStorage ブール値

必須。

このデバイスが、貯蔵されたエネルギーのレベル(オプションとして isRechargeable 属性に応じてアクティブな充電状態)に関するクエリのみをサポートするが、充電の開始と停止をサポートしない場合は true。

energyStorageDistanceUnitForUX String

(デフォルト: "KILOMETERS"

ユーザーへのレスポンスで使用されます。

サポートされている値:

KILOMETERS
MILES
isRechargeable ブール値

(デフォルト: false

このデバイスが充電式の場合は true に設定します。これは、デバイスが capacityUntilFullisCharging の状態(オプションで isPluggedIn の状態)を報告する場合があり、またデバイスでは Charge コマンドを使用できることを示します。

充電式デバイス

{
  "isRechargeable": true,
  "queryOnlyEnergyStorage": false
}

現在のバッテリー残量をマイルで表示する充電式デバイス

{
  "isRechargeable": true,
  "energyStorageDistanceUnitForUX": "MILES",
  "queryOnlyEnergyStorage": false
}

現在の充電レベルのレポートのみをサポートする充電不可のデバイス

{
  "isRechargeable": false,
  "queryOnlyEnergyStorage": true
}

デバイスのステータス

このトレイトを持つエンティティは、QUERY オペレーションの一部として次の状態を報告できます。QUERY インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

タイプ 説明
descriptiveCapacityRemaining String

必須。

エネルギー容量レベルの定性的表現。これは、数値容量データが存在しない場合に使用されます。数値容量データも使用可能な場合は、可能な限り説明よりも優先されます。

サポートされている値:

CRITICALLY_LOW
LOW
MEDIUM
HIGH
FULL
capacityRemaining 配列

デバイスが現在保持しているエネルギー容量に関する情報が格納される単位/値のペアの配列。たとえば、「<device> はあと何マイル走れる?」や「<device> の充電率は何パーセントですか?」などです。

[item, ...] オブジェクト

単位と値のペアで表した残り容量。

rawValue 整数

必須。

容量の値。

unit String

必須。

容量単位。

サポートされている値:

SECONDS
MILES
KILOMETERS
PERCENTAGE
KILOWATT_HOURS
capacityUntilFull 配列

デバイスがフル充電されるまでの容量に関する情報が格納される単位と値のペアの配列。例: <デバイス> がフル充電されるまでの時間はどのくらいですか?

[item, ...] オブジェクト

充電されるまでの容量。

rawValue 整数

必須。

容量の値。

unit String

必須。

容量単位。

サポートされている値:

SECONDS
MILES
KILOMETERS
PERCENTAGE
KILOWATT_HOURS
isCharging ブール値

デバイスが現在充電中かどうか。

isPluggedIn ブール値

デバイスが現在コンセントにつながれているかどうか。デバイスはコンセントにつながれていても、充電中ではない可能性があります。

充電式デバイス

{
  "descriptiveCapacityRemaining": "HIGH",
  "capacityRemaining": [
    {
      "rawValue": 36000,
      "unit": "SECONDS"
    },
    {
      "rawValue": 90,
      "unit": "PERCENTAGE"
    }
  ],
  "capacityUntilFull": [
    {
      "rawValue": 120,
      "unit": "SECONDS"
    }
  ],
  "isCharging": true,
  "isPluggedIn": true
}

現在のバッテリー残量をマイルで表示する充電式デバイス

{
  "descriptiveCapacityRemaining": "CRITICALLY_LOW",
  "capacityRemaining": [
    {
      "rawValue": 12,
      "unit": "MILES"
    }
  ],
  "capacityUntilFull": [
    {
      "rawValue": 6000,
      "unit": "SECONDS"
    }
  ],
  "isCharging": true,
  "isPluggedIn": true
}

現在の充電レベルのレポートのみをサポートする充電不可のデバイス

{
  "descriptiveCapacityRemaining": "LOW"
}

デバイスのコマンド

このトレイトを持つデバイスは、EXECUTE オペレーションの一部として次のコマンドに応答できます。EXECUTE インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

action.devices.commands.Charge

充電を開始または停止します。

このコマンドには次の属性が必要です。
{
  "isRechargeable": true
}

パラメータ

パラメータ タイプ 説明
charge ブール値

必須。

充電を開始する場合は true、充電を停止する場合は false。

充電開始コマンド

{
  "command": "action.devices.commands.Charge",
  "params": {
    "charge": true
  }
}

充電停止コマンド

{
  "command": "action.devices.commands.Charge",
  "params": {
    "charge": false
  }
}

デバイスエラー

エラーと例外の全リストをご覧ください。

deviceUnplugged: コンセントにつながれていないデバイスを充電しようとしました。