Smart Home Freezer Guide

action.devices.types.FREEZER - Freezers are temperature-managing devices which may be adjusted to various mode settings, and may allow temperature monitoring.

This type indicates that the device gets the Freezer 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. If your device does not support these traits, enter the error code of functionNotSupported in a QUERY or EXECUTE response. See Errors and exceptions for more info.

Quality requirements

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

Example device: Simple freezer

This section contains example intent payloads representing a common "Freezer" 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.FREEZER",
        "traits": [
          "action.devices.traits.TemperatureControl"
        ],
        "name": {
          "name": "Simple freezer"
        },
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": -10,
            "maxThresholdCelsius": 5
          },
          "temperatureUnitForUX": "C"
        },
        "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,
        "temperatureSetpointCelsius": 0,
        "temperatureAmbientCelsius": 2
      }
    }
  }
}

Sample EXECUTE commands

SetTemperature

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

Request
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 0
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Response
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 0,
          "temperatureAmbientCelsius": 2
        }
      }
    ]
  }
}

Device ERRORS

See the full list of errors and exceptions.