@uncaught/gpio-shutter-bridge 1.0.0 → 1.1.0

package/README.md

@@ -45,7 +45,7 @@ Just to give you an insight, you can pobably use this project with any other har
 - 1 Schellenberg shutter motor in my balcony door
 - 1 Schellenberg remote control
   - Which I opened up and soldered contacts to all three buttons (up/stop/down) as well as the power supply.
-  - This way I can supply power directly via the 3V GPIO output of the raspberry pi without needing batteries.
+  - This way I can supply power directly via the 3V output pin of the raspberry pi without needing batteries.
   - I'm trusting you with this [definitely professional piece of art](docs/schellenberg.png).
 - 3 Velux covers/shutters on my roof windows
 - Velux KLF 150 gateway
@@ -69,7 +69,7 @@ Just to give you an insight, you can pobably use this project with any other har
 
 ![Relay boards](docs/relay-boards.png)
 
-- Connect all **VCC** pins of the relays to a 3V GPIO pin of the Raspberry Pi.
+- Connect all **VCC** pins of the relays to a 3V pin of the Raspberry Pi.
   - I have daisy chained them together. Only the most left relay is connected to the Pi.
 - Connect all **GND** pins of the relays to a GND pin of the Raspberry Pi.
   - Again daisy chained.
@@ -95,21 +95,59 @@ This is for the default configuration as described in the Velux KLF 150 manual.
 
 # Software
 
-- Create a javascript file, require my library and call it with your shutter-pin-layout:
+- Make sure you have either `raspi-gpio` or `pinctrl` (newer) installed. 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:
+    - 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.
+- 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:
 
 ```js
 import {createVeluxShutters, initRuntime, initMqtt} from '@uncaught/gpio-shutter-bridge';
 
 const {onDispose} = initRuntime();
 
-onDispose(initMqtt(createVeluxShutters([
+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), {url: 'mqtt://your-mqtt-or-home-assistant'}));
+], 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.
+
+## 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.
+
+If you find a way to get it working, please let me know, I'll add it as an example.
+
+<details>
+<summary>My attempts</summary>
+
+I tried based off of this:
+
+```Dockerfile
+FROM node:25.0.0-trixie-slim
+
+RUN apt update && apt install -y git build-essential cmake \
+    && git clone https://github.com/raspberrypi/utils.git \
+    && cd utils/pinctrl \
+    && cmake . \
+    && make \
+    && make install
+
+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>

package/dist/example.js

@@ -30,4 +30,4 @@ const shutters = [
     ...createVeluxShutters(veluxKlf150CDE, onDispose),
     createThreeButtonShutter('Balkon', 10, 9, 11, onDispose),
 ];
-onDispose(initMqtt(shutters, { url: 'mqtts://mosquitto.local.correnz.net', rejectUnauthorized: false }));
+initMqtt(shutters, onDispose, { url: 'mqtts://mosquitto.local.correnz.net', rejectUnauthorized: false });

package/dist/src/Gpio.js

@@ -20,13 +20,23 @@ export function mkInput(pin, onDispose) {
     //Setting to pull-up - the `onoff`-library doesn't do that.
     // I'm doing this because the inputs were floating high without any pull, so I just stick with it.
     // We assume the input pin is closed to ground, causing it to change to low.
-    execSync(`raspi-gpio set ${pin} pu`);
+    try {
+        execSync(`raspi-gpio set ${pin} pu`);
+    }
+    catch {
+        try {
+            execSync(`pinctrl set ${pin} pu`); //newer tool, replacing raspi-gpio, might need root though
+        }
+        catch {
+            console.error('Unable to set pull-up on GPIO input');
+        }
+    }
     const gpio = new Gpio(pin, 'in', 'both');
     onDispose(() => gpio.unexport());
     //Double check that the input is high:
     const value = gpio.readSync();
     if (value !== Gpio.HIGH) {
-        console.error(`Expected GPIO ${pin} to be high, but it was ${value}`);
+        console.error(`Expected GPIO ${pin} to be high (3V), but it was low (0V)`);
     }
     return gpio;
 }

package/dist/src/mqtt/mqtt.d.ts

@@ -1,5 +1,6 @@
 import { type IClientOptions } from 'mqtt';
 import { ShutterInterface } from '../Shutter/Shutter.js';
-export declare function initMqtt(shutters: readonly ShutterInterface[], { url, ...mqttOpts }: {
+import type { OnDispose } from '../runtime.js';
+export declare function initMqtt(shutters: readonly ShutterInterface[], onDispose: OnDispose, { url, ...mqttOpts }: {
     url: string;
-} & IClientOptions, namespace?: string): () => Promise<void>;
+} & IClientOptions, namespace?: string): void;

package/dist/src/mqtt/mqtt.js

@@ -9,7 +9,7 @@ function validateNamespacePart(str) {
         throw new Error(`Invalid string for namespace: ${str}`);
     }
 }
-export function initMqtt(shutters, { url, ...mqttOpts }, namespace = 'shutter') {
+export function initMqtt(shutters, onDispose, { url, ...mqttOpts }, namespace = 'shutter') {
     const shuttersById = new Map(shutters.map((s) => [s.ident, s]));
     validateNamespacePart(namespace);
     const ns1 = namespace;
@@ -66,7 +66,7 @@ export function initMqtt(shutters, { url, ...mqttOpts }, namespace = 'shutter')
             },
             origin: {
                 name: ns0,
-                sw_version: '1.0.0',
+                sw_version: '1.1.0',
                 support_url: 'https://github.com/uncaught/gpio-shutter-bridge',
             },
             payload_available: 'online',
@@ -127,8 +127,8 @@ export function initMqtt(shutters, { url, ...mqttOpts }, namespace = 'shutter')
         publish(`homeassistant/device/${deviceId}/config`, JSON.stringify(autoDiscoveryPayload), { retain: true });
         publish(deviceAvailabilityTopic, 'online', { retain: true });
     });
-    return async () => {
+    onDispose(async () => {
         publish(deviceAvailabilityTopic, 'offline', { retain: true });
         await client.endAsync();
-    };
+    });
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@uncaught/gpio-shutter-bridge",
   "author": "uncaught <uncaught42@gmail.com>",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "MQTT shutter bridge for home assistant with Velux KLF 150 support",
   "repository": {
     "type": "git",