Smart Home Smoke Detector Guide

Device TYPE

action.devices.types.SMOKE_DETECTOR Smoke detectors can report whether smoke is currently detected, whether the smoke level is high, and the current smoke level in parts per million.

This type indicates that the device gets the smoke detector icon and some synonyms.

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: body.requestId,
    payload: {
      agentUserId: '123456789',
      devices: [{
        id: '123',
        type: 'action.devices.types.SMOKE_DETECTOR',
        traits: [
          'action.devices.traits.SensorState'
        ],
        name: {
          defaultNames: ['Smoke Detector'],
          name: 'SmokeLevel',
          nicknames: ['Kitchen Smoke Detector']
        },
        willReportState: true,
        attributes: {
          sensorStatesSupported: [{
            name: 'SmokeLevel',
            descriptiveCapabilities: {
              availableStates: [
                'smoke detected',
                'high',
                'no smoke detected'
              ]
            },
            numericCapabilities: {
              rawValueUnit: 'PARTS_PER_MILLION'
            }
          }]
        },
        deviceInfo: {
          manufacturer: 'Sirius Cybernetics Corporation',
          model: '442',
          hwVersion: '3.2',
          swVersion: '11.4'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
@SmartHomeSnippetJson("smart-home-types-smokedetector_sync.json")
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) {
  Payload payload = new Payload();
  payload.setAgentUserId("123456789");

  payload.setDevices(
      new Device[] {
        new Device.Builder()
            .setId("123")
            .setType("action.devices.types.SMOKE_DETECTOR")
            .addTrait("action.devices.traits.SensorState")
            .setName(
                Collections.singletonList("Smoke Detector"),
                "SmokeLevel",
                Collections.singletonList("Kitchen Smoke Detector"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put(
                        "sensorStatesSupported",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "SmokeLevel")
                              .put(
                                  "descriptiveCapabilities",
                                  new JSONObject()
                                      .put(
                                          "availableStates",
                                          new String[] {
                                            "smoke detected", "high", "no smoke detected"
                                          }))
                              .put(
                                  "numericCapabilities",
                                  new JSONObject().put("rawValueUnit", "PARTS_PER_MILLION"))
                        }))
            .setDeviceInfo("Sirius Cybernetics Corporation", "442", "3.2", "11.4")
            .build()
      });

  return new SyncResponse(syncRequest.getRequestId(), payload);
}
JSON
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "123456789",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.SMOKE_DETECTOR",
        "traits": [
          "action.devices.traits.SensorState"
        ],
        "name": {
          "defaultNames": [
            "Smoke Detector"
          ],
          "name": "SmokeLevel",
          "nicknames": [
            "Kitchen Smoke Detector"
          ]
        },
        "willReportState": true,
        "attributes": {
          "sensorStatesSupported": [
            {
              "name": "SmokeLevel",
              "descriptiveCapabilities": {
                "availableStates": [
                  "smoke detected",
                  "high",
                  "no smoke detected"
                ]
              },
              "numericCapabilities": {
                "rawValueUnit": "PARTS_PER_MILLION"
              }
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "Sirius Cybernetics Corporation",
          "model": "442",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.