homey-api 1.10.6 → 1.10.8

package/assets/specifications/HomeyAPIV3Cloud.json

@@ -66,6 +66,25 @@
           },
           "parameters": {}
         },
+        "getApp": {
+          "method": "get",
+          "path": "/app/:id",
+          "private": false,
+          "scopes": [
+            "homey.app.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "App"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "installFromAppStore": {
           "method": "post",
           "path": "/store",
@@ -140,7 +159,7 @@
           }
         },
         "setAppSetting": {
-          "method": "get",
+          "method": "put",
           "path": "/app/:id/setting/:name",
           "private": false,
           "scopes": [
@@ -164,6 +183,26 @@
             }
           }
         },
+        "unsetAppSetting": {
+          "method": "delete",
+          "path": "/app/:id/setting/:name",
+          "private": false,
+          "scopes": [
+            "homey.app.control"
+          ],
+          "parameters": {
+            "name": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getAppStd": {
           "method": "post",
           "path": "/app/:id/crashlog",
@@ -325,6 +364,15 @@
           ],
           "parameters": {}
         },
+        "getLog": {
+          "method": "get",
+          "path": "/bridge/log",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
+        },
         "pairBridge": {
           "method": "post",
           "path": "/bridge",
@@ -744,6 +792,9 @@
                 },
                 "virtualClass": {
                   "type": "string"
+                },
+                "uiIndicator": {
+                  "type": "string"
                 }
               }
             }
@@ -1041,8 +1092,7 @@
             },
             "data": {
               "in": "body",
-              "type": "object",
-              "required": true
+              "type": "object"
             }
           }
         },
@@ -1066,8 +1116,7 @@
             },
             "data": {
               "in": "body",
-              "type": "object",
-              "required": true
+              "type": "object"
             }
           }
         },
@@ -1091,8 +1140,7 @@
               "required": true,
               "properties": {
                 "name": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "data": {
                   "required": true
@@ -1622,6 +1670,10 @@
               "in": "body",
               "type": "object"
             },
+            "state": {
+              "in": "body",
+              "type": "object"
+            },
             "droptoken": {
               "in": "body",
               "type": "string"
@@ -1667,6 +1719,10 @@
               "in": "body",
               "type": "object"
             },
+            "state": {
+              "in": "body",
+              "type": "object"
+            },
             "droptoken": {
               "in": "body",
               "type": "string"
@@ -1807,6 +1863,21 @@
               "required": true
             }
           }
+        },
+        "triggerAdvancedFlow": {
+          "method": "post",
+          "path": "/advancedflow/:id/trigger",
+          "private": false,
+          "scopes": [
+            "homey.flow.start"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -1856,16 +1927,16 @@
       "idCamelCase": "geolocation",
       "items": {},
       "operations": {
-        "getOptionMode": {
+        "getOptionAddress": {
           "method": "GET",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation.readonly"
           ]
         },
-        "setOptionMode": {
+        "setOptionAddress": {
           "method": "PUT",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation"
           ],
@@ -1876,9 +1947,9 @@
             }
           }
         },
-        "unsetOptionMode": {
+        "unsetOptionAddress": {
           "method": "DELETE",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation"
           ]
@@ -1910,6 +1981,33 @@
             "homey.geolocation"
           ]
         },
+        "getOptionMode": {
+          "method": "GET",
+          "path": "/option/mode",
+          "scopes": [
+            "homey.geolocation.readonly"
+          ]
+        },
+        "setOptionMode": {
+          "method": "PUT",
+          "path": "/option/mode",
+          "scopes": [
+            "homey.geolocation"
+          ],
+          "parameters": {
+            "value": {
+              "in": "body",
+              "required": true
+            }
+          }
+        },
+        "unsetOptionMode": {
+          "method": "DELETE",
+          "path": "/option/mode",
+          "scopes": [
+            "homey.geolocation"
+          ]
+        },
         "getState": {
           "method": "get",
           "path": "/state",
@@ -2688,6 +2786,26 @@
             }
           }
         },
+        "replay": {
+          "method": "post",
+          "path": "/replay",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "frequency": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "data": {
+              "in": "body",
+              "type": "array",
+              "required": true
+            }
+          }
+        },
         "emulate": {
           "method": "post",
           "path": "/:frequency/emulate",
@@ -3213,8 +3331,8 @@
       "id": "vdevice",
       "idCamelCase": "vdevice",
       "items": {
-        "VirtualDriverVirtualSocket": {
-          "id": "virtualdrivervirtualsocket",
+        "VirtualDriverDummySocket": {
+          "id": "virtualdriverdummysocket",
           "schema": {
             "type": "object",
             "properties": {
@@ -3224,8 +3342,8 @@
             }
           }
         },
-        "VirtualDeviceVirtualSocket": {
-          "id": "virtualdevicevirtualsocket",
+        "VirtualDeviceDummySocket": {
+          "id": "virtualdevicedummysocket",
           "schema": {
             "type": "object",
             "properties": {
@@ -3472,16 +3590,13 @@
               "required": true,
               "properties": {
                 "name": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "icon": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "parent": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 }
               }
             }

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

@@ -2095,7 +2095,7 @@
   
     export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
       
-  export class VirtualDeviceHomeyBridge  {
+  export class VirtualDeviceDummySocket  {
     
 
     
@@ -2105,7 +2105,7 @@
     
   }
 
-  export class VirtualDeviceInfrared  {
+  export class VirtualDeviceHomeyBridge  {
     
 
     
@@ -2115,7 +2115,7 @@
     
   }
 
-  export class VirtualDeviceVirtualSocket  {
+  export class VirtualDeviceInfrared  {
     
 
     
@@ -2145,7 +2145,7 @@
     
   }
 
-  export class VirtualDriverHomeyBridge  {
+  export class VirtualDriverDummySocket  {
     
 
     
@@ -2155,7 +2155,7 @@
     
   }
 
-  export class VirtualDriverInfrared  {
+  export class VirtualDriverHomeyBridge  {
     
 
     
@@ -2165,7 +2165,7 @@
     
   }
 
-  export class VirtualDriverVirtualSocket  {
+  export class VirtualDriverInfrared  {
     
 
     
@@ -3127,6 +3127,25 @@
     
       getApps(
         
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerApps.App>;
+    
+      getApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Cloud.ManagerApps.App>;
     
@@ -3238,6 +3257,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      unsetAppSetting(
+        
+          
+  
+    
+      opts: {
+  
+    
+      name: string,
+    
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -3451,6 +3493,11 @@
     
       getBridges(
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
       ):
         Promise<any>;
     
@@ -3657,6 +3704,10 @@
       virtualClass: string,
     
   
+    
+      uiIndicator: string,
+    
+  
 },
     
   
@@ -4514,6 +4565,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -4554,6 +4609,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -4679,6 +4738,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      triggerAdvancedFlow(
+        
+          
+  
+    
       opts: {
   
     
@@ -4749,12 +4827,12 @@
     
 
     
-      getOptionMode(
+      getOptionAddress(
         
       ):
         Promise<any>;
     
-      setOptionMode(
+      setOptionAddress(
         
           
   
@@ -4773,7 +4851,7 @@
       ):
         Promise<any>;
     
-      unsetOptionMode(
+      unsetOptionAddress(
         
       ):
         Promise<any>;
@@ -4804,6 +4882,35 @@
     
       unsetOptionLocation(
         
+      ):
+        Promise<any>;
+    
+      getOptionMode(
+        
+      ):
+        Promise<any>;
+    
+      setOptionMode(
+        
+          
+  
+    
+      opts: {
+  
+    
+      value: *,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      unsetOptionMode(
+        
       ):
         Promise<any>;
     
@@ -5594,6 +5701,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      replay(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

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

@@ -7477,7 +7477,7 @@
   
     export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
       
-  export class VirtualDeviceHomeyBridge  {
+  export class VirtualDeviceDummySocket  {
     
 
     
@@ -7487,7 +7487,7 @@
     
   }
 
-  export class VirtualDeviceInfrared  {
+  export class VirtualDeviceHomeyBridge  {
     
 
     
@@ -7497,7 +7497,7 @@
     
   }
 
-  export class VirtualDeviceVirtualSocket  {
+  export class VirtualDeviceInfrared  {
     
 
     
@@ -7527,7 +7527,7 @@
     
   }
 
-  export class VirtualDriverHomeyBridge  {
+  export class VirtualDriverDummySocket  {
     
 
     
@@ -7537,7 +7537,7 @@
     
   }
 
-  export class VirtualDriverInfrared  {
+  export class VirtualDriverHomeyBridge  {
     
 
     
@@ -7547,7 +7547,7 @@
     
   }
 
-  export class VirtualDriverVirtualSocket  {
+  export class VirtualDriverInfrared  {
     
 
     
@@ -8529,6 +8529,25 @@
     
       getApps(
         
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerApps.App>;
+    
+      getApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Cloud.ManagerApps.App>;
     
@@ -8640,6 +8659,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      unsetAppSetting(
+        
+          
+  
+    
+      opts: {
+  
+    
+      name: string,
+    
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -8853,6 +8895,11 @@
     
       getBridges(
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
       ):
         Promise<any>;
     
@@ -9200,6 +9247,10 @@
       virtualClass: string,
     
   
+    
+      uiIndicator: string,
+    
+  
 },
     
   
@@ -10057,6 +10108,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -10097,6 +10152,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -10222,6 +10281,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      triggerAdvancedFlow(
+        
+          
+  
+    
       opts: {
   
     
@@ -10292,12 +10370,12 @@
     
 
     
-      getOptionMode(
+      getOptionAddress(
         
       ):
         Promise<any>;
     
-      setOptionMode(
+      setOptionAddress(
         
           
   
@@ -10316,7 +10394,7 @@
       ):
         Promise<any>;
     
-      unsetOptionMode(
+      unsetOptionAddress(
         
       ):
         Promise<any>;
@@ -10347,6 +10425,35 @@
     
       unsetOptionLocation(
         
+      ):
+        Promise<any>;
+    
+      getOptionMode(
+        
+      ):
+        Promise<any>;
+    
+      setOptionMode(
+        
+          
+  
+    
+      opts: {
+  
+    
+      value: *,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      unsetOptionMode(
+        
       ):
         Promise<any>;
     
@@ -11137,6 +11244,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      replay(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     

package/lib/HomeyAPI/HomeyAPIV2/Device.js

@@ -48,7 +48,11 @@ class Device extends Item {
       this.__capabilityInstances[capabilityId] = this.__capabilityInstances[capabilityId] || [];
       this.__capabilityInstances[capabilityId] = this.__capabilityInstances[capabilityId].filter(i => i !== instance);
 
-      if (Object.keys(this.__capabilityInstances[capabilityId]).length === 0) {
+      if (this.__capabilityInstances[capabilityId].length === 0) {
+        delete this.__capabilityInstances[capabilityId];
+      }
+
+      if (Object.keys(this.__capabilityInstances).length === 0) {
         this.__debug('No more Capability instances, disconnecting...');
         this.disconnect().catch(err => this.__debug(err));
       }

package/lib/HomeyAPI/HomeyAPIV2/DeviceCapability.js

@@ -104,6 +104,13 @@ class DeviceCapability extends EventEmitter {
     this.__value = value;
     this.__lastChanged = new Date(transactionTime);
 
+    // Mutate the current device capabilitiesObj so it always reflects the last value.
+    const capabilityReference = this.device.capabilitiesObj && this.device.capabilitiesObj[this.id];
+    if (capabilityReference) {
+      capabilityReference.value = value;
+      capabilityReference.lastUpdated = this.__lastChanged.toISOString();
+    }
+
     this.__listener(value);
   }
 
@@ -152,6 +159,13 @@ class DeviceCapability extends EventEmitter {
 
     this.__value = value;
     this.__lastChanged = new Date();
+
+    // Mutate the current device capabilitiesObj so it always reflects the last value.
+    const capabilityReference = this.device.capabilitiesObj && this.device.capabilitiesObj[this.id];
+    if (capabilityReference) {
+      capabilityReference.value = value;
+      capabilityReference.lastUpdated = this.__lastChanged.toISOString();
+    }
   }
 
 }

package/lib/HomeyAPI/HomeyAPIV2/Item.js

@@ -74,6 +74,10 @@ class Item extends EventEmitter {
 
     // If disconnecting, await that first
     try {
+      // Ensure all microtasks are done first. E.g. if disconnect is called in the same tick as
+      // connect. This way the disconnect is always started first so we can await the disconnect
+      // promise before we try to connect again.
+      await Promise.resolve();
       await this.__disconnectPromise;
     } catch (err) { }
 
@@ -141,6 +145,8 @@ class Item extends EventEmitter {
       .catch(() => { })
       .finally(() => {
         delete this.__disconnectPromise;
+        // Delete this.io so connect can start new connections.
+        delete this.io;
       });
 
     await this.__disconnectPromise;

package/lib/HomeyAPI/HomeyAPIV2.js

@@ -655,7 +655,7 @@ class HomeyAPIV2 extends HomeyAPI {
         this.__io = null;
       });
     }
-    // TODO
+    // TODO todo what?
   }
 
   destroy() {

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const Manager = require('./Manager');
+
+class ManagerFlow extends Manager {
+
+  async getFlowCardTrigger(args = {}, ...rest) {
+    args.uri = '';
+    return this.__super__getFlowCardTrigger(args, ...rest);
+  }
+
+  async getFlowCardCondition(args = {}, ...rest) {
+    args.uri = '';
+    return this.__super__getFlowCardCondition(args, ...rest);
+  }
+
+  async runFlowCardCondition(args = {}, ...rest) {
+    args.uri = '';
+    return this.__super__runFlowCardCondition(args, ...rest);
+  }
+
+  async getFlowCardAction(args = {}, ...rest) {
+    args.uri = '';
+    return this.__super__getFlowCardAction(args, ...rest);
+  }
+
+  async runFlowCardAction(args = {}, ...rest) {
+    args.uri = '';
+    return this.__super__runFlowCardAction(args, ...rest);
+  }
+
+}
+
+module.exports = ManagerFlow;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -2,6 +2,8 @@
 
 const HomeyAPIV2 = require('./HomeyAPIV2');
 
+const ManagerFlow = require('./HomeyAPIV3/ManagerFlow');
+
 /**
  * @class
  * @hideconstructor
@@ -9,6 +11,11 @@ const HomeyAPIV2 = require('./HomeyAPIV2');
  */
 class HomeyAPIV3 extends HomeyAPIV2 {
 
+  static MANAGERS = {
+    ...HomeyAPIV2.MANAGERS,
+    ManagerFlow,
+  };
+
 }
 
 module.exports = HomeyAPIV3;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "1.10.6",
+  "version": "1.10.8",
   "description": "Homey API",
   "main": "index.js",
   "files": [