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.
@@ -726,14 +726,20 @@ export namespace HomeyAPIV3Cloud.ManagerCron {
726
726
  }
727
727
 
728
728
  export namespace HomeyAPIV3Cloud.ManagerDashboards {
729
+ export class AppWidget {
730
+ id: string;
731
+ }
732
+
729
733
  export class Dashboard {
730
734
  id: string;
731
735
 
732
736
  name: string;
733
737
 
734
- widgets: object;
738
+ columns: Array<any>;
739
+ }
735
740
 
736
- lines: object;
741
+ export class WidgetStore {
742
+ id: string;
737
743
  }
738
744
  }
739
745
 
@@ -976,6 +982,8 @@ export namespace HomeyAPIV3Cloud.ManagerMoods {
976
982
 
977
983
  name: string;
978
984
 
985
+ preset: string | null;
986
+
979
987
  zone: string;
980
988
 
981
989
  devices: object;
@@ -1025,6 +1033,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
1025
1033
  id: string;
1026
1034
  }
1027
1035
 
1036
+ export class VirtualDeviceEnergyDongle {
1037
+ id: string;
1038
+ }
1039
+
1028
1040
  export class VirtualDeviceHomeyBridge {
1029
1041
  id: string;
1030
1042
  }
@@ -1045,6 +1057,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
1045
1057
  id: string;
1046
1058
  }
1047
1059
 
1060
+ export class VirtualDriverEnergyDongle {
1061
+ id: string;
1062
+ }
1063
+
1048
1064
  export class VirtualDriverHomeyBridge {
1049
1065
  id: string;
1050
1066
  }
@@ -1480,6 +1496,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
1480
1496
  id: string;
1481
1497
  }
1482
1498
 
1499
+ export class VirtualDeviceEnergyDongle {
1500
+ id: string;
1501
+ }
1502
+
1483
1503
  export class VirtualDeviceHomeyBridge {
1484
1504
  id: string;
1485
1505
  }
@@ -1516,6 +1536,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
1516
1536
  id: string;
1517
1537
  }
1518
1538
 
1539
+ export class VirtualDriverEnergyDongle {
1540
+ id: string;
1541
+ }
1542
+
1519
1543
  export class VirtualDriverHomeyBridge {
1520
1544
  id: string;
1521
1545
  }
@@ -8385,9 +8409,7 @@ export namespace HomeyAPIV3Cloud {
8385
8409
  dashboard: {
8386
8410
  name: string;
8387
8411
 
8388
- widgets: object;
8389
-
8390
- lines: object;
8412
+ columns: Array<any>;
8391
8413
  };
8392
8414
  }): Promise<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>;
8393
8415
 
@@ -8397,13 +8419,47 @@ export namespace HomeyAPIV3Cloud {
8397
8419
  dashboard: {
8398
8420
  name?: string;
8399
8421
 
8400
- widgets?: object;
8401
-
8402
- lines?: object;
8422
+ columns?: Array<any>;
8403
8423
  };
8404
8424
  }): Promise<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>;
8405
8425
 
8406
8426
  deleteDashboard(opts: { id: string }): Promise<any>;
8427
+
8428
+ getAppWidgets(): Promise<{
8429
+ [key: string]: HomeyAPIV3Cloud.ManagerDashboards.AppWidget;
8430
+ }>;
8431
+
8432
+ getAppWidget(opts: {
8433
+ id: string;
8434
+ }): Promise<HomeyAPIV3Cloud.ManagerDashboards.AppWidget>;
8435
+
8436
+ getAppWidgetAutocomplete(opts: {
8437
+ id: string;
8438
+
8439
+ settingId: string;
8440
+
8441
+ query: string;
8442
+
8443
+ settings?: object;
8444
+ }): Promise<any>;
8445
+
8446
+ getWidgetStores(): Promise<{
8447
+ [key: string]: HomeyAPIV3Cloud.ManagerDashboards.WidgetStore;
8448
+ }>;
8449
+
8450
+ getWidgetStore(opts: {
8451
+ id: string;
8452
+ }): Promise<HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>;
8453
+
8454
+ getWidgetStoreState(opts: { id: string }): Promise<any>;
8455
+
8456
+ setWidgetStoreState(opts: {
8457
+ id: string;
8458
+
8459
+ state: object;
8460
+
8461
+ replace?: boolean;
8462
+ }): Promise<any>;
8407
8463
  }
8408
8464
 
8409
8465
  export class ManagerDatabase extends HomeyAPIV3.ManagerDatabase {
@@ -8610,6 +8666,68 @@ export namespace HomeyAPIV3Cloud {
8610
8666
  getLiveReport(opts: { zone?: string }): Promise<any>;
8611
8667
  }
8612
8668
 
8669
+ export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
8670
+ getOptionPhaseLoadNotificationSettings(): Promise<any>;
8671
+
8672
+ setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
8673
+
8674
+ unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
8675
+
8676
+ createAndUploadDiagnosticReport(opts: {
8677
+ deviceId: string;
8678
+
8679
+ timeout?: number;
8680
+ }): Promise<any>;
8681
+
8682
+ getNextFrame(opts: {
8683
+ deviceId: string;
8684
+
8685
+ timeout?: string;
8686
+ }): Promise<any>;
8687
+
8688
+ restartSettingsDiscovery(opts: { deviceId: string }): Promise<any>;
8689
+
8690
+ getUartConfig(opts: { deviceId: string }): Promise<any>;
8691
+
8692
+ setUartConfig(opts: {
8693
+ deviceId?: string;
8694
+
8695
+ baudRate?: number;
8696
+
8697
+ dataBits?: number;
8698
+
8699
+ stopBits?: number;
8700
+
8701
+ parity?: string;
8702
+
8703
+ inverseRx?: boolean;
8704
+
8705
+ dataTimeoutMs?: number;
8706
+
8707
+ persistent?: boolean;
8708
+ }): Promise<any>;
8709
+
8710
+ checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
8711
+
8712
+ installFirmwareUpdate(opts: {
8713
+ deviceId: string;
8714
+
8715
+ updateThroughReboot?: boolean;
8716
+ }): Promise<any>;
8717
+
8718
+ reboot(opts: { deviceId: string }): Promise<any>;
8719
+
8720
+ setPhaseLoadLimits(opts: {
8721
+ deviceId: string;
8722
+
8723
+ phasesConfigured: number;
8724
+
8725
+ capacity: number;
8726
+ }): Promise<any>;
8727
+
8728
+ getPhaseLoadLimits(opts: { deviceId: string }): Promise<any>;
8729
+ }
8730
+
8613
8731
  export class ManagerFlow extends HomeyAPIV3.ManagerFlow {
8614
8732
  getState(): Promise<any>;
8615
8733
 
@@ -8826,6 +8944,16 @@ export namespace HomeyAPIV3Cloud {
8826
8944
  getState(): Promise<any>;
8827
8945
  }
8828
8946
 
8947
+ export class ManagerGoogleAssistant extends HomeyAPIV3.ManagerGoogleAssistant {
8948
+ getOptionPinCode(): Promise<any>;
8949
+
8950
+ setOptionPinCode(opts: { value: any }): Promise<any>;
8951
+
8952
+ unsetOptionPinCode(): Promise<any>;
8953
+
8954
+ getState(): Promise<any>;
8955
+ }
8956
+
8829
8957
  export class ManagerI18n extends HomeyAPIV3.ManagerI18n {
8830
8958
  getOptionLanguage(): Promise<any>;
8831
8959
 
@@ -8946,6 +9074,8 @@ export namespace HomeyAPIV3Cloud {
8946
9074
  name: string;
8947
9075
 
8948
9076
  devices: object;
9077
+
9078
+ preset?: string;
8949
9079
  };
8950
9080
  }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
8951
9081
 
@@ -8956,6 +9086,8 @@ export namespace HomeyAPIV3Cloud {
8956
9086
  name?: string;
8957
9087
 
8958
9088
  devices?: object;
9089
+
9090
+ preset?: string;
8959
9091
  };
8960
9092
  }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
8961
9093
 
@@ -9089,7 +9221,7 @@ export namespace HomeyAPIV3Cloud {
9089
9221
  export class ManagerSystem extends HomeyAPIV3.ManagerSystem {
9090
9222
  getState(): Promise<any>;
9091
9223
 
9092
- ping(): Promise<any>;
9224
+ ping(opts: { id?: string }): Promise<any>;
9093
9225
 
9094
9226
  getInfo(): Promise<any>;
9095
9227
 
@@ -10218,6 +10350,68 @@ export namespace HomeyAPIV3Local {
10218
10350
  getLiveReport(opts: { zone?: string }): Promise<any>;
10219
10351
  }
10220
10352
 
10353
+ export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
10354
+ getOptionPhaseLoadNotificationSettings(): Promise<any>;
10355
+
10356
+ setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
10357
+
10358
+ unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
10359
+
10360
+ createAndUploadDiagnosticReport(opts: {
10361
+ deviceId: string;
10362
+
10363
+ timeout?: number;
10364
+ }): Promise<any>;
10365
+
10366
+ getNextFrame(opts: {
10367
+ deviceId: string;
10368
+
10369
+ timeout?: string;
10370
+ }): Promise<any>;
10371
+
10372
+ restartSettingsDiscovery(opts: { deviceId: string }): Promise<any>;
10373
+
10374
+ getUartConfig(opts: { deviceId: string }): Promise<any>;
10375
+
10376
+ setUartConfig(opts: {
10377
+ deviceId?: string;
10378
+
10379
+ baudRate?: number;
10380
+
10381
+ dataBits?: number;
10382
+
10383
+ stopBits?: number;
10384
+
10385
+ parity?: string;
10386
+
10387
+ inverseRx?: boolean;
10388
+
10389
+ dataTimeoutMs?: number;
10390
+
10391
+ persistent?: boolean;
10392
+ }): Promise<any>;
10393
+
10394
+ checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
10395
+
10396
+ installFirmwareUpdate(opts: {
10397
+ deviceId: string;
10398
+
10399
+ updateThroughReboot?: boolean;
10400
+ }): Promise<any>;
10401
+
10402
+ reboot(opts: { deviceId: string }): Promise<any>;
10403
+
10404
+ setPhaseLoadLimits(opts: {
10405
+ deviceId: string;
10406
+
10407
+ phasesConfigured: number;
10408
+
10409
+ capacity: number;
10410
+ }): Promise<any>;
10411
+
10412
+ getPhaseLoadLimits(opts: { deviceId: string }): Promise<any>;
10413
+ }
10414
+
10221
10415
  export class ManagerExperiments extends HomeyAPIV3.ManagerExperiments {
10222
10416
  getState(): Promise<any>;
10223
10417
 
@@ -10445,6 +10639,12 @@ export namespace HomeyAPIV3Local {
10445
10639
  }
10446
10640
 
10447
10641
  export class ManagerGoogleAssistant extends HomeyAPIV3.ManagerGoogleAssistant {
10642
+ getOptionPinCode(): Promise<any>;
10643
+
10644
+ setOptionPinCode(opts: { value: any }): Promise<any>;
10645
+
10646
+ unsetOptionPinCode(): Promise<any>;
10647
+
10448
10648
  getOptionEnabled(): Promise<any>;
10449
10649
 
10450
10650
  setOptionEnabled(opts: { value: any }): Promise<any>;
@@ -10959,7 +11159,19 @@ export namespace HomeyAPIV3Local {
10959
11159
  opts?: object;
10960
11160
  }): Promise<any>;
10961
11161
 
10962
- flashFirmware(opts: { erase?: string }): Promise<any>;
11162
+ getFirmwareVersion(): Promise<any>;
11163
+
11164
+ flashFirmware(opts: {
11165
+ erase?: string;
11166
+
11167
+ downgrade?: string;
11168
+
11169
+ version?: string;
11170
+
11171
+ firmware?: string;
11172
+
11173
+ shasum?: string;
11174
+ }): Promise<any>;
10963
11175
 
10964
11176
  getLog(): Promise<any>;
10965
11177
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "homey-api",
3
- "version": "3.6.8",
3
+ "version": "3.8.0",
4
4
  "description": "Homey API",
5
5
  "main": "index.js",
6
6
  "files": [
@@ -76,6 +76,7 @@
76
76
  "jsdoc-ts-utils": "^4.0.0",
77
77
  "jsdoc-tsimport-plugin": "^1.0.5",
78
78
  "keypather": "^3.1.0",
79
+ "niodb": "^0.1.1",
79
80
  "plantuml-cli": "^1.2024.4",
80
81
  "prettier": "^3.2.5",
81
82
  "serve": "^14.0.1",