@uncaught/gpio-shutter-bridge 1.1.1 → 1.2.0

package/README.md

@@ -53,7 +53,7 @@ Just to give you an insight, you can pobably use this project with any other har
   - Before buying this, I also tried soldering contacts to the Velux remotes (model 3UR B01 WW), but I broke the first...
 - 9 relay modules
   - If you use a Raspberry PI, you need relays that work with 3V and it helps if they already have a pull-up resistor because the GPIO pins can have a floating voltage when the PI boots and they are not yet assigned as outputs, triggering the relay when it shouldn't.
-  - I bought [this 10 pack on amazon](https://www.amazon.de/dp/B0F53QDMXG) 
+  - I bought [this 10 pack on amazon](https://www.amazon.de/dp/B0F53QDMXG)
   - You will need 2 relays per Velux shutter, so for my three windows I needed 6 relays.
   - Additionally I needed 3 relays for my Schellenberg remote control.
   - If you find a board with multiple 3V relays on it, go ahead. I just screwed mine together on a wooden board.
@@ -91,39 +91,71 @@ This is for the default configuration as described in the Velux KLF 150 manual.
 ### Inputs
 
 - The bottom line of all input pins are for GND. However, since the cabling comes in pairs anyway and you need to connect them each to one of the relays, I just used all the existing cables.
-- So connect all 10 inputs to the 10 relays, the top one to **NO** (normally open) and the bottom one to **COM** (common). 
+- So connect all 10 inputs to the 10 relays, the top one to **NO** (normally open) and the bottom one to **COM** (common).
 
 # Software
 
-- Make sure you have either `raspi-gpio` or `pinctrl` (newer) installed. Check with `raspi-gpio get` or `pinctrl get`.
+- You will need to have `node` installed.
+  - I have to use node 21, but it should work with newer versions as well.
+- Make sure you have either `raspi-gpio` or `pinctrl` (newer) available.
+  - Check with `raspi-gpio get` or `pinctrl get`.
   - Either one is used to set the GPIO input pins to the "pull up" mode. This is not handled in the `onoff`-library I'm using.
-  - `pinctrl` is newer, but requires permissions. So you either need to be root, or make sure you have access to all `/dev/gpio*` devices:
+  - `pinctrl` is newer, but requires permissions.
+    - So you either need to be root, or make sure you have access to all `/dev/gpio*` devices.
     - E.g. use the `gpio` group:
       - Check `ll /dev/gpio*` and see that every device is owned by the `gpio` group and has `g+rw` permissions.
       - If not, use `sudo chgrp gpio /dev/gpio*` and/or `sudo chmod g+rw /dev/gpio*`.
       - You can add yourself to the `gpio` group with `sudo usermod -a -G gpio $USER`.
       - Verify with `pinctrl get` that you can use the tool without further permissions.
-- Go into a folder where you wish to install this project.
+- Go into a folder where you wish to install this project (e.g. `~/shutter`).
 - Install the library with `npm install @uncaught/gpio-shutter-bridge`
-- Create a javascript file (e.g. `run.js`), require my library and call it with your shutter-pin-layout:
+- Create a javascript file (e.g. `run.mjs`), require my library and call it with your shutter-pin-layout:
 
 ```js
 import {createVeluxShutters, initRuntime, initMqtt} from '@uncaught/gpio-shutter-bridge';
 
 const {onDispose} = initRuntime();
 
-initMqtt(createVeluxShutters([
-  {ident: 'Velux_A', up: 2, down: 3, input: 14},
-  {ident: 'Velux_B', up: 4, down: 17, input: 15},
-  {ident: 'Velux_C', up: 27, down: 22, input: 18},
-  {ident: 'Velux_D', up: 10, down: 9, input: 23},
-  {ident: 'Velux_E', up: 11, down: 8, input: 24}, //same row!
-], onDispose), onDispose, {url: 'mqtt://your-mqtt-or-home-assistant'});
+initMqtt(
+  createVeluxShutters(
+    [
+      {ident: 'Velux_A', up: 2, down: 3, input: 14},
+      {ident: 'Velux_B', up: 4, down: 17, input: 15},
+      {ident: 'Velux_C', up: 27, down: 22, input: 18},
+      {ident: 'Velux_D', up: 10, down: 9, input: 23},
+      {ident: 'Velux_E', up: 11, down: 8, input: 24}, //same row!
+    ],
+    onDispose,
+  ),
+  onDispose,
+  {url: 'mqtt://your-mqtt-or-home-assistant'},
+);
 ```
 
 - The ident should match `/[a-zA-Z][a-zA-Z0-9_-]*/`.
 - See [my personal example](./example.ts) for a few more details.
 
+<details>
+<summary>Auto start with screen and crontab</summary>
+
+I'm using `screen` to keep the process running and to check in on its output.
+
+I created an additional `start.sh` file:
+
+```bash
+#!/usr/bin/env bash
+set -e
+selfDir=$(dirname $(readlink -f $0))
+cd $selfDir
+screen -dmS shutter node run.mjs
+```
+
+Then added `@reboot /home/nc/shutter/start.sh` to my `crontab -e`.
+
+If you are unfamiliar with `screen`, you can detach from a session with `ctrl+a+d` and reattach with `screen -r shutter`.
+
+</details>
+
 ## Dockerizing
 
 I tried to dockerize this project, but I was not able to get it to work with only specific mapped devices. The `pinctrl` kept saying "No GPIO chips found". I've only managed to get it working with the `--privileged` flag, which for me, kind of defeats the purpose of running this inside docker.
@@ -150,4 +182,4 @@ ENTRYPOINT ["bash"]
 
 Building with `docker build -t gpio .` and running with `docker run --rm -it --device /dev/gpiochip0 --device /dev/gpiochip1 --device /dev/gpiochip2 --device /dev/gpiomem --cap-add SYS_RAWIO gpio`
 
-</details>
+</details>

package/dist/Gpio.js

@@ -1,12 +1,12 @@
 import { Gpio } from 'onoff';
 import { execSync } from 'child_process';
 async function sleep(wait) {
-    await new Promise(resolve => setTimeout(resolve, wait));
+    await new Promise((resolve) => setTimeout(resolve, wait));
 }
 export async function press(...outputs) {
-    outputs.forEach(output => output.writeSync(1));
+    outputs.forEach((output) => output.writeSync(1));
     await sleep(200);
-    outputs.forEach(output => output.writeSync(0));
+    outputs.forEach((output) => output.writeSync(0));
 }
 export function mkOutput(pin, onDispose) {
     const gpio = new Gpio(pin, 'out');

package/dist/Shutter/Shutter.d.ts

@@ -1,9 +1,9 @@
 export declare const shutterPositions: readonly ["open", "closed", "in-between", "unknown"];
-export type ShutterPosition = typeof shutterPositions[number];
+export type ShutterPosition = (typeof shutterPositions)[number];
 export declare const shutterActions: readonly ["opening", "closing", "stopping"];
-export type ShutterAction = typeof shutterActions[number];
+export type ShutterAction = (typeof shutterActions)[number];
 export declare const shutterStates: readonly ["open", "closed", "in-between", "unknown", "opening", "closing", "stopping"];
-export type ShutterState = typeof shutterStates[number];
+export type ShutterState = (typeof shutterStates)[number];
 export declare function isShutterPosition(state: unknown): state is ShutterPosition;
 export declare function isShutterAction(state: unknown): state is ShutterAction;
 export interface ShutterInterface {

package/dist/Shutter/VeluxShutter.d.ts

@@ -1,8 +1,11 @@
 import { Gpio } from 'onoff';
 import { ShutterState, ShutterInterfaceWithState, ShutterInterfaceWithPosition, ShutterPosition } from './Shutter.js';
-export interface Persistence {
-    lastFullCloseDurations?: number[];
-    lastFullOpenDurations?: number[];
+interface Durations {
+    topFullCloseDurations?: number[];
+    topFullOpenDurations?: number[];
+    topSignalDurations?: number[];
+}
+export interface Persistence extends Durations {
     position?: number;
     state?: ShutterPosition;
 }
@@ -17,6 +20,7 @@ export declare class VeluxShutter implements ShutterInterfaceWithState, ShutterI
     private readonly input;
     private readonly store;
     private lastActionStartTime;
+    private lastStoppingStartTime;
     private prevPositionState;
     private positioningTimeout;
     private position;
@@ -30,6 +34,7 @@ export declare class VeluxShutter implements ShutterInterfaceWithState, ShutterI
     private notifyPositionChange;
     private storeDuration;
     private getAverageDuration;
+    private getAverageActionDuration;
     private getPositionDelta;
     private setState;
     private clearPositioningTimeout;

package/dist/Shutter/VeluxShutter.js

@@ -1,7 +1,7 @@
 import { Gpio } from 'onoff';
 import { isShutterPosition, isShutterAction, } from './Shutter.js';
 import { press } from '../Gpio.js';
-const lastDurationsToKeep = 10;
+const durationsToKeep = 20;
 function minMaxPercentage(num) {
     return Math.min(Math.max(num, 0), 100);
 }
@@ -12,6 +12,7 @@ export class VeluxShutter {
     input;
     store;
     lastActionStartTime = 0;
+    lastStoppingStartTime = 0;
     prevPositionState = 'unknown';
     positioningTimeout = null;
     position = 42; //unknown initially
@@ -27,7 +28,7 @@ export class VeluxShutter {
         this.input = input;
         this.store = store;
         const persistence = this.store.get();
-        if (typeof persistence.position === 'number' && (persistence.position <= 100 && persistence.position >= 0)) {
+        if (typeof persistence.position === 'number' && persistence.position <= 100 && persistence.position >= 0) {
             this.position = +persistence.position; //"+" makes sure we have integers only
         }
         if (persistence.state && isShutterPosition(persistence.state)) {
@@ -52,7 +53,7 @@ export class VeluxShutter {
         });
     }
     notifyStateChange() {
-        this.stateListeners.forEach(listener => {
+        this.stateListeners.forEach((listener) => {
             try {
                 listener(this.state);
             }
@@ -62,7 +63,7 @@ export class VeluxShutter {
         });
     }
     notifyPositionChange() {
-        this.positionListeners.forEach(listener => {
+        this.positionListeners.forEach((listener) => {
             try {
                 listener(this.position);
             }
@@ -73,31 +74,34 @@ export class VeluxShutter {
     }
     storeDuration(key, duration) {
         if (duration > 0) {
-            let array = this.store.get()[key] ?? [];
-            array.unshift(duration);
-            array = array.slice(0, lastDurationsToKeep);
-            this.store.set({ [key]: array });
+            //Keep the N longest durations:
+            this.store.set({
+                [key]: [...(this.store.get()[key] ?? []), duration].sort((a, b) => b - a).slice(0, durationsToKeep),
+            });
         }
     }
-    getAverageDuration(action) {
-        let lastDurations = [];
+    getAverageDuration(key) {
+        const storedDurations = this.store.get()[key] ?? [];
+        if (storedDurations.length) {
+            const sum = storedDurations.reduce((a, b) => a + b, 0);
+            return sum / storedDurations.length;
+        }
+        return 0;
+    }
+    getAverageActionDuration(action) {
         if (action === 'opening') {
-            lastDurations = this.store.get().lastFullOpenDurations ?? [];
+            return this.getAverageDuration('topFullOpenDurations');
         }
         if (action === 'closing') {
-            lastDurations = this.store.get().lastFullCloseDurations ?? [];
-        }
-        if (lastDurations.length) {
-            const sum = lastDurations.reduce((a, b) => a + b, 0);
-            return sum / lastDurations.length;
+            return this.getAverageDuration('topFullCloseDurations');
         }
         return 0;
     }
     getPositionDelta(prevState, duration) {
         if (isShutterAction(prevState) && duration > 0) {
-            const avg = this.getAverageDuration(prevState);
+            const avg = this.getAverageActionDuration(prevState);
             if (avg > 0) {
-                return minMaxPercentage(Math.round(duration / avg * 100));
+                return minMaxPercentage(Math.round((duration / avg) * 100));
             }
         }
         return 0;
@@ -108,6 +112,16 @@ export class VeluxShutter {
         this.notifyStateChange();
         if (state === 'stopping') {
             this.preStopState = this.prevState;
+            this.lastStoppingStartTime = Date.now();
+        }
+        else if (state === 'in-between') {
+            //Measure the time it takes between a manual "stop" and the following stopped signal.
+            // This gives us an estimate on how long the KLF 150 takes to send it for any operation.
+            const stopDuration = this.lastStoppingStartTime ? Date.now() - this.lastStoppingStartTime : 0;
+            this.storeDuration('topSignalDurations', stopDuration);
+        }
+        else {
+            this.lastStoppingStartTime = 0;
         }
         if (state === 'opening' || state === 'closing') {
             this.lastActionStartTime = Date.now();
@@ -117,16 +131,29 @@ export class VeluxShutter {
             }
         }
         if (isShutterPosition(state)) {
-            const duration = this.lastActionStartTime ? (Date.now() - this.lastActionStartTime) : 0;
+            const signalDuration = this.getAverageDuration('topSignalDurations');
+            const measuredDuration = this.lastActionStartTime ? Date.now() - this.lastActionStartTime : 0;
+            const positionDuration = measuredDuration > 0 ? Math.max(0, measuredDuration - signalDuration) : 0;
             if (state === 'closed') {
-                this.position = 0;
+                const delta = this.getPositionDelta(this.prevState, positionDuration);
+                if (delta) {
+                    this.position = minMaxPercentage(this.position - delta);
+                }
+                else {
+                    this.position = 0;
+                }
             }
             else if (state === 'open') {
-                this.position = 100;
+                const delta = this.getPositionDelta(this.prevState, positionDuration);
+                if (delta) {
+                    this.position = minMaxPercentage(this.position + delta);
+                }
+                else {
+                    this.position = 100;
+                }
             }
             else if (state === 'in-between') {
-                const prevPosition = this.position;
-                const delta = this.getPositionDelta(this.preStopState, duration);
+                const delta = this.getPositionDelta(this.preStopState, positionDuration);
                 if (this.preStopState === 'opening') {
                     this.position = minMaxPercentage(this.position + delta);
                 }
@@ -139,10 +166,10 @@ export class VeluxShutter {
             let prevPositionState = this.prevPositionState;
             this.prevPositionState = state;
             if (prevPositionState === 'open' && state === 'closed') {
-                this.storeDuration('lastFullCloseDurations', duration);
+                this.storeDuration('topFullCloseDurations', measuredDuration);
             }
             if (prevPositionState === 'closed' && state === 'open') {
-                this.storeDuration('lastFullOpenDurations', duration);
+                this.storeDuration('topFullOpenDurations', measuredDuration);
             }
         }
     }
@@ -178,11 +205,11 @@ export class VeluxShutter {
         else if (position > 0 && position < 100) {
             let timeout = 0;
             if (position > this.position) {
-                timeout = this.getAverageDuration('opening') * (position - this.position) / 100;
+                timeout = (this.getAverageActionDuration('opening') * (position - this.position)) / 100;
                 this.open();
             }
             else {
-                timeout = this.getAverageDuration('closing') * (this.position - position) / 100;
+                timeout = (this.getAverageActionDuration('closing') * (this.position - position)) / 100;
                 this.close();
             }
             if (timeout) {

package/dist/Shutter/VeluxShutterFactory.d.ts

@@ -6,4 +6,7 @@ export interface VeluxConfig {
     down: number;
     input: number;
 }
-export declare function createVeluxShutters(shutters: readonly VeluxConfig[], onDispose: OnDispose): readonly VeluxShutter[];
+export interface VeluxOptions {
+    persistenceFile?: string;
+}
+export declare function createVeluxShutters(shutters: readonly VeluxConfig[], onDispose: OnDispose, { persistenceFile }?: VeluxOptions): readonly VeluxShutter[];

package/dist/Shutter/VeluxShutterFactory.js

@@ -3,8 +3,7 @@ import { existsSync, writeFile } from 'node:fs';
 import { VeluxShutter } from './VeluxShutter.js';
 import { mkInput, mkOutput } from '../Gpio.js';
 import debounce from 'lodash.debounce';
-export function createVeluxShutters(shutters, onDispose) {
-    const persistenceFile = '/tmp/velux-shutter-state.json';
+export function createVeluxShutters(shutters, onDispose, { persistenceFile = '/tmp/velux-shutter-state.json' } = {}) {
     let storage = {};
     if (existsSync(persistenceFile)) {
         const file = readFileSync(persistenceFile).toString();

package/dist/mqtt/mqtt.js

@@ -93,11 +93,11 @@ export function initMqtt(shutters, onDispose, { url, ...mqttOpts }, namespace =
                 const publishState = (state) => {
                     if (state !== 'stopping' && state !== 'unknown') {
                         publish(`${shutterNs}/state`, {
-                            'closed': 'closed',
-                            'closing': 'closing',
+                            closed: 'closed',
+                            closing: 'closing',
                             'in-between': 'stopped',
-                            'open': 'open',
-                            'opening': 'opening',
+                            open: 'open',
+                            opening: 'opening',
                         }[state], { retain: true });
                     }
                 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@uncaught/gpio-shutter-bridge",
   "author": "uncaught <uncaught42@gmail.com>",
   "license": "MIT",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "MQTT shutter bridge for home assistant with Velux KLF 150 support",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "prettier": "prettier --write ."
   },
   "dependencies": {
     "lodash.debounce": "^4.0.8",
@@ -28,6 +28,7 @@
     "@tsconfig/node20": "^20.1.6",
     "@types/lodash.debounce": "^4.0.9",
     "@types/node": "^20",
+    "prettier": "^3.8.0",
     "typescript": "^5.9.3"
   },
   "sideEffects": [
@@ -46,6 +47,11 @@
     "dist",
     "README.md"
   ],
+  "prettier": {
+    "bracketSpacing": false,
+    "printWidth": 120,
+    "singleQuote": true
+  },
   "publishConfig": {
     "access": "public"
   }