homey-api 3.6.7 → 3.7.0

package/assets/types/homey-api.private.d.ts

@@ -145,6 +145,8 @@ export namespace HomeyAPIV2.ManagerDashboards {
     settings: object;
 
     height: number | string;
+
+    transparent: boolean;
   }
 
   export class Dashboard extends HomeyAPIV3Local.ManagerDashboards.Dashboard {
@@ -154,6 +156,15 @@ export namespace HomeyAPIV2.ManagerDashboards {
 
     columns: Array<any>;
   }
+
+  export class WidgetStore extends HomeyAPIV3Local.ManagerDashboards
+    .WidgetStore {
+    id: string;
+
+    ownerUri: string;
+
+    state: object;
+  }
 }
 
 export namespace HomeyAPIV2.ManagerDevices {
@@ -715,14 +726,20 @@ export namespace HomeyAPIV3Cloud.ManagerCron {
 }
 
 export namespace HomeyAPIV3Cloud.ManagerDashboards {
+  export class AppWidget {
+    id: string;
+  }
+
   export class Dashboard {
     id: string;
 
     name: string;
 
-    widgets: object;
+    columns: Array<any>;
+  }
 
-    lines: object;
+  export class WidgetStore {
+    id: string;
   }
 }
 
@@ -965,6 +982,8 @@ export namespace HomeyAPIV3Cloud.ManagerMoods {
 
     name: string;
 
+    preset: string | null;
+
     zone: string;
 
     devices: object;
@@ -1014,6 +1033,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceEnergyDongle {
+    id: string;
+  }
+
   export class VirtualDeviceHomeyBridge {
     id: string;
   }
@@ -1034,6 +1057,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverEnergyDongle {
+    id: string;
+  }
+
   export class VirtualDriverHomeyBridge {
     id: string;
   }
@@ -1141,6 +1168,10 @@ export namespace HomeyAPIV3Local.ManagerDashboards {
 
     columns: Array<any>;
   }
+
+  export class WidgetStore {
+    id: string;
+  }
 }
 
 export namespace HomeyAPIV3Local.ManagerDevices {
@@ -1465,6 +1496,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceEnergyDongle {
+    id: string;
+  }
+
   export class VirtualDeviceHomeyBridge {
     id: string;
   }
@@ -1501,6 +1536,10 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverEnergyDongle {
+    id: string;
+  }
+
   export class VirtualDriverHomeyBridge {
     id: string;
   }
@@ -8370,9 +8409,7 @@ export namespace HomeyAPIV3Cloud {
       dashboard: {
         name: string;
 
-        widgets: object;
-
-        lines: object;
+        columns: Array<any>;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>;
 
@@ -8382,13 +8419,47 @@ export namespace HomeyAPIV3Cloud {
       dashboard: {
         name?: string;
 
-        widgets?: object;
-
-        lines?: object;
+        columns?: Array<any>;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>;
 
     deleteDashboard(opts: { id: string }): Promise<any>;
+
+    getAppWidgets(): Promise<{
+      [key: string]: HomeyAPIV3Cloud.ManagerDashboards.AppWidget;
+    }>;
+
+    getAppWidget(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Cloud.ManagerDashboards.AppWidget>;
+
+    getAppWidgetAutocomplete(opts: {
+      id: string;
+
+      settingId: string;
+
+      query: string;
+
+      settings?: object;
+    }): Promise<any>;
+
+    getWidgetStores(): Promise<{
+      [key: string]: HomeyAPIV3Cloud.ManagerDashboards.WidgetStore;
+    }>;
+
+    getWidgetStore(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>;
+
+    getWidgetStoreState(opts: { id: string }): Promise<any>;
+
+    setWidgetStoreState(opts: {
+      id: string;
+
+      state: object;
+
+      replace?: boolean;
+    }): Promise<any>;
   }
 
   export class ManagerDatabase extends HomeyAPIV3.ManagerDatabase {
@@ -8595,6 +8666,68 @@ export namespace HomeyAPIV3Cloud {
     getLiveReport(opts: { zone?: string }): Promise<any>;
   }
 
+  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
+    getOptionPhaseLoadNotificationSettings(): Promise<any>;
+
+    setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
+
+    unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
+
+    createAndUploadDiagnosticReport(opts: {
+      deviceId: string;
+
+      timeout?: number;
+    }): Promise<any>;
+
+    getNextFrame(opts: {
+      deviceId: string;
+
+      timeout?: string;
+    }): Promise<any>;
+
+    restartSettingsDiscovery(opts: { deviceId: string }): Promise<any>;
+
+    getUartConfig(opts: { deviceId: string }): Promise<any>;
+
+    setUartConfig(opts: {
+      deviceId?: string;
+
+      baudRate?: number;
+
+      dataBits?: number;
+
+      stopBits?: number;
+
+      parity?: string;
+
+      inverseRx?: boolean;
+
+      dataTimeoutMs?: number;
+
+      persistent?: boolean;
+    }): Promise<any>;
+
+    checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
+
+    installFirmwareUpdate(opts: {
+      deviceId: string;
+
+      updateThroughReboot?: boolean;
+    }): Promise<any>;
+
+    reboot(opts: { deviceId: string }): Promise<any>;
+
+    setPhaseLoadLimits(opts: {
+      deviceId: string;
+
+      phasesConfigured: number;
+
+      capacity: number;
+    }): Promise<any>;
+
+    getPhaseLoadLimits(opts: { deviceId: string }): Promise<any>;
+  }
+
   export class ManagerFlow extends HomeyAPIV3.ManagerFlow {
     getState(): Promise<any>;
 
@@ -8931,6 +9064,8 @@ export namespace HomeyAPIV3Cloud {
         name: string;
 
         devices: object;
+
+        preset?: string;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
 
@@ -8941,6 +9076,8 @@ export namespace HomeyAPIV3Cloud {
         name?: string;
 
         devices?: object;
+
+        preset?: string;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerMoods.Mood>;
 
@@ -9074,7 +9211,7 @@ export namespace HomeyAPIV3Cloud {
   export class ManagerSystem extends HomeyAPIV3.ManagerSystem {
     getState(): Promise<any>;
 
-    ping(): Promise<any>;
+    ping(opts: { id?: string }): Promise<any>;
 
     getInfo(): Promise<any>;
 
@@ -9948,6 +10085,10 @@ export namespace HomeyAPIV3Local {
       [key: string]: HomeyAPIV3Local.ManagerDashboards.AppWidget;
     }>;
 
+    getAppWidget(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDashboards.AppWidget>;
+
     getAppWidgetAutocomplete(opts: {
       id: string;
 
@@ -9957,6 +10098,24 @@ export namespace HomeyAPIV3Local {
 
       settings?: object;
     }): Promise<any>;
+
+    getWidgetStores(): Promise<{
+      [key: string]: HomeyAPIV3Local.ManagerDashboards.WidgetStore;
+    }>;
+
+    getWidgetStore(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDashboards.WidgetStore>;
+
+    getWidgetStoreState(opts: { id: string }): Promise<any>;
+
+    setWidgetStoreState(opts: {
+      id: string;
+
+      state: object;
+
+      replace?: boolean;
+    }): Promise<any>;
   }
 
   export class ManagerDatabase extends HomeyAPIV3.ManagerDatabase {
@@ -10181,6 +10340,68 @@ export namespace HomeyAPIV3Local {
     getLiveReport(opts: { zone?: string }): Promise<any>;
   }
 
+  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
+    getOptionPhaseLoadNotificationSettings(): Promise<any>;
+
+    setOptionPhaseLoadNotificationSettings(opts: { value: any }): Promise<any>;
+
+    unsetOptionPhaseLoadNotificationSettings(): Promise<any>;
+
+    createAndUploadDiagnosticReport(opts: {
+      deviceId: string;
+
+      timeout?: number;
+    }): Promise<any>;
+
+    getNextFrame(opts: {
+      deviceId: string;
+
+      timeout?: string;
+    }): Promise<any>;
+
+    restartSettingsDiscovery(opts: { deviceId: string }): Promise<any>;
+
+    getUartConfig(opts: { deviceId: string }): Promise<any>;
+
+    setUartConfig(opts: {
+      deviceId?: string;
+
+      baudRate?: number;
+
+      dataBits?: number;
+
+      stopBits?: number;
+
+      parity?: string;
+
+      inverseRx?: boolean;
+
+      dataTimeoutMs?: number;
+
+      persistent?: boolean;
+    }): Promise<any>;
+
+    checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
+
+    installFirmwareUpdate(opts: {
+      deviceId: string;
+
+      updateThroughReboot?: boolean;
+    }): Promise<any>;
+
+    reboot(opts: { deviceId: string }): Promise<any>;
+
+    setPhaseLoadLimits(opts: {
+      deviceId: string;
+
+      phasesConfigured: number;
+
+      capacity: number;
+    }): Promise<any>;
+
+    getPhaseLoadLimits(opts: { deviceId: string }): Promise<any>;
+  }
+
   export class ManagerExperiments extends HomeyAPIV3.ManagerExperiments {
     getState(): Promise<any>;
 
@@ -10537,6 +10758,14 @@ export namespace HomeyAPIV3Local {
     makeDeviceApi(opts: { nodeId: string }): Promise<any>;
 
     readBasicInformation(opts: { nodeId: string }): Promise<any>;
+
+    openCommissioningWindow(opts: {
+      deviceId: string;
+
+      timeout?: number;
+
+      revokeExisting?: boolean;
+    }): Promise<any>;
   }
 
   export class ManagerMobile extends HomeyAPIV3.ManagerMobile {
@@ -10744,9 +10973,17 @@ export namespace HomeyAPIV3Local {
 
     getActiveDataset(): Promise<any>;
 
-    reset(opts: { target?: string }): Promise<any>;
+    apiReset(): Promise<any>;
+
+    executeCommand(opts: {
+      command: string;
+
+      timeout?: number;
 
-    executeCommand(opts: { command: string }): Promise<any>;
+      flush?: boolean;
+
+      preventThreadSetup?: boolean;
+    }): Promise<any>;
 
     apiDisable(): Promise<any>;
 
@@ -10906,7 +11143,19 @@ export namespace HomeyAPIV3Local {
       opts?: object;
     }): Promise<any>;
 
-    flashFirmware(opts: { erase?: string }): Promise<any>;
+    getFirmwareVersion(): Promise<any>;
+
+    flashFirmware(opts: {
+      erase?: string;
+
+      downgrade?: string;
+
+      version?: string;
+
+      firmware?: string;
+
+      shasum?: string;
+    }): Promise<any>;
 
     getLog(): Promise<any>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.6.7",
+  "version": "3.7.0",
   "description": "Homey API",
   "main": "index.js",
   "files": [
@@ -76,6 +76,7 @@
     "jsdoc-ts-utils": "^4.0.0",
     "jsdoc-tsimport-plugin": "^1.0.5",
     "keypather": "^3.1.0",
+    "niodb": "^0.1.1",
     "plantuml-cli": "^1.2024.4",
     "prettier": "^3.2.5",
     "serve": "^14.0.1",