-
Notifications
You must be signed in to change notification settings - Fork 0
/
lambda.py
707 lines (671 loc) · 23.8 KB
/
lambda.py
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
# -*- coding: utf-8 -*-
# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Amazon Software License (the "License"). You may not use this file except in
# compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/asl/
#
# or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Alexa Smart Home Lambda Function Sample Code.
This file demonstrates some key concepts when migrating an existing Smart Home skill Lambda to
v3, including recommendations on how to transfer endpoint/appliance objects, how v2 and vNext
handlers can be used together, and how to validate your v3 responses using the new Validation
Schema.
Note that this example does not deal with user authentication, only uses virtual devices, omits
a lot of implementation and error handling to keep the code simple and focused.
"""
import logging
import time
import json
import uuid
# Imports for v3 validation
from validation import validate_message
# Setup logger
logger = logging.getLogger()
logger.setLevel(logging.INFO)
# To simplify this sample Lambda, we omit validation of access tokens and retrieval of a specific
# user's appliances. Instead, this array includes a variety of virtual appliances in v2 API syntax,
# and will be used to demonstrate transformation between v2 appliances and v3 endpoints.
SAMPLE_APPLIANCES = [
{
"applianceId": "endpoint-001",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Switch",
"version": "1",
"friendlyName": "Switch",
"friendlyDescription": "001 Switch that can only be turned on/off",
"isReachable": True,
"actions": [
"turnOn",
"turnOff"
],
"additionalApplianceDetails": {
"detail1": "For simplicity, this is the only appliance",
"detail2": "that has some values in the additionalApplianceDetails"
}
},
{
"applianceId": "endpoint-002",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Light",
"version": "1",
"friendlyName": "Light",
"friendlyDescription": "002 Light that is dimmable and can change color and color temperature",
"isReachable": True,
"actions": [
"turnOn",
"turnOff",
"setPercentage",
"incrementPercentage",
"decrementPercentage",
"setColor",
"setColorTemperature",
"incrementColorTemperature",
"decrementColorTemperature"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-003",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart White Light",
"version": "1",
"friendlyName": "White Light",
"friendlyDescription": "003 Light that is dimmable and can change color temperature only",
"isReachable": True,
"actions": [
"turnOn",
"turnOff",
"setPercentage",
"incrementPercentage",
"decrementPercentage",
"setColorTemperature",
"incrementColorTemperature",
"decrementColorTemperature"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-004",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Thermostat",
"version": "1",
"friendlyName": "Thermostat",
"friendlyDescription": "004 Thermostat that can change and query temperatures",
"isReachable": True,
"actions": [
"setTargetTemperature",
"incrementTargetTemperature",
"decrementTargetTemperature",
"getTargetTemperature",
"getTemperatureReading"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-004-1",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Thermostat Dual",
"version": "1",
"friendlyName": "Living Room Thermostat",
"friendlyDescription": "004-1 Thermostat that can change and query temperatures, supports dual setpoints",
"isReachable": True,
"actions": [
"setTargetTemperature",
"incrementTargetTemperature",
"decrementTargetTemperature",
"getTargetTemperature",
"getTemperatureReading"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-005",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Lock",
"version": "1",
"friendlyName": "Lock",
"friendlyDescription": "005 Lock that can be locked and can query lock state",
"isReachable": True,
"actions": [
"setLockState",
"getLockState"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-006",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Scene",
"version": "1",
"friendlyName": "Good Night Scene",
"friendlyDescription": "006 Scene that can only be turned on",
"isReachable": True,
"actions": [
"turnOn"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-007",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Activity",
"version": "1",
"friendlyName": "Watch TV",
"friendlyDescription": "007 Activity that runs sequentially that can be turned on and off",
"isReachable": True,
"actions": [
"turnOn",
"turnOff"
],
"additionalApplianceDetails": {}
},
{
"applianceId": "endpoint-008",
"manufacturerName": "Sample Manufacturer",
"modelName": "Smart Camera",
"version": "1",
"friendlyName": "Baby Camera",
"friendlyDescription": "008 Camera that streams from an RSTP source",
"isReachable": True,
"actions": [
"retrieveCameraStreamUri"
],
"additionalApplianceDetails": {}
}
]
def lambda_handler(request, context):
"""Main Lambda handler.
Since you can expect both v2 and v3 directives for a period of time during the migration
and transition of your existing users, this main Lambda handler must be modified to support
both v2 and v3 requests.
"""
try:
logger.info("Directive:")
logger.info(json.dumps(request, indent=4, sort_keys=True))
version = get_directive_version(request)
if version == "3":
logger.info("Received v3 directive!")
if request["directive"]["header"]["name"] == "Discover":
response = handle_discovery_v3(request)
else:
response = handle_non_discovery_v3(request)
else:
logger.info("Received v2 directive!")
if request["header"]["namespace"] == "Alexa.ConnectedHome.Discovery":
response = handle_discovery()
else:
response = handle_non_discovery(request)
logger.info("Response:")
logger.info(json.dumps(response, indent=4, sort_keys=True))
#if version == "3":
#logger.info("Validate v3 response")
#validate_message(request, response)
return response
except ValueError as error:
logger.error(error)
raise
# v2 handlers
def handle_discovery():
header = {
"namespace": "Alexa.ConnectedHome.Discovery",
"name": "DiscoverAppliancesResponse",
"payloadVersion": "2",
"messageId": get_uuid()
}
payload = {
"discoveredAppliances": SAMPLE_APPLIANCES
}
response = {
"header": header,
"payload": payload
}
return response
def handle_non_discovery(request):
request_name = request["header"]["name"]
if request_name == "TurnOnRequest":
header = {
"namespace": "Alexa.ConnectedHome.Control",
"name": "TurnOnConfirmation",
"payloadVersion": "2",
"messageId": get_uuid()
}
payload = {}
elif request_name == "TurnOffRequest":
header = {
"namespace": "Alexa.ConnectedHome.Control",
"name": "TurnOffConfirmation",
"payloadVersion": "2",
"messageId": get_uuid()
}
# other handlers omitted in this example
payload = {}
response = {
"header": header,
"payload": payload
}
return response
# v2 utility functions
def get_appliance_by_appliance_id(appliance_id):
for appliance in SAMPLE_APPLIANCES:
if appliance["applianceId"] == appliance_id:
return appliance
return None
def get_utc_timestamp(seconds=None):
return time.strftime("%Y-%m-%dT%H:%M:%S.00Z", time.gmtime(seconds))
def get_uuid():
return str(uuid.uuid4())
# v3 handlers
def handle_discovery_v3(request):
endpoints = []
for appliance in SAMPLE_APPLIANCES:
endpoints.append(get_endpoint_from_v2_appliance(appliance))
response = {
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": get_uuid()
},
"payload": {
"endpoints": endpoints
}
}
}
return response
def handle_non_discovery_v3(request):
request_namespace = request["directive"]["header"]["namespace"]
request_name = request["directive"]["header"]["name"]
if request_namespace == "Alexa.PowerController":
if request_name == "TurnOn":
value = "ON"
else:
value = "OFF"
response = {
"context": {
"properties": [
{
"namespace": "Alexa.PowerController",
"name": "powerState",
"value": value,
"timeOfSample": get_utc_timestamp(),
"uncertaintyInMilliseconds": 500
}
]
},
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"payloadVersion": "3",
"messageId": get_uuid(),
"correlationToken": request["directive"]["header"]["correlationToken"]
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "access-token-from-Amazon"
},
"endpointId": request["directive"]["endpoint"]["endpointId"]
},
"payload": {}
}
}
return response
elif request_namespace == "Alexa.Authorization":
if request_name == "AcceptGrant":
response = {
"event": {
"header": {
"namespace": "Alexa.Authorization",
"name": "AcceptGrant.Response",
"payloadVersion": "3",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4"
},
"payload": {}
}
}
return response
# other handlers omitted in this example
# v3 utility functions
def get_endpoint_from_v2_appliance(appliance):
endpoint = {
"endpointId": appliance["applianceId"],
"manufacturerName": appliance["manufacturerName"],
"friendlyName": appliance["friendlyName"],
"description": appliance["friendlyDescription"],
"displayCategories": [],
"cookie": appliance["additionalApplianceDetails"],
"capabilities": []
}
endpoint["displayCategories"] = get_display_categories_from_v2_appliance(appliance)
endpoint["capabilities"] = get_capabilities_from_v2_appliance(appliance)
return endpoint
def get_directive_version(request):
try:
return request["directive"]["header"]["payloadVersion"]
except:
try:
return request["header"]["payloadVersion"]
except:
return "-1"
def get_endpoint_by_endpoint_id(endpoint_id):
appliance = get_appliance_by_appliance_id(endpoint_id)
if appliance:
return get_endpoint_from_v2_appliance(appliance)
return None
def get_display_categories_from_v2_appliance(appliance):
model_name = appliance["modelName"]
if model_name == "Smart Switch": displayCategories = ["SWITCH"]
elif model_name == "Smart Light": displayCategories = ["LIGHT"]
elif model_name == "Smart White Light": displayCategories = ["LIGHT"]
elif model_name == "Smart Thermostat": displayCategories = ["THERMOSTAT"]
elif model_name == "Smart Lock": displayCategories = ["SMARTLOCK"]
elif model_name == "Smart Scene": displayCategories = ["SCENE_TRIGGER"]
elif model_name == "Smart Activity": displayCategories = ["ACTIVITY_TRIGGER"]
elif model_name == "Smart Camera": displayCategories = ["CAMERA"]
else: displayCategories = ["OTHER"]
return displayCategories
def get_capabilities_from_v2_appliance(appliance):
model_name = appliance["modelName"]
if model_name == 'Smart Switch':
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerState" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart Light":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerState" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ColorController",
"version": "3",
"properties": {
"supported": [
{ "name": "color" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ColorTemperatureController",
"version": "3",
"properties": {
"supported": [
{ "name": "colorTemperatureInKelvin" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.BrightnessController",
"version": "3",
"properties": {
"supported": [
{ "name": "brightness" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.PowerLevelController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerLevel" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.PercentageController",
"version": "3",
"properties": {
"supported": [
{ "name": "percentage" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart White Light":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerState" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ColorTemperatureController",
"version": "3",
"properties": {
"supported": [
{ "name": "colorTemperatureInKelvin" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.BrightnessController",
"version": "3",
"properties": {
"supported": [
{ "name": "brightness" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.PowerLevelController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerLevel" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.PercentageController",
"version": "3",
"properties": {
"supported": [
{ "name": "percentage" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart Thermostat":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.ThermostatController",
"version": "3",
"properties": {
"supported": [
{ "name": "targetSetpoint" },
{ "name": "thermostatMode" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.TemperatureSensor",
"version": "3",
"properties": {
"supported": [
{ "name": "temperature" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart Thermostat Dual":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.ThermostatController",
"version": "3",
"properties": {
"supported": [
{ "name": "upperSetpoint" },
{ "name": "lowerSetpoint" },
{ "name": "thermostatMode" }
],
"proactivelyReported": True,
"retrievable": True
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.TemperatureSensor",
"version": "3",
"properties": {
"supported": [
{ "name": "temperature" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart Lock":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.LockController",
"version": "3",
"properties": {
"supported": [
{ "name": "lockState" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
elif model_name == "Smart Scene":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.SceneController",
"version": "3",
"supportsDeactivation": False,
"proactivelyReported": True
}
]
elif model_name == "Smart Activity":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.SceneController",
"version": "3",
"supportsDeactivation": True,
"proactivelyReported": True
}
]
elif model_name == "Smart Camera":
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.CameraStreamController",
"version": "3",
"cameraStreamConfigurations" : [ {
"protocols": ["RTSP"],
"resolutions": [{"width":1280, "height":720}],
"authorizationTypes": ["NONE"],
"videoCodecs": ["H264"],
"audioCodecs": ["AAC"]
} ]
}
]
else:
# in this example, just return simple on/off capability
capabilities = [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{ "name": "powerState" }
],
"proactivelyReported": True,
"retrievable": True
}
}
]
# additional capabilities that are required for each endpoint
endpoint_health_capability = {
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3",
"properties": {
"supported":[
{ "name":"connectivity" }
],
"proactivelyReported": True,
"retrievable": True
}
}
alexa_interface_capability = {
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
capabilities.append(endpoint_health_capability)
capabilities.append(alexa_interface_capability)
return capabilities