Device TYPE
action.devices.types.AWNING
Awnings are retractable and can opened and closed. They can be
installed indoors or outdoors.
This type indicates that the device gets the awning icon and some synonyms/aliases.
Recommended TRAITS
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.
{ "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.AWNING', traits: [ 'action.devices.traits.OpenClose' ], name: { defaultNames: ['Sirius Cybernetics Corporation Awning'], name: 'Garden Awning', nicknames: ['Back Window Awning'] }, willReportState: true, attributes: { openDirection: ['UP', 'DOWN'] }, deviceInfo: { manufacturer: 'ACME', model: '492134', hwVersion: '3.2', swVersion: '11.4' }, customData: { fooValue: 74, barValue: true, bazValue: 'lambtwirl' } }] } }; }); // ... exports.smarthome = functions.https.onRequest(app);
Java
@NotNull @Override public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> headers) { SyncResponse.Payload payload = new SyncResponse.Payload(); payload.setAgentUserId("123456789"); payload.setDevices(new SyncResponse.Payload.Device[] { new SyncResponse.Payload.Device.Builder() .setId("123") .setType("action.devices.types.AWNING") .addTrait("action.devices.traits.OpenClose") .setName( Collections.singletonList("Smart Awning"), "Smart Awning", Collections.singletonList("back window awning") ) .setWillReportState(true) .setAttributes(new JSONObject() .put("openDirection", new String[] {"UP", "DOWN"}) ) .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); }
JSON
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "agentUserId": "1836.15267389", "devices": [ { "id": "123", "type": "action.devices.types.AWNING", "traits": [ "action.devices.traits.OpenClose" ], "name": { "defaultNames": [ "Sirius Cybernetics Corporation Awning" ], "name": "Garden Awning", "nicknames": [ "Back Window Awning" ] }, "willReportState": true, "attributes": { "openDirection": [ "UP", "DOWN" ] }, "deviceInfo": { "manufacturer": "ACME", "model": "492134", "hwVersion": "3.2", "swVersion": "11.4" }, "customData": { "fooValue": 74, "barValue": true, "bazValue": "lambtwirl" } } ] } }
Device ERRORS
See the full list of errors and exceptions.