homey-api 3.6.8 → 3.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -442,6 +442,7 @@
442
442
  "id": "dashboard",
443
443
  "schema": {
444
444
  "type": "object",
445
+ "additionalProperties": false,
445
446
  "properties": {
446
447
  "id": {
447
448
  "type": "string",
@@ -450,56 +451,28 @@
450
451
  "name": {
451
452
  "type": "string"
452
453
  },
453
- "widgets": {
454
- "type": "object",
455
- "additionalProperties": false,
456
- "patternProperties": {
457
- "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": {
458
- "type": "object",
459
- "properties": {
460
- "type": {
461
- "type": "string"
462
- },
463
- "x": {
464
- "type": "number"
465
- },
466
- "y": {
467
- "type": "number"
468
- },
469
- "width": {
470
- "type": "number"
471
- },
472
- "height": {
473
- "type": "number"
474
- },
475
- "settings": {
476
- "type": "object"
477
- }
478
- }
479
- }
480
- }
481
- },
482
- "lines": {
483
- "type": "object",
484
- "additionalProperties": false,
485
- "patternProperties": {
486
- "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": {
487
- "type": "object",
488
- "properties": {
489
- "x1": {
490
- "type": "number"
491
- },
492
- "x2": {
493
- "type": "number"
494
- },
495
- "y1": {
496
- "type": "number"
497
- },
498
- "y2": {
499
- "type": "number"
500
- },
501
- "settings": {
502
- "type": "object"
454
+ "columns": {
455
+ "type": "array",
456
+ "items": {
457
+ "type": "object",
458
+ "properties": {
459
+ "id": {
460
+ "type": "string",
461
+ "format": "uuid"
462
+ },
463
+ "widgets": {
464
+ "type": "array",
465
+ "items": {
466
+ "type": "object",
467
+ "required": [
468
+ "id"
469
+ ],
470
+ "properties": {
471
+ "id": {
472
+ "type": "string",
473
+ "format": "uuid"
474
+ }
475
+ }
503
476
  }
504
477
  }
505
478
  }
@@ -507,6 +480,28 @@
507
480
  }
508
481
  }
509
482
  }
483
+ },
484
+ "AppWidget": {
485
+ "id": "appwidget",
486
+ "schema": {
487
+ "type": "object",
488
+ "properties": {
489
+ "id": {
490
+ "type": "string"
491
+ }
492
+ }
493
+ }
494
+ },
495
+ "WidgetStore": {
496
+ "id": "widgetstore",
497
+ "schema": {
498
+ "type": "object",
499
+ "properties": {
500
+ "id": {
501
+ "type": "string"
502
+ }
503
+ }
504
+ }
510
505
  }
511
506
  },
512
507
  "operations": {
@@ -573,12 +568,8 @@
573
568
  "type": "string",
574
569
  "required": true
575
570
  },
576
- "widgets": {
577
- "type": "object",
578
- "required": true
579
- },
580
- "lines": {
581
- "type": "object",
571
+ "columns": {
572
+ "type": "array",
582
573
  "required": true
583
574
  }
584
575
  }
@@ -611,11 +602,8 @@
611
602
  "name": {
612
603
  "type": "string"
613
604
  },
614
- "widgets": {
615
- "type": "object"
616
- },
617
- "lines": {
618
- "type": "object"
605
+ "columns": {
606
+ "type": "array"
619
607
  }
620
608
  }
621
609
  }
@@ -639,6 +627,138 @@
639
627
  "required": true
640
628
  }
641
629
  }
630
+ },
631
+ "getAppWidgets": {
632
+ "method": "get",
633
+ "path": "/appwidget",
634
+ "private": false,
635
+ "scopes": [
636
+ "homey.dashboard.readonly"
637
+ ],
638
+ "crud": {
639
+ "type": "getAll",
640
+ "item": "AppWidget"
641
+ },
642
+ "parameters": {}
643
+ },
644
+ "getAppWidget": {
645
+ "method": "get",
646
+ "path": "/appwidget/:id",
647
+ "private": false,
648
+ "scopes": [
649
+ "homey.dashboard.readonly"
650
+ ],
651
+ "crud": {
652
+ "type": "getOne",
653
+ "item": "AppWidget"
654
+ },
655
+ "parameters": {
656
+ "id": {
657
+ "in": "path",
658
+ "type": "string",
659
+ "required": true
660
+ }
661
+ }
662
+ },
663
+ "getAppWidgetAutocomplete": {
664
+ "method": "get",
665
+ "path": "/appwidget/:id/autocomplete",
666
+ "private": false,
667
+ "scopes": [
668
+ "homey.dashboard.readonly"
669
+ ],
670
+ "parameters": {
671
+ "id": {
672
+ "in": "path",
673
+ "type": "string",
674
+ "required": true
675
+ },
676
+ "settingId": {
677
+ "in": "query",
678
+ "type": "string",
679
+ "required": true
680
+ },
681
+ "query": {
682
+ "in": "query",
683
+ "type": "string",
684
+ "required": true
685
+ },
686
+ "settings": {
687
+ "in": "query",
688
+ "type": "object"
689
+ }
690
+ }
691
+ },
692
+ "getWidgetStores": {
693
+ "method": "get",
694
+ "path": "/widgetstore",
695
+ "private": false,
696
+ "scopes": [
697
+ "homey.dashboard.readonly"
698
+ ],
699
+ "crud": {
700
+ "type": "getAll",
701
+ "item": "WidgetStore"
702
+ },
703
+ "parameters": {}
704
+ },
705
+ "getWidgetStore": {
706
+ "method": "get",
707
+ "path": "/widgetstore/:id",
708
+ "private": false,
709
+ "scopes": [
710
+ "homey.dashboard.readonly"
711
+ ],
712
+ "crud": {
713
+ "type": "getOne",
714
+ "item": "WidgetStore"
715
+ },
716
+ "parameters": {
717
+ "id": {
718
+ "in": "path",
719
+ "type": "string",
720
+ "required": true
721
+ }
722
+ }
723
+ },
724
+ "getWidgetStoreState": {
725
+ "method": "get",
726
+ "path": "/widgetstore/:id/state",
727
+ "private": false,
728
+ "scopes": [
729
+ "homey.dashboard.readonly"
730
+ ],
731
+ "parameters": {
732
+ "id": {
733
+ "in": "path",
734
+ "type": "string",
735
+ "required": true
736
+ }
737
+ }
738
+ },
739
+ "setWidgetStoreState": {
740
+ "method": "post",
741
+ "path": "/widgetstore/:id/state",
742
+ "private": false,
743
+ "scopes": [
744
+ "homey.dashboard.readonly"
745
+ ],
746
+ "parameters": {
747
+ "id": {
748
+ "in": "path",
749
+ "type": "string",
750
+ "required": true
751
+ },
752
+ "state": {
753
+ "in": "body",
754
+ "type": "object",
755
+ "required": true
756
+ },
757
+ "replace": {
758
+ "in": "body",
759
+ "type": "boolean"
760
+ }
761
+ }
642
762
  }
643
763
  }
644
764
  },
@@ -1220,6 +1340,235 @@
1220
1340
  }
1221
1341
  }
1222
1342
  },
1343
+ "ManagerEnergyDongle": {
1344
+ "id": "energydongle",
1345
+ "idCamelCase": "energydongle",
1346
+ "items": {},
1347
+ "operations": {
1348
+ "getOptionPhaseLoadNotificationSettings": {
1349
+ "method": "GET",
1350
+ "path": "/option/phaseLoadNotificationSettings",
1351
+ "scopes": [
1352
+ "homey.system.readonly"
1353
+ ]
1354
+ },
1355
+ "setOptionPhaseLoadNotificationSettings": {
1356
+ "method": "PUT",
1357
+ "path": "/option/phaseLoadNotificationSettings",
1358
+ "scopes": [
1359
+ "homey.system"
1360
+ ],
1361
+ "parameters": {
1362
+ "value": {
1363
+ "in": "body",
1364
+ "required": true
1365
+ }
1366
+ }
1367
+ },
1368
+ "unsetOptionPhaseLoadNotificationSettings": {
1369
+ "method": "DELETE",
1370
+ "path": "/option/phaseLoadNotificationSettings",
1371
+ "scopes": [
1372
+ "homey.system"
1373
+ ]
1374
+ },
1375
+ "createAndUploadDiagnosticReport": {
1376
+ "method": "post",
1377
+ "path": "/:deviceId/diagnostic-report",
1378
+ "private": true,
1379
+ "scopes": [
1380
+ "homey.system.readonly"
1381
+ ],
1382
+ "parameters": {
1383
+ "deviceId": {
1384
+ "in": "path",
1385
+ "type": "string",
1386
+ "required": true
1387
+ },
1388
+ "timeout": {
1389
+ "in": "body",
1390
+ "type": "number"
1391
+ }
1392
+ }
1393
+ },
1394
+ "getNextFrame": {
1395
+ "method": "get",
1396
+ "path": "/:deviceId/next-frame",
1397
+ "private": true,
1398
+ "scopes": [
1399
+ "homey.system.readonly"
1400
+ ],
1401
+ "parameters": {
1402
+ "deviceId": {
1403
+ "in": "path",
1404
+ "type": "string",
1405
+ "required": true
1406
+ },
1407
+ "timeout": {
1408
+ "in": "query",
1409
+ "type": "string"
1410
+ }
1411
+ }
1412
+ },
1413
+ "restartSettingsDiscovery": {
1414
+ "method": "post",
1415
+ "path": "/:deviceId/restart-settings-discovery",
1416
+ "private": true,
1417
+ "scopes": [
1418
+ "homey.system"
1419
+ ],
1420
+ "parameters": {
1421
+ "deviceId": {
1422
+ "in": "path",
1423
+ "type": "string",
1424
+ "required": true
1425
+ }
1426
+ }
1427
+ },
1428
+ "getUartConfig": {
1429
+ "method": "get",
1430
+ "path": "/:deviceId/uart-config",
1431
+ "private": true,
1432
+ "scopes": [
1433
+ "homey.system.readonly"
1434
+ ],
1435
+ "parameters": {
1436
+ "deviceId": {
1437
+ "in": "path",
1438
+ "type": "string",
1439
+ "required": true
1440
+ }
1441
+ }
1442
+ },
1443
+ "setUartConfig": {
1444
+ "method": "post",
1445
+ "path": "/:deviceId/uart-config",
1446
+ "private": true,
1447
+ "scopes": [
1448
+ "homey.system"
1449
+ ],
1450
+ "parameters": {
1451
+ "deviceId": {
1452
+ "in": "path",
1453
+ "type": "string"
1454
+ },
1455
+ "baudRate": {
1456
+ "in": "body",
1457
+ "type": "number"
1458
+ },
1459
+ "dataBits": {
1460
+ "in": "body",
1461
+ "type": "number"
1462
+ },
1463
+ "stopBits": {
1464
+ "in": "body",
1465
+ "type": "number"
1466
+ },
1467
+ "parity": {
1468
+ "in": "body",
1469
+ "type": "string"
1470
+ },
1471
+ "inverseRx": {
1472
+ "in": "body",
1473
+ "type": "boolean"
1474
+ },
1475
+ "dataTimeoutMs": {
1476
+ "in": "body",
1477
+ "type": "number"
1478
+ },
1479
+ "persistent": {
1480
+ "in": "body",
1481
+ "type": "boolean"
1482
+ }
1483
+ }
1484
+ },
1485
+ "checkFirmwareUpdateAvailable": {
1486
+ "method": "get",
1487
+ "path": "/:deviceId/firmware-update",
1488
+ "private": true,
1489
+ "scopes": [
1490
+ "homey.system.readonly"
1491
+ ],
1492
+ "parameters": {
1493
+ "deviceId": {
1494
+ "in": "path",
1495
+ "type": "string",
1496
+ "required": true
1497
+ }
1498
+ }
1499
+ },
1500
+ "installFirmwareUpdate": {
1501
+ "method": "post",
1502
+ "path": "/:deviceId/firmware-update",
1503
+ "private": true,
1504
+ "scopes": [
1505
+ "homey.system"
1506
+ ],
1507
+ "parameters": {
1508
+ "deviceId": {
1509
+ "in": "path",
1510
+ "type": "string",
1511
+ "required": true
1512
+ },
1513
+ "updateThroughReboot": {
1514
+ "in": "body",
1515
+ "type": "boolean"
1516
+ }
1517
+ }
1518
+ },
1519
+ "reboot": {
1520
+ "method": "post",
1521
+ "path": "/:deviceId/reboot",
1522
+ "private": true,
1523
+ "scopes": [
1524
+ "homey.system"
1525
+ ],
1526
+ "parameters": {
1527
+ "deviceId": {
1528
+ "in": "path",
1529
+ "type": "string",
1530
+ "required": true
1531
+ }
1532
+ }
1533
+ },
1534
+ "setPhaseLoadLimits": {
1535
+ "method": "put",
1536
+ "path": "/:deviceId/phase-load",
1537
+ "private": true,
1538
+ "scopes": [],
1539
+ "parameters": {
1540
+ "deviceId": {
1541
+ "in": "path",
1542
+ "type": "string",
1543
+ "required": true
1544
+ },
1545
+ "phasesConfigured": {
1546
+ "in": "body",
1547
+ "type": "number",
1548
+ "required": true
1549
+ },
1550
+ "capacity": {
1551
+ "in": "body",
1552
+ "type": "number",
1553
+ "required": true
1554
+ }
1555
+ }
1556
+ },
1557
+ "getPhaseLoadLimits": {
1558
+ "method": "get",
1559
+ "path": "/:deviceId/phase-load",
1560
+ "private": true,
1561
+ "scopes": [],
1562
+ "parameters": {
1563
+ "deviceId": {
1564
+ "in": "path",
1565
+ "type": "string",
1566
+ "required": true
1567
+ }
1568
+ }
1569
+ }
1570
+ }
1571
+ },
1223
1572
  "ManagerFlow": {
1224
1573
  "id": "flow",
1225
1574
  "idCamelCase": "flow",
@@ -2095,6 +2444,49 @@
2095
2444
  }
2096
2445
  }
2097
2446
  },
2447
+ "ManagerGoogleAssistant": {
2448
+ "id": "google-assistant",
2449
+ "idCamelCase": "googleAssistant",
2450
+ "items": {},
2451
+ "operations": {
2452
+ "getOptionPinCode": {
2453
+ "method": "GET",
2454
+ "path": "/option/pinCode",
2455
+ "scopes": [
2456
+ "homey.system"
2457
+ ]
2458
+ },
2459
+ "setOptionPinCode": {
2460
+ "method": "PUT",
2461
+ "path": "/option/pinCode",
2462
+ "scopes": [
2463
+ "homey.system"
2464
+ ],
2465
+ "parameters": {
2466
+ "value": {
2467
+ "in": "body",
2468
+ "required": true
2469
+ }
2470
+ }
2471
+ },
2472
+ "unsetOptionPinCode": {
2473
+ "method": "DELETE",
2474
+ "path": "/option/pinCode",
2475
+ "scopes": [
2476
+ "homey.system"
2477
+ ]
2478
+ },
2479
+ "getState": {
2480
+ "method": "get",
2481
+ "path": "/state",
2482
+ "private": false,
2483
+ "scopes": [
2484
+ "homey.system.readonly"
2485
+ ],
2486
+ "parameters": {}
2487
+ }
2488
+ }
2489
+ },
2098
2490
  "ManagerI18n": {
2099
2491
  "id": "i18n",
2100
2492
  "idCamelCase": "i18n",
@@ -2612,6 +3004,12 @@
2612
3004
  "name": {
2613
3005
  "type": "string"
2614
3006
  },
3007
+ "preset": {
3008
+ "type": [
3009
+ "string",
3010
+ "null"
3011
+ ]
3012
+ },
2615
3013
  "zone": {
2616
3014
  "type": "string"
2617
3015
  },
@@ -2718,6 +3116,9 @@
2718
3116
  "devices": {
2719
3117
  "type": "object",
2720
3118
  "required": true
3119
+ },
3120
+ "preset": {
3121
+ "type": "string"
2721
3122
  }
2722
3123
  }
2723
3124
  }
@@ -2751,6 +3152,9 @@
2751
3152
  },
2752
3153
  "devices": {
2753
3154
  "type": "object"
3155
+ },
3156
+ "preset": {
3157
+ "type": "string"
2754
3158
  }
2755
3159
  }
2756
3160
  }
@@ -3316,7 +3720,12 @@
3316
3720
  "path": "/ping",
3317
3721
  "private": false,
3318
3722
  "scopes": [],
3319
- "parameters": {}
3723
+ "parameters": {
3724
+ "id": {
3725
+ "in": "query",
3726
+ "type": "string"
3727
+ }
3728
+ }
3320
3729
  },
3321
3730
  "getInfo": {
3322
3731
  "method": "get",
@@ -3762,6 +4171,28 @@
3762
4171
  }
3763
4172
  }
3764
4173
  }
4174
+ },
4175
+ "VirtualDriverEnergyDongle": {
4176
+ "id": "virtualdriverenergydongle",
4177
+ "schema": {
4178
+ "type": "object",
4179
+ "properties": {
4180
+ "id": {
4181
+ "type": "string"
4182
+ }
4183
+ }
4184
+ }
4185
+ },
4186
+ "VirtualDeviceEnergyDongle": {
4187
+ "id": "virtualdeviceenergydongle",
4188
+ "schema": {
4189
+ "type": "object",
4190
+ "properties": {
4191
+ "id": {
4192
+ "type": "string"
4193
+ }
4194
+ }
4195
+ }
3765
4196
  }
3766
4197
  },
3767
4198
  "operations": {
@@ -4106,4 +4537,4 @@
4106
4537
  }
4107
4538
  }
4108
4539
  }
4109
- }
4540
+ }