Smart Home Charger Guide

action.devices.types.CHARGER - Interactions with chargers may include starting and stopping charging, and checking the current charge level, capacity remaining, and capacity until full values.

This type indicates that the device gets the Charger icon and some related synonyms and aliases.

Device capabilities

Refer to the corresponding trait documentation for implementation details, such as attributes and states that your service should support, and how to build EXECUTE and QUERY responses.

Required traits

These traits and commands are required, if applicable to your device.

Quality requirements

  • Latency: must be less than or equal to 800ms.
  • Reliability: must be more than or equal to 97%.

Example device: Simple charger

This section contains example intent payloads representing a common "Charger" based on the device type and traits above. If you add or remove traits in your implementation, modify your responses accordingly to reflect those changes.

Sample SYNC response

Request
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Response
{
  "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"
        }
      }
    ]
  }
}

Sample QUERY response

Request
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "descriptiveCapacityRemaining": "MEDIUM",
        "capacityRemaining": [
          {
            "unit": "PERCENTAGE",
            "rawValue": 50
          }
        ],
        "capacityUntilFull": [
          {
            "unit": "SECONDS",
            "rawValue": 3600
          }
        ],
        "isCharging": true
      }
    }
  }
}

Sample EXECUTE commands

Charge

For additional details on the command parameters, see the action.devices.traits.EnergyStorage reference.

Request
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Charge",
                "params": {
                  "charge": false
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "capacityRemaining": [
            {
              "unit": "PERCENTAGE",
              "rawValue": 50
            }
          ],
          "isCharging": false
        }
      }
    ]
  }
}

Device ERRORS

See the full list of errors and exceptions.