-
Notifications
You must be signed in to change notification settings - Fork 39
/
SmartHomeResponse.kt
498 lines (437 loc) · 16.5 KB
/
SmartHomeResponse.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
/*
* Copyright 2018 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.actions.api.smarthome
import com.google.home.graph.v1.DeviceProto
import com.google.protobuf.ProtocolStringList
import com.google.protobuf.Struct
import com.google.protobuf.util.JsonFormat
import org.json.JSONException
import org.json.JSONObject
/**
* A representation of the JSON payload that should be sent during a smart home request.
*
* @see <a href="https://developers.google.com/actions/smarthome/develop/process-intents">Public documentation</a>
*/
open class SmartHomeResponse {
open fun build(): JSONObject {
return JSONObject() // Return empty object
}
}
/**
* A representation of the JSON payload that should be sent during an action.devices.SYNC request.
*
* @see <a href="https://developers.google.com/actions/smarthome/develop/process-intents#response_format">Public documentation</a>
*/
class SyncResponse() : SmartHomeResponse() {
lateinit var requestId: String
lateinit var payload: Payload
constructor(requestId: String, payload: Payload) : this() {
this.requestId = requestId
this.payload = payload
}
override fun build(): JSONObject {
val json = JSONObject()
json.put("requestId", requestId)
json.put("payload", payload.build())
return json
}
class Payload() {
lateinit var agentUserId: String
lateinit var devices: Array<Device>
constructor(agentUserId: String, devices: Array<Device>) : this() {
this.agentUserId = agentUserId
this.devices = devices
}
fun build(): JSONObject {
val json = JSONObject()
val devicesJson = devices.map {
it.build()
}
json.put("agentUserId", agentUserId)
json.put("devices", devicesJson)
return json
}
/**
* The container class for the payload device
*/
class Device(var device: DeviceProto.Device) {
fun build(): JSONObject {
val jsonString = JsonFormat.printer()
.omittingInsignificantWhitespace()
.print(device)
return JSONObject(jsonString)
}
/**
* A Builder for a Device
*/
class Builder {
var protoBuilder: DeviceProto.Device.Builder = DeviceProto.Device.newBuilder()
/**
* Get device id
*/
fun getId(): String {
return protoBuilder.id
}
/**
* Set device id
*/
fun setId(id: String): Builder {
protoBuilder.id = id
return this
}
/**
* Get device type
*/
fun getType(): String {
return protoBuilder.type
}
/**
* Set device type
*/
fun setType(type: String): Builder {
protoBuilder.type = type
return this
}
/**
* Get list of device traits
*/
fun getTraits(): ProtocolStringList {
return protoBuilder.traitsList
}
/**
* Sets list of device traits
*/
fun setTraits(traits: List<String>): Builder {
protoBuilder.clearTraits()
protoBuilder.addAllTraits(traits)
return this
}
/**
* Adds a trait to the list of device traits
*/
fun addTrait(trait: String): Builder {
protoBuilder.addTraits(trait)
return this
}
/**
* Gets the names of the device
*/
fun getName(): DeviceProto.DeviceNames {
return protoBuilder.name
}
/**
* Sets the names of the device
*/
fun setName(name: DeviceProto.DeviceNames): Builder {
protoBuilder.name = name
return this
}
/**
* Sets each field for the names of the device
*/
fun setName(defaultNames: List<String>?, name: String?, nicknames: List<String>?):
Builder {
protoBuilder.name = DeviceProto.DeviceNames.newBuilder()
.addAllDefaultNames(defaultNames)
.setName(name)
.addAllNicknames(nicknames)
.build()
return this
}
/**
* Gets whether the device will report its state
*/
fun getWillReportState(): Boolean {
return protoBuilder.willReportState
}
/**
* Sets whether the device will report its state
*/
fun setWillReportState(willReportState: Boolean): Builder {
protoBuilder.willReportState = willReportState
return this
}
/**
* Get the attributes of the device
*/
fun getAttributes(): Struct {
return protoBuilder.attributes
}
/**
* Set the attributes of the device
*/
fun setAttributes(attributes: Struct): Builder {
protoBuilder.attributes = attributes
return this
}
/**
* Sets the attributes of the device
*/
fun setAttributes(attributesJson: JSONObject): Builder {
val attributeBuilder = Struct.newBuilder()
try {
JsonFormat.parser()
.ignoringUnknownFields()
.merge(attributesJson.toString(), attributeBuilder)
} catch (e: Exception) {
throw RuntimeException(e)
}
protoBuilder.setAttributes(attributeBuilder)
return this
}
/**
* Gets the device room hint
*/
fun getRoomHint(): String {
return protoBuilder.roomHint
}
/**
* Sets the device room hint
*/
fun setRoomHint(roomHint: String): Builder {
protoBuilder.roomHint = roomHint
return this
}
/**
* Gets the device info
*/
fun getDeviceInfo(): DeviceProto.DeviceInfo {
return protoBuilder.deviceInfo
}
/**
* Sets the device info
*/
fun setDeviceInfo(deviceInfo: DeviceProto.DeviceInfo): Builder {
protoBuilder.deviceInfo = deviceInfo
return this
}
/**
* Sets each field of the device info
*/
fun setDeviceInfo(manufacturer: String, model: String, hwVersion: String,
swVersion: String): Builder {
protoBuilder.deviceInfo = DeviceProto.DeviceInfo.newBuilder()
.setManufacturer(manufacturer)
.setModel(model)
.setHwVersion(hwVersion)
.setSwVersion(swVersion)
.build()
return this
}
/**
* Gets the custom data of the device
*/
@Deprecated(message = "The data type is now a JSON object.",
replaceWith = ReplaceWith("getCustomDataAsJSON().toString()"))
fun getCustomData(): String {
return this.getCustomDataAsJSON().toString()
}
fun getCustomDataAsJSON(): JSONObject {
val customDataStruct = protoBuilder.customData
try {
return JSONObject(JsonFormat.printer().print(customDataStruct))
} catch (e: Exception) {
throw RuntimeException(e)
}
}
/**
* Sets the custom data of the device.
*/
@Deprecated(message = "Please format the data as a JSON object",
replaceWith = ReplaceWith("setCustomData(JSONObject(customData))",
"org.json.JSONObject")
)
fun setCustomData(customData: String): Builder {
var customDataJSON = JSONObject(customData)
val customDataStruct = Struct.newBuilder()
try {
JsonFormat.parser()
.ignoringUnknownFields()
.merge(customDataJSON.toString(), customDataStruct)
} catch (e: Exception) {
throw RuntimeException(e)
}
protoBuilder.setCustomData(customDataStruct)
return this
}
/**
* Sets the custom data of the device
*/
fun setCustomData(customData: JSONObject): Builder {
val customDataStruct = Struct.newBuilder()
try {
JsonFormat.parser()
.ignoringUnknownFields()
.merge(customData.toString(), customDataStruct)
} catch (e: Exception) {
throw RuntimeException(e)
}
protoBuilder.setCustomData(customDataStruct)
return this
}
/**
* Adds an additional device ID
*/
fun addOtherDeviceId(deviceId: String, agentUserId: String? = null): Builder {
val builder = DeviceProto.AgentOtherDeviceId.newBuilder()
.setDeviceId(deviceId)
if (agentUserId != null) {
builder.agentId = agentUserId
}
protoBuilder.addOtherDeviceIds(builder.build())
return this
}
/**
* Sets a list of otherDeviceIds
*/
fun setOtherDeviceIds(otherDeviceIds: List<DeviceProto.AgentOtherDeviceId>): Builder {
protoBuilder.clearOtherDeviceIds()
protoBuilder.addAllOtherDeviceIds(otherDeviceIds)
return this
}
/**
* Generates the underlying DeviceProto for the device
*/
fun build(): Device {
// Set
return Device(protoBuilder.build())
}
}
}
}
}
/**
* A representation of the JSON payload that should be sent during an action.devices.QUERY request.
*
* @see <a href="https://developers.google.com/actions/smarthome/develop/process-intents#response_format_2">Public documentation</a>
*/
class QueryResponse() : SmartHomeResponse() {
lateinit var requestId: String
lateinit var payload: Payload
constructor(requestId: String, payload: Payload) : this() {
this.requestId = requestId
this.payload = payload
}
override fun build(): JSONObject {
val json = JSONObject()
json.put("requestId", requestId)
json.put("payload", payload.build())
return json
}
class Payload() {
var devices: Map<String, Map<String, kotlin.Any>>? = null
var errorCode: String? = null
constructor(devices: Map<String, Map<String, kotlin.Any>>) : this() {
this.devices = devices
}
constructor(errorCode: String): this() {
this.errorCode = errorCode
}
fun build(): JSONObject {
val json = JSONObject()
if (devices != null) {
json.put("devices", devices)
}
if (errorCode != null) {
json.put("errorCode", errorCode)
}
return json
}
}
}
/**
* A representation of the JSON payload that should be sent during an action.devices.EXECUTE request.
*
* @see <a href="https://developers.google.com/actions/smarthome/develop/process-intents#response_format_3">Public documentation</a>
*/
class ExecuteResponse() : SmartHomeResponse() {
lateinit var requestId: String
lateinit var payload: Payload
constructor(requestId: String, payload: Payload) : this() {
this.requestId = requestId
this.payload = payload
}
override fun build(): JSONObject {
val json = JSONObject()
json.put("requestId", requestId)
json.put("payload", payload.build())
return json
}
class Payload() {
var commands: Array<Commands>? = null
var errorCode: String? = null
constructor(commands: Array<Commands>) : this() {
this.commands = commands
}
constructor(errorCode: String) : this() {
this.errorCode = errorCode
}
fun build(): JSONObject {
val json = JSONObject()
if (commands != null) {
json.put("commands", requireNotNull(commands).map { command -> command.build() })
}
if (errorCode != null) {
json.put("errorCode", errorCode)
}
return json
}
class Commands() {
lateinit var ids: Array<String>
lateinit var status: String
var states: Map<String, kotlin.Any>? = null
var errorCode: String? = null
var challengeNeeded: Map<String, String>? = null
constructor(ids: Array<String>, status: String, states: Map<String, kotlin.Any>?,
errorCode: String?, challengeType: ChallengeType?) : this() {
this.ids = ids
this.status = status
this.states = states
this.errorCode = errorCode
if (challengeType != null) {
this.challengeNeeded = mapOf(
Pair("type", challengeType.challenge)
)
}
}
fun build(): JSONObject {
val json = JSONObject()
json.put("ids", ids)
json.put("status", status)
if (states != null) {
json.put("states", states)
}
if (errorCode != null) {
json.put("errorCode", errorCode)
}
if (challengeNeeded != null) {
json.put("challengeNeeded", challengeNeeded)
}
return json
}
}
}
}
/**
* The type of challenge that should be presented to the user to authorize a given EXECUTE command.
*
* @see <a href="https://developers.google.com/actions/smarthome/develop/two-factor-authentication">Two-factor authentication</a>
*/
enum class ChallengeType(val challenge: String) {
ACK("ackNeeded"),
PIN("pinNeeded"),
WRONG_PIN("challengeFailedPinNeeded")
}