We want to hear your thoughts on the Google Smart Home platform. Join a user study and receive a gift for your input. Click here to sign up.

Smart Home Carbon Monoxide Detector Guide

Device TYPE

action.devices.types.CARBON_MONOXIDE_DETECTOR Carbon monoxide detectors may report whether carbon monoxide is currently detected, whether the carbon monoxide level is high, and the current carbon monoxide level in parts per million.

This type indicates that the device gets carbon monoxide detector type synonyms/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: body.requestId,
    payload: {
      agentUserId: '1836.15267389',
      devices: [{
        id: '123',
        type: 'action.devices.types.CARBON_MONOXIDE_DETECTOR',
        traits: [
          'action.devices.traits.SensorState'
        ],
        name: {
          defaultNames: ['Carbon Monoxide Detector'],
          name: 'ACME Carbon Monoxide Detector',
          nicknames: ['Garage Carbon Monoxide Detector']
        },
        willReportState: true,
        attributes: {
          sensorStatesSupported: [{
            name: 'CarbonMonoxideLevel',
            descriptiveCapabilities: {
              availableStates: [
                'carbon monoxide detected',
                'high',
                'no carbon monoxide detected'
              ]
            },
            numericCapabilities: {
              rawValueUnit: 'PARTS_PER_MILLION'
            }
          }]
        },
        deviceInfo: {
          manufacturer: 'ACME',
          model: '492134',
          hwVersion: '3.2',
          swVersion: '11.4'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
Java
@NotNull
@Override
@SmartHomeSnippetJson("smart-home-types-carbonmonoxidedetector_sync.json")
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.CARBON_MONOXIDE_DETECTOR")
            .addTrait("action.devices.traits.SensorState")
            .setName(
                Collections.singletonList("Carbon Monoxide Detector"),
                "ACME Carbon Monoxide Detector",
                Collections.singletonList("Garage Carbon Monoxide Detector"))
            .setWillReportState(true)
            .setAttributes(
                new JSONObject()
                    .put(
                        "sensorStatesSupported",
                        new JSONObject[] {
                          new JSONObject()
                              .put("name", "CarbonMonoxideLevel")
                              .put(
                                  "descriptiveCapabilities",
                                  new JSONObject()
                                      .put(
                                          "availableStates",
                                          new String[] {
                                            "carbon monoxide detected",
                                            "high",
                                            "no carbon monoxide detected"
                                          }))
                              .put(
                                  "numericCapabilities",
                                  new JSONObject().put("rawValueUnit", "PARTS_PER_MILLION"))
                        }))
            .setDeviceInfo("ACME", "492134", "3.2", "11.4")
            .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.CARBON_MONOXIDE_DETECTOR",
        "traits": [
          "action.devices.traits.SensorState"
        ],
        "name": {
          "defaultNames": [
            "Carbon Monoxide Detector"
          ],
          "name": "ACME Carbon Monoxide Detector",
          "nicknames": [
            "Garage Carbon Monoxide Detector"
          ]
        },
        "willReportState": true,
        "attributes": {
          "sensorStatesSupported": [
            {
              "name": "CarbonMonoxideLevel",
              "descriptiveCapabilities": {
                "availableStates": [
                  "carbon monoxide detected",
                  "high",
                  "no carbon monoxide detected"
                ]
              },
              "numericCapabilities": {
                "rawValueUnit": "PARTS_PER_MILLION"
              }
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "ACME",
          "model": "492134",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.