Smart Home Camera Guide

Device TYPE

action.devices.types.CAMERA Cameras are complex and features will vary significantly between vendors. Over time, cameras will acquire many traits and attributes describing specific capabilities, many of which may interact with the video/audio stream in special ways, such as sending a stream to another device, identifying what's in the stream, replaying feeds, etc. As such, cameras also interact with other devices - especially screens and other media targets.

action.devices.traits.CameraStream - This trait enables the device to provide a real-time stream to a media destination; capabilities are defined in the attributes.

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: '1836.15267389',
      devices: [{
        id: '123',
        type: 'action.devices.types.CAMERA',
        traits: [
          'action.devices.traits.CameraStream'
        ],
        name: {
          defaultNames: ['Sirius Cybernetics Corporation 3000'],
          name: 'Front Camera',
          nicknames: ['Camera']
        },
        willReportState: false,
        attributes: {
          cameraStreamSupportedProtocols: ['hls', 'dash'],
          cameraStreamNeedAuthToken: true,
          cameraStreamNeedDrmEncryption: false
        },
        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) {
  SyncResponse.Payload payload = new SyncResponse.Payload();
  payload.setAgentUserId("1836.15267389");
  payload.setDevices(new SyncResponse.Payload.Device[] {
      new SyncResponse.Payload.Device.Builder()
          .setId("123")
          .setType("action.devices.types.CAMERA")
          .addTrait("action.devices.traits.CameraStream")
          .setName(
              Collections.singletonList("Sirius Corporation 3000"),
              "Front camera",
              Collections.singletonList("Camera")
          )
          .setWillReportState(false)
          .setAttributes(new JSONObject()
              .put("cameraStreamSupportedProtocols", new String[] {"hls", "dash"})
              .put("cameraStreamNeedAuthToken", true)
              .put("cameraStreamNeedDrmEncryption", true)
          )
          .setDeviceInfo("blinds manufacturer", "xyz", "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": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.CAMERA",
        "traits": [
          "action.devices.traits.CameraStream"
        ],
        "name": {
          "defaultNames": [
            "Sirius Cybernetics Corporation 3000"
          ],
          "name": "Front Camera",
          "nicknames": [
            "Camera"
          ]
        },
        "willReportState": false,
        "attributes": {
          "cameraStreamSupportedProtocols": [
            "hls",
            "dash"
          ],
          "cameraStreamNeedAuthToken": true,
          "cameraStreamNeedDrmEncryption": false
        },
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "lambtwirl"
        }
      }
    ]
  }
}
Validator

Device ERRORS

See the full list of errors and exceptions.

resourceUnavailable - Any failure related to generating the stream url.