Smart Home Charger Guide

Device TYPE

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 synonyms and aliases.

These traits are recommended, if applicable to your device. However, you are free to mix and match from all available traits to best match your existing product functionality.

Sample SYNC Request and Response

This is an example using the device type and traits above. It is intended to give an idea of how to build a SYNC response. If you add or remove traits, this will need to be modified to reflect those changes.

Request
{
    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
    }]
}
Node.js
'use strict';

const {smarthome} = require('actions-on-google');
const functions = require('firebase-functions');

const app = smarthome();

app.onSync((body, headers) => {
  return {
    requestId: "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    payload: {
      agentUserId: "1836.15267389",
      devices: [{
        id: "123",
        type: "action.devices.types.CHARGER",
        traits: [
          "action.devices.traits.EnergyStorage"
        ],
        name: {
          name: "Rechargable Device",
        },
        willReportState: true,
        attributes: {
          isRechargeable: true,
          queryOnlyEnergyStorage: false
        },
        deviceInfo: {
          manufacturer: "ACME Inc.",
          model: "GIZMO-R",
          hwVersion: "PVT-2",
          swVersion: "1.0.1"
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  Payload payload = new Payload();
  payload.setAgentUserId("1836.15267389");
  payload.setDevices(
      new Device[] {
        new Device.Builder()
            .setId("123")
            .setType("action.devices.types.CHARGER")
            .addTrait("action.devices.traits.EnergyStorage")
            .setName(Collections.emptyList(), "Rechargable Device", Collections.emptyList())
            .setWillReportState(true)
            .setAttributes(
                new JSONObject().put("isRechargeable", true).put("queryOnlyEnergyStorage", false))
            .setDeviceInfo("ACME Inc.", "GIZMO-R", "PVT-2", "1.0.1")
            .build()
      });
  return new SyncResponse(syncRequest.getRequestId(), payload);
}
JSON
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.CHARGER",
        "traits": [
          "action.devices.traits.EnergyStorage"
        ],
        "name": {
          "name": "Rechargable Device"
        },
        "willReportState": true,
        "attributes": {
          "isRechargeable": true,
          "queryOnlyEnergyStorage": false
        },
        "deviceInfo": {
          "manufacturer": "ACME Inc.",
          "model": "GIZMO-R",
          "hwVersion": "PVT-2",
          "swVersion": "1.0.1"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.