Smart Home Security System Guide

Device TYPE

action.devices.types.SECURITYSYSTEM Security systems can be armed and disarmed. They can be armed at multiple security levels (for example, home and away). Disarming a security system is a sensitive action which may require two-factor authentication. See Two-factor authentication.

This type indicates that the device gets the security system icon and some synonyms/aliases.

These are our recommendations for traits on this type of device, however you are free to mix and match from all available traits to best match your existing product functionality.

Please see each individual trait document for implementation details like required attributes, EXECUTE and QUERY.

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.jsResponse
'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.SECURITYSYSTEM',
        traits: [
          'action.devices.traits.ArmDisarm',
          'action.devices.traits.StatusReport'
        ],
        name: {
          defaultNames: ['Maldives Security System'],
          name: 'Security System',
          nicknames: []
        },
        willReportState: true,
        attributes: {
          availableArmLevels: {
            levels: [{
              level_name: 'L1',
              level_values: [{
                level_synonym: ['home and guarding', 'SL1'],
                lang: 'en'
              }, {
                level_synonym: ['zuhause und bewachen', 'SL1'],
                lang: 'de'
              }]
            }, {
              level_name: 'L2',
              level_values: [{
                level_synonym: ['away and guarding', 'SL2'],
                lang: 'en'
              }, {
                level_synonym: ['weg und bewachen', 'SL2'],
                lang: 'de'
              }]
            }],
            ordered: true
          }
        },
        deviceInfo: {
          manufacturer: 'Maldives Security Corporation',
          model: '442',
          hwVersion: '3.2',
          swVersion: '11.4'
        },
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: 'lambtwirl'
        }
      }]
    }
  };
});

// ...

exports.smarthome = functions.https.onRequest(app);
JavaResponse
@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.SECURITYSYSTEM")
          .addTrait("action.devices.traits.ArmDisarm")
          .setName(
              Collections.singletonList("Maldives Security System"),
              "security system",
              Collections.emptyList()
          )
          .setWillReportState(true)
          .setAttributes(new JSONObject()
              .put("availableArmLevels", new JSONObject()
                  .put("levels", new JSONObject[] {
                      new JSONObject()
                          .put("level_name", "L1")
                          .put("level_values", new JSONObject[] {
                          new JSONObject()
                              .put("level_synonym", new String[] {"home and guarding", "SL1"})
                              .put("lang", "en"),
                          new JSONObject()
                              .put("level_synonym", new String[] {
                                  "zuhause und bewachen",
                                  "SL1"
                              })
                              .put("lang", "de")
                      }),
                      new JSONObject()
                          .put("level_name", "L2")
                          .put("level_values", new JSONObject[] {
                          new JSONObject()
                              .put("level_synonym", new String[] {"away and guarding", "SL2"})
                              .put("lang", "en"),
                          new JSONObject()
                              .put("level_synonym", new String[] {"weg und bewachen", "SL2"})
                              .put("lang", "de")
                      })
                  })
                  .put("ordered", true)
              )
          )
          .setDeviceInfo("sirius", "442", "3.2", "11.4")
          .setCustomData(new JSONObject()
              .put("fooValue", 74)
              .put("barValue", true)
              .put("bazValue", "lambtwirl")
              .toString()
          )
          .build()
  });
  return new SyncResponse(syncRequest.getRequestId(), payload);
}
JSONResponse
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "123456789",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.SECURITYSYSTEM",
        "traits": [
          "action.devices.traits.ArmDisarm",
          "action.devices.traits.StatusReport"
        ],
        "name": {
          "defaultNames": [
            "Maldives Security System"
          ],
          "name": "Security System",
          "nicknames": []
        },
        "willReportState": true,
        "attributes": {
          "availableArmLevels": {
            "levels": [
              {
                "level_name": "L1",
                "level_values": [
                  {
                    "level_synonym": [
                      "home and guarding",
                      "SL1"
                    ],
                    "lang": "en"
                  },
                  {
                    "level_synonym": [
                      "zuhause und bewachen",
                      "SL1"
                    ],
                    "lang": "de"
                  }
                ]
              },
              {
                "level_name": "L2",
                "level_values": [
                  {
                    "level_synonym": [
                      "away and guarding",
                      "SL2"
                    ],
                    "lang": "en"
                  },
                  {
                    "level_synonym": [
                      "weg und bewachen",
                      "SL2"
                    ],
                    "lang": "de"
                  }
                ]
              }
            ],
            "ordered": true
          }
        },
        "deviceInfo": {
          "manufacturer": "Maldives Security Corporation",
          "model": "442",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.