loupedeck-commander 1.0.0 → 1.0.1

package/README.md

@@ -7,6 +7,21 @@ The loupedeck-commander is helping you using your Loupedeck device more easily,
 Features:
 - Reference image files for every state of your button in the touch-display fields
 - Connect commands to your state transitions
+- Tested with following LoupeDeck devices:
+  - [LoupeDeck Live](https://loupedeck.com/products/loupedeck-live/)
+  - [LoupeDeck CT](https://loupedeck.com/products/loupedeck-ct/)
+
+Runs on:
+- Linux (Tested with Ubuntu 22.04 and Debian 11/12 on x64 & arm32/arm64)
+- Windows (Tested with Windows 10/11 on x64)
+
+Small footprint 
+- Raspberry PI Zero is suitable to run this
+
+Please take care about the following:
+ - LoupeDeck devices after `version 0.2.x` use a serial interface instead of WebSocket. 
+   When using this library please upgrade your firmware using the [LoupeDeck Software](https://loupedeck.com/downloads/)
+   Tested with Firmware version [`version 0.2.5`](https://support.loupedeck.com/f-a-q-support#firmware-connectivity-issues)
 
 ## Basic Usage
 
@@ -49,3 +64,34 @@ Run the script using the following command:
 ```bash
 node index.mjs
 ```
+
+If you end up with errors related to canvas module - please install the dependencies as mentioned below, and run `npm install -s` again
+
+## Hints
+
+### CANVAS Module - additional effort needed
+
+The library is using [canvas](https://www.npmjs.com/package/canvas) to load images and render graphical content on the LoupeDeck devices.
+Please follow the instructions to install the preconditions, to properly use canvas on your system.
+
+Example for Ubuntu:
+
+```bash
+# different build & graphic dev-libs are needed to use canvas module:
+sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
+```
+
+### Resizing of images
+
+The buttons images shown on the different buttons should be prepared with specific resolutions:
+
+ - Main/Center Touch-Area:        90px x 90px per Button
+ - Left/Right Touch-Area:         90px x 270px per Button
+ - LoupeDeck CT Knob Touch-Area:  240px x 240px Button 
+
+if you already have suitable icons with the right aspect ratio, you could resize them with imagemagick/mogrify:
+
+```bash
+mkdir resized
+mogrify -resize 90x90 -quality 100 -path resized *.png
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loupedeck-commander",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A system to ease working with LoupeDeck devices using CMD-line interfaces",
   "main": "index.mjs",
   "scripts": {

package/profile-1.json

@@ -1,5 +1,5 @@
 {
-    "profile": "KVM",
+    "profile": "sample",
     "description": "",
     "config": {},
     "touch": {
@@ -8,8 +8,8 @@
         "center": {
             "0": {
                 "images": {
-                    "off": "icons/Comp_E_n.png",
-                    "on": "icons/Comp_E_p.png"
+                    "off": "icons/home.png",
+                    "on": "icons/home_filled.png"
                 },
                 "commands": {
                     "off": "echo \"{id} {state}\"",
@@ -19,57 +19,26 @@
             },
             "1": {
                 "images": {
-                    "off": "icons/Comp_D_n.png",
-                    "on": "icons/Comp_D_p.png"
+                    "off": "icons/user.png",
+                    "on": "icons/user_filled.png"
                 },
                 "group": "kvm1"
             },
             "2": {
-                "images": {
-                    "off": "icons/Comp_C_n.png",
-                    "on": "icons/Comp_C_p.png"
-                },
-                "group": "kvm1"
-            },
-            "3": {
-                "images": {
-                    "off": "icons/Comp_B_n.png",
-                    "on": "icons/Comp_B_p.png"
-                },
-                "group": "kvm1"
-            },
-            "4": {
-                "images": {
-                    "off": "icons/Comp_F_n.png",
-                    "on": "icons/Comp_F_p.png"
-                },
-                "group": "kvm1"
-            },
-            "5": {
-                "minPressed": 1000,
                 "type": "push",
-                "colors": {
-                    "off": "#000000",
-                    "on": "#ff0000"
+                "images": {
+                    "off": "icons/bulp.png",
+                    "on": "icons/bulp_filled.png"
                 }
             },
-            "7": {
-                "images": {
-                    "off": "icons/Comp_A_n.png",
-                    "on": "icons/Comp_A_p.png"
-                },
-                "group": "kvm1"
-            }
         },
         "knob": {
             "0": {
                 "images": {
-                    "off": "icons/cia.png",
-                    "on": "icons/saph.png"
+                    "default": "icons/mountain.png"
                 },
                 "commands": {
-                    "off": "echo \"CIA {state}\"",
-                    "on": "echo \"CIA {state}\""
+                    "off": "echo \"knob {state}\""
                 }
             }
         }
@@ -121,8 +90,6 @@
             }
         },
         "1": {
-            "text": "PA",
-            "type": "toggle",
             "commands": {
                 "off": "echo \"{id} {state}\"",
                 "on": "echo \"{id} {state}\"",