loupedeck-commander 1.2.3 → 1.2.5

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Thomas Schneider
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,131 +1,131 @@
-# loupedeck-commander
-
-## Getting started
-
-The loupedeck-commander is helping you using your Loupedeck device more easily, and connect it with custom commands you define with script files.
-
-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
-
-Do the following steps:
-
-```bash
-# init your new node package
-npm init
-
-# install the loupedeck-commander dependency
-npm install -s loupedeck-commander 
-```
-
-Create a new configuration file with at least one profile or copy from here,
-and replace the image references with your own icons (90x90px size):
-
-- [config.json](https://gitlab.com/keckxde/loupedeck-commander/-/blob/main/config.json)
-- [profile-1.json](https://gitlab.com/keckxde/loupedeck-commander/-/blob/main/profile-1.json)
-
-Create a `index.mjs` file to open up your loupedeck connection:
-
-```javascript
-# save as index.mjs
-import { BaseLoupeDeckHandler } from 'loupedeck-commander'
-
-const handler = new BaseLoupeDeckHandler('config.json')
-
-/**
- * Stop the handlers when a signal like SIGINT or SIGTERM arrive
- * @param {*} signal 
- */
-const stopHandler = async(signal) =>  {
-  console.log(`Receiving ${signal} => Stopping processes.`)
-  await handler.stop()
-}
-
-// Initiating the signal handlers:
-// see https://www.tutorialspoint.com/unix/unix-signals-traps.htm
-process.on('SIGINT', async (signal) => { stopHandler(signal) })
-process.on('SIGTERM', async (signal) => { stopHandler(signal) })
-
-// Start it
-await handler.start()
-
-// Take care of running background processes and stop them accordingly:
-await new Promise((resolve) => process.once("SIGINT", resolve));
-
-```
-
-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
-
-## Thanks
-
-Big thanks go out to [foxxyz](https://github.com/foxxyz/loupedeck) and his team maintaining a great javascript loopdeck module 
-
-## Hints
-
-### Cannot connect to Loupedeck device
-
-You may need to add your user to the `dialout` group to allow access to the LoupeDeck device, you could do su using the `usermod` as shown below
-
-```bash
-# ls -la /dev/ttyACM0 
-crw-rw---- 1 root dialout 166, 0 Nov 30 12:59 /dev/ttyACM0
-
-# add the current user to the dialout group:
-# sudo usermod -a -G dialout $USER
-```
-
-After modifying users group you need to logout and login again to activate this change
-
-### 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
-```
+# loupedeck-commander
+
+## Getting started
+
+The loupedeck-commander is helping you using your Loupedeck device more easily, and connect it with custom commands you define with script files.
+
+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
+
+Do the following steps:
+
+```bash
+# init your new node package
+npm init
+
+# install the loupedeck-commander dependency
+npm install -s loupedeck-commander 
+```
+
+Create a new configuration file with at least one profile or copy from here,
+and replace the image references with your own icons (90x90px size):
+
+- [config.json](https://gitlab.com/keckxde/loupedeck-commander/-/blob/main/config.json)
+- [profile-1.json](https://gitlab.com/keckxde/loupedeck-commander/-/blob/main/profile-1.json)
+
+Create a `index.mjs` file to open up your loupedeck connection:
+
+```javascript
+# save as index.mjs
+import { BaseLoupeDeckHandler } from 'loupedeck-commander'
+
+const handler = new BaseLoupeDeckHandler('config.json')
+
+/**
+ * Stop the handlers when a signal like SIGINT or SIGTERM arrive
+ * @param {*} signal 
+ */
+const stopHandler = async(signal) =>  {
+  console.log(`Receiving ${signal} => Stopping processes.`)
+  await handler.stop()
+}
+
+// Initiating the signal handlers:
+// see https://www.tutorialspoint.com/unix/unix-signals-traps.htm
+process.on('SIGINT', async (signal) => { stopHandler(signal) })
+process.on('SIGTERM', async (signal) => { stopHandler(signal) })
+
+// Start it
+await handler.start()
+
+// Take care of running background processes and stop them accordingly:
+await new Promise((resolve) => process.once("SIGINT", resolve));
+
+```
+
+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
+
+## Thanks
+
+Big thanks go out to [foxxyz](https://github.com/foxxyz/loupedeck) and his team maintaining a great javascript loopdeck module 
+
+## Hints
+
+### Cannot connect to Loupedeck device
+
+You may need to add your user to the `dialout` group to allow access to the LoupeDeck device, you could do su using the `usermod` as shown below
+
+```bash
+# ls -la /dev/ttyACM0 
+crw-rw---- 1 root dialout 166, 0 Nov 30 12:59 /dev/ttyACM0
+
+# add the current user to the dialout group:
+# sudo usermod -a -G dialout $USER
+```
+
+After modifying users group you need to logout and login again to activate this change
+
+### 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/VERSION.md

@@ -1,33 +1,33 @@
-# Versions
-
-## 1.0.2
-
-1. Updated button rendering strategy:
-   - Render Background Color - per Button State
-   - Render Image on Top (if available), works well with transparent images
-
-2. Updated configuration strategy:
-   - Keep all state related attributes per button-state also in config:
-     example:
-
-     ```json
-     "states": {
-        "off": {
-            "color": "#aaaaaa",
-            "image": "icons/bulb.png",
-            "cmd": "echo \"{id} {state}\""
-        },
-        "on": {
-            "color": "#11ff11",
-            "image": "icons/bulb.png",
-            "cmd": "echo \"{id} {state}\""
-        }
-     ```
-
-## 1.0.1 
-
-bugfixes and documentation
-
-## 1.0.0
-
+# Versions
+
+## 1.0.2
+
+1. Updated button rendering strategy:
+   - Render Background Color - per Button State
+   - Render Image on Top (if available), works well with transparent images
+
+2. Updated configuration strategy:
+   - Keep all state related attributes per button-state also in config:
+     example:
+
+     ```json
+     "states": {
+        "off": {
+            "color": "#aaaaaa",
+            "image": "icons/bulb.png",
+            "cmd": "echo \"{id} {state}\""
+        },
+        "on": {
+            "color": "#11ff11",
+            "image": "icons/bulb.png",
+            "cmd": "echo \"{id} {state}\""
+        }
+     ```
+
+## 1.0.1 
+
+bugfixes and documentation
+
+## 1.0.0
+
 first public release