スマートホーム充電器ガイド

action.devices.types.CHARGER - 充電器の操作には、充電の開始と停止、現在の充電レベル、残り容量、フル充電までの容量の確認などが含まれます。

このタイプのデバイスには充電器のアイコンが設定され、関連する類義語や別名が与えられます。

デバイスの機能

サービスがサポートする必要がある属性や状態、EXECUTE および QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。

必要なトレイト

デバイスに適用可能な場合は、これらのトレイトとコマンドが必要です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported のエラーコードを入力します。詳細については、エラーと例外をご覧ください。

品質要件

  • レイテンシ: 800 ミリ秒以下。
  • 信頼性: 97% 以上

デバイスの例: シンプルな充電器

このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「充電器」を表すインテント ペイロードの例を示します。実装でトレイトを追加または削除した場合は、それに合わせてレスポンスを変更し、変更を反映します。

SYNC レスポンスの例

リクエスト
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.CHARGER",
        "traits": [
          "action.devices.traits.EnergyStorage"
        ],
        "name": {
          "name": "Simple charger"
        },
        "willReportState": true,
        "attributes": {
          "isRechargeable": true,
          "queryOnlyEnergyStorage": false
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

QUERY レスポンスの例

リクエスト
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "descriptiveCapacityRemaining": "MEDIUM",
        "capacityRemaining": [
          {
            "unit": "PERCENTAGE",
            "rawValue": 50
          }
        ],
        "capacityUntilFull": [
          {
            "unit": "SECONDS",
            "rawValue": 3600
          }
        ],
        "isCharging": true
      }
    }
  }
}

EXECUTE コマンドの例

充電

コマンド パラメータの詳細については、 action.devices.traits.EnergyStorage リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Charge",
                "params": {
                  "charge": false
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "capacityRemaining": [
            {
              "unit": "PERCENTAGE",
              "rawValue": 50
            }
          ],
          "isCharging": false
        }
      }
    ]
  }
}

デバイスエラー

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