Smart Home Carbon Monoxide Detector Guide

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 the Carbon Monoxide Detector 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 1000ms.
  • Reliability: must be more than or equal to 97%.

Example device: Simple carbon monoxide detector

This section contains example intent payloads representing a common "Carbon Monoxide Detector" 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.CARBON_MONOXIDE_DETECTOR",
        "traits": [
          "action.devices.traits.SensorState"
        ],
        "name": {
          "name": "Simple 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": "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,
        "currentSensorStateData": [
          {
            "name": "CarbonMonoxideLevel",
            "currentSensorState": "high",
            "rawValue": 200
          }
        ]
      }
    }
  }
}

Device ERRORS

See the full list of errors and exceptions.