homey-api 3.6.7 → 3.7.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.
@@ -816,6 +816,17 @@
816
816
  }
817
817
  }
818
818
  }
819
+ },
820
+ "WidgetStore": {
821
+ "id": "widgetstore",
822
+ "schema": {
823
+ "type": "object",
824
+ "properties": {
825
+ "id": {
826
+ "type": "string"
827
+ }
828
+ }
829
+ }
819
830
  }
820
831
  },
821
832
  "operations": {
@@ -955,11 +966,32 @@
955
966
  },
956
967
  "parameters": {}
957
968
  },
969
+ "getAppWidget": {
970
+ "method": "get",
971
+ "path": "/appwidget/:id",
972
+ "private": false,
973
+ "scopes": [
974
+ "homey.dashboard.readonly"
975
+ ],
976
+ "crud": {
977
+ "type": "getOne",
978
+ "item": "AppWidget"
979
+ },
980
+ "parameters": {
981
+ "id": {
982
+ "in": "path",
983
+ "type": "string",
984
+ "required": true
985
+ }
986
+ }
987
+ },
958
988
  "getAppWidgetAutocomplete": {
959
989
  "method": "get",
960
990
  "path": "/appwidget/:id/autocomplete",
961
991
  "private": false,
962
- "scopes": [],
992
+ "scopes": [
993
+ "homey.dashboard.readonly"
994
+ ],
963
995
  "parameters": {
964
996
  "id": {
965
997
  "in": "path",
@@ -981,6 +1013,77 @@
981
1013
  "type": "object"
982
1014
  }
983
1015
  }
1016
+ },
1017
+ "getWidgetStores": {
1018
+ "method": "get",
1019
+ "path": "/widgetstore",
1020
+ "private": false,
1021
+ "scopes": [
1022
+ "homey.dashboard.readonly"
1023
+ ],
1024
+ "crud": {
1025
+ "type": "getAll",
1026
+ "item": "WidgetStore"
1027
+ },
1028
+ "parameters": {}
1029
+ },
1030
+ "getWidgetStore": {
1031
+ "method": "get",
1032
+ "path": "/widgetstore/:id",
1033
+ "private": false,
1034
+ "scopes": [
1035
+ "homey.dashboard.readonly"
1036
+ ],
1037
+ "crud": {
1038
+ "type": "getOne",
1039
+ "item": "WidgetStore"
1040
+ },
1041
+ "parameters": {
1042
+ "id": {
1043
+ "in": "path",
1044
+ "type": "string",
1045
+ "required": true
1046
+ }
1047
+ }
1048
+ },
1049
+ "getWidgetStoreState": {
1050
+ "method": "get",
1051
+ "path": "/widgetstore/:id/state",
1052
+ "private": false,
1053
+ "scopes": [
1054
+ "homey.dashboard.readonly"
1055
+ ],
1056
+ "parameters": {
1057
+ "id": {
1058
+ "in": "path",
1059
+ "type": "string",
1060
+ "required": true
1061
+ }
1062
+ }
1063
+ },
1064
+ "setWidgetStoreState": {
1065
+ "method": "post",
1066
+ "path": "/widgetstore/:id/state",
1067
+ "private": false,
1068
+ "scopes": [
1069
+ "homey.dashboard.readonly"
1070
+ ],
1071
+ "parameters": {
1072
+ "id": {
1073
+ "in": "path",
1074
+ "type": "string",
1075
+ "required": true
1076
+ },
1077
+ "state": {
1078
+ "in": "body",
1079
+ "type": "object",
1080
+ "required": true
1081
+ },
1082
+ "replace": {
1083
+ "in": "body",
1084
+ "type": "boolean"
1085
+ }
1086
+ }
984
1087
  }
985
1088
  }
986
1089
  },
@@ -1658,6 +1761,235 @@
1658
1761
  }
1659
1762
  }
1660
1763
  },
1764
+ "ManagerEnergyDongle": {
1765
+ "id": "energydongle",
1766
+ "idCamelCase": "energydongle",
1767
+ "items": {},
1768
+ "operations": {
1769
+ "getOptionPhaseLoadNotificationSettings": {
1770
+ "method": "GET",
1771
+ "path": "/option/phaseLoadNotificationSettings",
1772
+ "scopes": [
1773
+ "homey.system.readonly"
1774
+ ]
1775
+ },
1776
+ "setOptionPhaseLoadNotificationSettings": {
1777
+ "method": "PUT",
1778
+ "path": "/option/phaseLoadNotificationSettings",
1779
+ "scopes": [
1780
+ "homey.system"
1781
+ ],
1782
+ "parameters": {
1783
+ "value": {
1784
+ "in": "body",
1785
+ "required": true
1786
+ }
1787
+ }
1788
+ },
1789
+ "unsetOptionPhaseLoadNotificationSettings": {
1790
+ "method": "DELETE",
1791
+ "path": "/option/phaseLoadNotificationSettings",
1792
+ "scopes": [
1793
+ "homey.system"
1794
+ ]
1795
+ },
1796
+ "createAndUploadDiagnosticReport": {
1797
+ "method": "post",
1798
+ "path": "/:deviceId/diagnostic-report",
1799
+ "private": true,
1800
+ "scopes": [
1801
+ "homey.system.readonly"
1802
+ ],
1803
+ "parameters": {
1804
+ "deviceId": {
1805
+ "in": "path",
1806
+ "type": "string",
1807
+ "required": true
1808
+ },
1809
+ "timeout": {
1810
+ "in": "body",
1811
+ "type": "number"
1812
+ }
1813
+ }
1814
+ },
1815
+ "getNextFrame": {
1816
+ "method": "get",
1817
+ "path": "/:deviceId/next-frame",
1818
+ "private": true,
1819
+ "scopes": [
1820
+ "homey.system.readonly"
1821
+ ],
1822
+ "parameters": {
1823
+ "deviceId": {
1824
+ "in": "path",
1825
+ "type": "string",
1826
+ "required": true
1827
+ },
1828
+ "timeout": {
1829
+ "in": "query",
1830
+ "type": "string"
1831
+ }
1832
+ }
1833
+ },
1834
+ "restartSettingsDiscovery": {
1835
+ "method": "post",
1836
+ "path": "/:deviceId/restart-settings-discovery",
1837
+ "private": true,
1838
+ "scopes": [
1839
+ "homey.system"
1840
+ ],
1841
+ "parameters": {
1842
+ "deviceId": {
1843
+ "in": "path",
1844
+ "type": "string",
1845
+ "required": true
1846
+ }
1847
+ }
1848
+ },
1849
+ "getUartConfig": {
1850
+ "method": "get",
1851
+ "path": "/:deviceId/uart-config",
1852
+ "private": true,
1853
+ "scopes": [
1854
+ "homey.system.readonly"
1855
+ ],
1856
+ "parameters": {
1857
+ "deviceId": {
1858
+ "in": "path",
1859
+ "type": "string",
1860
+ "required": true
1861
+ }
1862
+ }
1863
+ },
1864
+ "setUartConfig": {
1865
+ "method": "post",
1866
+ "path": "/:deviceId/uart-config",
1867
+ "private": true,
1868
+ "scopes": [
1869
+ "homey.system"
1870
+ ],
1871
+ "parameters": {
1872
+ "deviceId": {
1873
+ "in": "path",
1874
+ "type": "string"
1875
+ },
1876
+ "baudRate": {
1877
+ "in": "body",
1878
+ "type": "number"
1879
+ },
1880
+ "dataBits": {
1881
+ "in": "body",
1882
+ "type": "number"
1883
+ },
1884
+ "stopBits": {
1885
+ "in": "body",
1886
+ "type": "number"
1887
+ },
1888
+ "parity": {
1889
+ "in": "body",
1890
+ "type": "string"
1891
+ },
1892
+ "inverseRx": {
1893
+ "in": "body",
1894
+ "type": "boolean"
1895
+ },
1896
+ "dataTimeoutMs": {
1897
+ "in": "body",
1898
+ "type": "number"
1899
+ },
1900
+ "persistent": {
1901
+ "in": "body",
1902
+ "type": "boolean"
1903
+ }
1904
+ }
1905
+ },
1906
+ "checkFirmwareUpdateAvailable": {
1907
+ "method": "get",
1908
+ "path": "/:deviceId/firmware-update",
1909
+ "private": true,
1910
+ "scopes": [
1911
+ "homey.system.readonly"
1912
+ ],
1913
+ "parameters": {
1914
+ "deviceId": {
1915
+ "in": "path",
1916
+ "type": "string",
1917
+ "required": true
1918
+ }
1919
+ }
1920
+ },
1921
+ "installFirmwareUpdate": {
1922
+ "method": "post",
1923
+ "path": "/:deviceId/firmware-update",
1924
+ "private": true,
1925
+ "scopes": [
1926
+ "homey.system"
1927
+ ],
1928
+ "parameters": {
1929
+ "deviceId": {
1930
+ "in": "path",
1931
+ "type": "string",
1932
+ "required": true
1933
+ },
1934
+ "updateThroughReboot": {
1935
+ "in": "body",
1936
+ "type": "boolean"
1937
+ }
1938
+ }
1939
+ },
1940
+ "reboot": {
1941
+ "method": "post",
1942
+ "path": "/:deviceId/reboot",
1943
+ "private": true,
1944
+ "scopes": [
1945
+ "homey.system"
1946
+ ],
1947
+ "parameters": {
1948
+ "deviceId": {
1949
+ "in": "path",
1950
+ "type": "string",
1951
+ "required": true
1952
+ }
1953
+ }
1954
+ },
1955
+ "setPhaseLoadLimits": {
1956
+ "method": "put",
1957
+ "path": "/:deviceId/phase-load",
1958
+ "private": true,
1959
+ "scopes": [],
1960
+ "parameters": {
1961
+ "deviceId": {
1962
+ "in": "path",
1963
+ "type": "string",
1964
+ "required": true
1965
+ },
1966
+ "phasesConfigured": {
1967
+ "in": "body",
1968
+ "type": "number",
1969
+ "required": true
1970
+ },
1971
+ "capacity": {
1972
+ "in": "body",
1973
+ "type": "number",
1974
+ "required": true
1975
+ }
1976
+ }
1977
+ },
1978
+ "getPhaseLoadLimits": {
1979
+ "method": "get",
1980
+ "path": "/:deviceId/phase-load",
1981
+ "private": true,
1982
+ "scopes": [],
1983
+ "parameters": {
1984
+ "deviceId": {
1985
+ "in": "path",
1986
+ "type": "string",
1987
+ "required": true
1988
+ }
1989
+ }
1990
+ }
1991
+ }
1992
+ },
1661
1993
  "ManagerExperiments": {
1662
1994
  "id": "experiments",
1663
1995
  "idCamelCase": "experiments",
@@ -3278,6 +3610,29 @@
3278
3610
  "required": true
3279
3611
  }
3280
3612
  }
3613
+ },
3614
+ "openCommissioningWindow": {
3615
+ "method": "post",
3616
+ "path": "/open-commissioning-window",
3617
+ "private": true,
3618
+ "scopes": [
3619
+ "homey.system"
3620
+ ],
3621
+ "parameters": {
3622
+ "deviceId": {
3623
+ "in": "body",
3624
+ "type": "string",
3625
+ "required": true
3626
+ },
3627
+ "timeout": {
3628
+ "in": "body",
3629
+ "type": "number"
3630
+ },
3631
+ "revokeExisting": {
3632
+ "in": "body",
3633
+ "type": "boolean"
3634
+ }
3635
+ }
3281
3636
  }
3282
3637
  }
3283
3638
  },
@@ -4237,19 +4592,14 @@
4237
4592
  ],
4238
4593
  "parameters": {}
4239
4594
  },
4240
- "reset": {
4595
+ "apiReset": {
4241
4596
  "method": "get",
4242
4597
  "path": "/reset",
4243
4598
  "private": true,
4244
4599
  "scopes": [
4245
4600
  "homey.system"
4246
4601
  ],
4247
- "parameters": {
4248
- "target": {
4249
- "in": "query",
4250
- "type": "string"
4251
- }
4252
- }
4602
+ "parameters": {}
4253
4603
  },
4254
4604
  "executeCommand": {
4255
4605
  "method": "post",
@@ -4263,6 +4613,18 @@
4263
4613
  "in": "body",
4264
4614
  "type": "string",
4265
4615
  "required": true
4616
+ },
4617
+ "timeout": {
4618
+ "in": "body",
4619
+ "type": "number"
4620
+ },
4621
+ "flush": {
4622
+ "in": "body",
4623
+ "type": "boolean"
4624
+ },
4625
+ "preventThreadSetup": {
4626
+ "in": "body",
4627
+ "type": "boolean"
4266
4628
  }
4267
4629
  }
4268
4630
  },
@@ -4773,6 +5135,28 @@
4773
5135
  }
4774
5136
  }
4775
5137
  },
5138
+ "VirtualDriverEnergyDongle": {
5139
+ "id": "virtualdriverenergydongle",
5140
+ "schema": {
5141
+ "type": "object",
5142
+ "properties": {
5143
+ "id": {
5144
+ "type": "string"
5145
+ }
5146
+ }
5147
+ }
5148
+ },
5149
+ "VirtualDeviceEnergyDongle": {
5150
+ "id": "virtualdeviceenergydongle",
5151
+ "schema": {
5152
+ "type": "object",
5153
+ "properties": {
5154
+ "id": {
5155
+ "type": "string"
5156
+ }
5157
+ }
5158
+ }
5159
+ },
4776
5160
  "VirtualDriverVirtualSocket": {
4777
5161
  "id": "virtualdrivervirtualsocket",
4778
5162
  "schema": {
@@ -5168,6 +5552,15 @@
5168
5552
  }
5169
5553
  }
5170
5554
  },
5555
+ "getFirmwareVersion": {
5556
+ "method": "get",
5557
+ "path": "/firmware-version",
5558
+ "private": true,
5559
+ "scopes": [
5560
+ "homey.system"
5561
+ ],
5562
+ "parameters": {}
5563
+ },
5171
5564
  "flashFirmware": {
5172
5565
  "method": "put",
5173
5566
  "path": "/flash-firmware",
@@ -5177,7 +5570,23 @@
5177
5570
  ],
5178
5571
  "parameters": {
5179
5572
  "erase": {
5180
- "in": "query",
5573
+ "in": "body",
5574
+ "type": "string"
5575
+ },
5576
+ "downgrade": {
5577
+ "in": "body",
5578
+ "type": "string"
5579
+ },
5580
+ "version": {
5581
+ "in": "body",
5582
+ "type": "string"
5583
+ },
5584
+ "firmware": {
5585
+ "in": "body",
5586
+ "type": "string"
5587
+ },
5588
+ "shasum": {
5589
+ "in": "body",
5181
5590
  "type": "string"
5182
5591
  }
5183
5592
  }
@@ -950,6 +950,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
950
950
  id: string;
951
951
  }
952
952
 
953
+ export class VirtualDeviceEnergyDongle {
954
+ id: string;
955
+ }
956
+
953
957
  export class VirtualDeviceHomeyBridge {
954
958
  id: string;
955
959
  }
@@ -970,6 +974,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
970
974
  id: string;
971
975
  }
972
976
 
977
+ export class VirtualDriverEnergyDongle {
978
+ id: string;
979
+ }
980
+
973
981
  export class VirtualDriverHomeyBridge {
974
982
  id: string;
975
983
  }
@@ -1373,6 +1381,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
1373
1381
  id: string;
1374
1382
  }
1375
1383
 
1384
+ export class VirtualDeviceEnergyDongle {
1385
+ id: string;
1386
+ }
1387
+
1376
1388
  export class VirtualDeviceHomeyBridge {
1377
1389
  id: string;
1378
1390
  }
@@ -1409,6 +1421,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
1409
1421
  id: string;
1410
1422
  }
1411
1423
 
1424
+ export class VirtualDriverEnergyDongle {
1425
+ id: string;
1426
+ }
1427
+
1412
1428
  export class VirtualDriverHomeyBridge {
1413
1429
  id: string;
1414
1430
  }
@@ -2091,6 +2107,14 @@ export namespace HomeyAPIV3Cloud {
2091
2107
  getLiveReport(opts: { zone?: string }): Promise<any>;
2092
2108
  }
2093
2109
 
2110
+ export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
2111
+ getOptionPhaseLoadNotificationSettings(): Promise<any>;
2112
+
2113
+ setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
2114
+
2115
+ unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
2116
+ }
2117
+
2094
2118
  export class ManagerFlow extends HomeyAPIV3.ManagerFlow {
2095
2119
  getState(): Promise<any>;
2096
2120
 
@@ -2540,7 +2564,7 @@ export namespace HomeyAPIV3Cloud {
2540
2564
  export class ManagerSystem extends HomeyAPIV3.ManagerSystem {
2541
2565
  getState(): Promise<any>;
2542
2566
 
2543
- ping(): Promise<any>;
2567
+ ping(opts: { id?: string }): Promise<any>;
2544
2568
 
2545
2569
  getInfo(): Promise<any>;
2546
2570
 
@@ -3563,6 +3587,14 @@ export namespace HomeyAPIV3Local {
3563
3587
  getLiveReport(opts: { zone?: string }): Promise<any>;
3564
3588
  }
3565
3589
 
3590
+ export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
3591
+ getOptionPhaseLoadNotificationSettings(): Promise<any>;
3592
+
3593
+ setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
3594
+
3595
+ unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
3596
+ }
3597
+
3566
3598
  export class ManagerExperiments extends HomeyAPIV3.ManagerExperiments {
3567
3599
  getState(): Promise<any>;
3568
3600