Merge pull request #54 from alydersen/feature/dim_duration

Adding dimming duration, updating docs and bump to 1.1.0

.homeychangelog.json

@@ -181,5 +181,8 @@
   },
   "1.0.9": {
     "en": "Adding DLP Panels as temperature sensors"
+  },
+  "1.1.0": {
+    "en": "Dimming durations on flows (gradually turning on dimmers over x seconds)"
   }
 }

.homeycompose/app.json

@@ -1,6 +1,6 @@
 {
   "id": "com.github.alydersen.hdl-smartbus-homey",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "compatibility": ">=5.0.0",
   "sdk": 3,
   "name": {

DEVICES_DIMMERS.md

@@ -5,5 +5,8 @@ A dimmer controller have one or more dimmers as channels. Different HDL Models h
 
 Dimmers are a built-in capability in Homey, and as such have very good Homey support.
 
+# Dimming with a duration
+The dimmers supports going from the current dimming level to a new level over a time span when defined in a flow. This means that you can e.g. dim up your lights in the bedroom from off to 100% in intervals over 60 seconds. Notice that it always will be divided into 10 chunks. So in the bedroom example above, that would mean that it would increment with 10% every 6 seconds. You can also dim down over a period of time, but as flow generally will not care what the level is before it starts, you can only be sure that it will end up at what dimming level you set in the flow. These kind of calls are asyncronous, meaning that it will allow the app to act normally and update other devices while this is going on.
+
 ## Good to know
 Homey operates with a dimming level of 0-100, whereas HDL operates with 0 to 1. This means that HDLs state of a dimmer channel of 0.4 will be equall to Homeys 40 (this is handled by the app). Dimmers in Homey can also receive simple ON/OFF, and the app fixes this by calling the "OFF" state when dim level is 0 and "ON" when everything above.

DEVICES_PANELS.md

@@ -0,0 +1,10 @@
+[Back to the main page](index.md)
+
+# DLP Panels
+Even though the panels have a lot of functionality, they are only available as temperature sensors in this app. This is because of the complex nature of the DLPs and bridging this with Homey. As temperature sensors, they match a built-in capability in Homey, and as such have very good Homey support.
+
+## How signals are received
+First of all, temperature sensors are one-way only, meanings readings come from the HDL side and are set in Homey. You can not send anything back to the panel. The sensors are sending out updates with semi-regular intervals, and usually when changes in temperature occurs. I would generally not recommend trusting readings to be very fast, if you need logic that responds quickly to changes in temperature.
+
+## Temperature scope
+The app will disregard any readings that are below -40 or above 70 degrees celsius.

DEVICES_TEMPSENSORS.md

@@ -9,7 +9,7 @@ Temperature sensors are a built-in capability in Homey, and as such have very go
 First of all, temperature sensors are one-way only, meanings readings come from the HDL side and are set in Homey. You can not send anything back to the sensor. The sensors are sending out updates with semi-regular intervals, and usually when changes in temperature occurs. I would generally not recommend trusting readings to be very fast, if you need logic that responds quickly to changes in temperature.
 
 ## Noisy sensors
-Temperature sensors that are mot properly set up can be very noisy on teh bus, meaning that they will sned out a lot of updates. If you have a four-channel sensor with some channels not being connected to a physical temperature probe, remember to disable the channel in your HDL configuration. This also makes sense because the readings will be way off if there is nothing connected.
+Temperature sensors that are mot properly set up can be very noisy on the bus, meaning that they will send out a lot of updates. If you have a four-channel sensor with some channels not being connected to a physical temperature probe, remember to disable the channel in your HDL configuration. This also makes sense because the readings will be way off if there is nothing connected.
 
 ## Temperature scope
 The app will disregard any readings that are below -40 or above 70 degrees celsius.

_config.yml

@@ -19,3 +19,4 @@ include:
   - DEVICES_RELAYS.md
   - DEVICES_TEMPSENSORS.md
   - DEVICES_UVSWITCHES.md
+  - DEVICES_PANELS.md

app.json

@@ -1,7 +1,7 @@
 {
   "_comment": "This file is generated. Please edit .homeycompose/app.json instead.",
   "id": "com.github.alydersen.hdl-smartbus-homey",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "compatibility": ">=5.0.0",
   "sdk": 3,
   "name": {
@@ -101,6 +101,14 @@
         "dim",
         "onoff"
       ],
+      "capabilitiesOptions": {
+        "dim": {
+          "duration": true
+        },
+        "onoff": {
+          "setOnDim": false
+        }
+      },
       "icon": "/drivers/dimmer/assets/icon.svg",
       "images": {
         "large": "/drivers/dimmer/assets/images/large.png",

drivers/dimmer/device.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const Homey = require("homey");
+const DEFAULT_DIM_DURATION = 0
 
 class DimmerDevice extends Homey.Device {
 
@@ -13,7 +14,14 @@ class DimmerDevice extends Homey.Device {
 
     // register a capability listener
     this.registerCapabilityListener("onoff", this.onCapabilityOnoff.bind(this));
-    this.registerCapabilityListener("dim", this.onCapabilityDim.bind(this));
+    this.registerCapabilityListener("dim", async (value, options) => {
+      await this.onCapabilityDim({
+        level: value,
+        duration: typeof options.duration === "number"
+          ? options.duration
+          : DEFAULT_DIM_DURATION,
+      });
+    });
 
     // Ask for channel status
     if (this.homey.app.isBusConnected()) { this.requestUpdate() }
@@ -37,13 +45,13 @@ class DimmerDevice extends Homey.Device {
   }
 
   async updateDeviceByBus(level) {
-    this._controller().send(
+    this.homey.app.controller().send(
       {
         target: this.getData().address,
         command: 0x0031,
         data: {
           channel: this.getData().channel,
-          level: level
+          level: level * 100
         }
       },
       function(err) {
@@ -54,16 +62,24 @@ class DimmerDevice extends Homey.Device {
     );
   }
 
-  async onCapabilityOnoff(value, opts) {
-    let level = value === true ? 100 : 0;
-    let dimlevel = value === true ? 1 : 0;
+  async onCapabilityOnoff(value) {
+    let level = value === true ? 1 : 0;
     this.updateDeviceByBus(level);
-    this.setCapabilityValue("dim", dimlevel).catch(this.error);
+    this.setCapabilityValue("dim", level).catch(this.error);
   }
 
-  async onCapabilityDim(value, opts) {
-    this.updateDeviceByBus(value * 100);
-    this.setCapabilityValue("onoff", value > 0).catch(this.error);
+  async onCapabilityDim(opts) {
+    var dev = this;
+    await this.setCapabilityValue("onoff", opts.level > 0).catch(this.error);
+    if (opts.duration === 0) {      
+      dev.updateDeviceByBus(opts.level);
+    } else {
+      var current_level = await this.getCapabilityValue("dim");
+      var step = (opts.level - current_level) / 10;
+      [ ...Array(10) ].forEach(async (e, i) => {
+        setTimeout(function () {dev.updateDeviceByBus(current_level + (step * (i+1)))}, (opts.duration / 10) * i);
+      });
+    }
   }
 }
 

drivers/dimmer/driver.compose.json

@@ -7,6 +7,10 @@
     "dim",
     "onoff"
   ],
+  "capabilitiesOptions": {
+    "dim": { "duration": true },
+    "onoff": { "setOnDim": false } 
+  },
   "icon": "/drivers/dimmer/assets/icon.svg",
   "images": {
     "large": "/drivers/dimmer/assets/images/large.png",

index.md

@@ -29,4 +29,5 @@ Devices broadcasts their state on the bus and the Homey App reads them and updat
 - [Universal Switches](DEVICES_UVSWITCHES.md)
 - [Multisensors](DEVICES_MULTISENSORS.md)
 - [Curtain Controllers](DEVICES_CURTAINS.md)
-- [Floor Heater Controllers](DEVICES_FLOORHEATERS.md)
+- [Floor Heater Controllers](DEVICES_FLOORHEATERS.md)
+- [DLP Panels](DEVICES_PANELS.md)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.github.alydersen.homey-smartbus",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "main": "app.js",
   "devDependencies": {
     "@types/homey": "npm:homey-apps-sdk-v3-types@^0.3.1"