initial commit

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Build app
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      matrix:
+        runner: [ macos-latest, windows-latest ]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node.js environment
+        uses: actions/[email protected]
+        with:
+          node-version: 16.20.2
+      - name: Install yarn
+        run: npm i -g yarn
+      - name: Install dependencies
+        run: yarn
+      - name: Build Project
+        run: yarn make
+      - name: Archive production artifacts
+        uses: kittaakos/upload-artifact-as-is@v0
+        with:
+          path: |
+            out/*.*
+      

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+out/
+.idea/

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Adrian Baumgart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# ArtNet-USBDMX-Converter
+
+<img src="./repo/screenshot.png" alt="Screenshot of main app window">
+
+Send incoming ArtNet signals to the FX5 DMX interface (and other [compatible interfaces](#compatible-interfaces)) to make it compatible with most DMX control programs.
+# Use case
+
+This application opens an ArtNet receiver, to which various DMX control programs (e.g. ChamSys MagicQ) can send DMX signals to.
+It then forwards these signals to the FX5 USBDMX interface, and therefore opens it up to a variety of programs, not only the few that support it (QLC+, DMXControl).
+
+# Compatible interfaces
+
+- FX5 DMX Interface (Frank Sievertsen)
+- [Nodle U1](https://www.dmxcontrol.de/interfaces/nodle-u1-interface.html) (DMXControl e.V.)
+- [Nodle R4S](https://www.dmxcontrol.de/interfaces/nodle-r4s-interface.html) (DMXControl e.V.)
+- Technically any interface which uses the [usbdmx driver](https://github.com/fx5/usbdmx) by Frank Sievertsen
+  - Won't work out of the box, vendor ID and product ID need to be added manually
+
+# Develop & Build
+
+## Development
+```bash
+git clone https://github.com/rainloreley/artnet-usbdmx-converter.git
+cd artnet-usbdmx-converter
+yarn
+yarn start
+```
+
+## Compiling
+```bash
+# edit package.json -> pkg to add more targets for various platforms
+yarn make
+```
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

package.json

@@ -0,0 +1,46 @@
+{
+  "name": "artnet-usbdmx-converter",
+  "version": "1.0.3",
+  "description": "Send ArtNet signals to USBDMX interfaces",
+  "main": "dist/index.js",
+  "bin": "./dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "dev": "npm run build && node ./dist/index.js",
+    "make": "npm run build && pkg --compress GZip ."
+  },
+  "pkg": {
+    "scripts": [],
+    "assets": [
+      "node_modules/figlet/fonts/Standard.flf"
+    ],
+    "targets": [
+      "node16.16.0-win-x64"
+    ],
+    "outputPath": "out/"
+  },
+  "type": "commonjs",
+  "keywords": [],
+  "repository": "https://github.com/rainloreley/artnet-usbdmx-converter",
+  "author": "Adrian Baumgart",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "4.1.2",
+    "clear": "^0.1.0",
+    "clui": "^0.3.6",
+    "dmxnet": "^0.9.0",
+    "figlet": "^1.6.0",
+    "inquirer": "8.0.0",
+    "node-hid": "^2.1.2"
+  },
+  "devDependencies": {
+    "@types/clear": "^0.1.2",
+    "@types/clui": "^0.3.2",
+    "@types/figlet": "^1.5.6",
+    "@types/inquirer": "^9.0.3",
+    "@types/node": "^20.8.3",
+    "pkg": "^5.8.1",
+    "typescript": "^5.2.2"
+  }
+}

src/ConvertHandler.ts

@@ -0,0 +1,100 @@
+import {dmxnet, receiver} from "dmxnet";
+import {DetectedInterface, DMXInterface, getConnectedInterfaces} from "./usbdmx";
+import {clearInterval} from "timers";
+
+export default class ConvertHandler {
+    dmxnetManager: dmxnet;
+    artNetReceiver: receiver;
+
+    recentDMXArray: number[] = Array(512).fill(0);
+
+    availableInterfaces: DetectedInterface[] = [];
+
+    dmxInterface: DMXInterface | undefined;
+    outputAllowed = false;
+
+    incomingDataCounter = 0;
+    sentDataCounter = 0;
+    dataPerSecTimer: NodeJS.Timeout;
+    incomingDataHistory: number[] = [];
+    sentDataHistory: number[] = [];
+
+    constructor() {
+        //this.startArtNetReceiver();
+    }
+
+    startArtNetReceiver = () => {
+        this.dmxnetManager = new dmxnet({
+            log: {level: "error"}
+        });
+        this.artNetReceiver = this.dmxnetManager.newReceiver();
+        // @ts-ignore
+        this.artNetReceiver.on("data", this.handleIncomingArtNetData);
+    }
+
+    handleIncomingArtNetData = (data: any) => {
+        this.incomingDataCounter++;
+        if (JSON.stringify(data) != JSON.stringify(this.recentDMXArray)) {
+            if (this.dmxInterface && this.outputAllowed) {
+                this.sentDataCounter++;
+                this.dmxInterface.writeMap(data);
+            }
+            this.recentDMXArray = data;
+        }
+    }
+
+    scanForInterfaces = (): DetectedInterface[] => {
+        this.availableInterfaces = getConnectedInterfaces();
+        return this.availableInterfaces;
+        /*return this.availableInterfaces.map((e) => {
+            return e.serial;
+        })*/
+    }
+
+    openInterface = async (serial: string, mode: string, manufacturer: string | undefined = undefined, product: string | undefined = undefined): Promise<string> => {
+        if (isNaN(parseInt(mode))) return "Invalid mode";
+
+        const interfaceIndex = this.availableInterfaces.findIndex((e) => e.serial == serial);
+        if (interfaceIndex === -1) return "Interface nicht gefunden, scanne erneut";
+        const interfacePath = this.availableInterfaces[interfaceIndex].path;
+        try {
+            this.dmxInterface = await DMXInterface.open(interfacePath, serial, manufacturer, product);
+            return new Promise<string>((resolve) => {
+                setTimeout( () => {
+                    // @ts-ignore
+                    const response = this.dmxInterface.setMode(parseInt(mode));
+                    this.outputAllowed = true;
+                    this.dataPerSecTimer = setInterval(this.parseRequestTimer, 1000);
+                    resolve(response === 0 ? "" : `Fehlercode ${response}`);
+                }, 1000);
+            })
+        }
+        catch(err) {
+            console.log(err);
+            return (err as Error).message;
+        }
+    }
+
+    closeInterface = () => {
+        if (this.dmxInterface) {
+            this.dmxInterface.close();
+            this.outputAllowed = false;
+            clearInterval(this.dataPerSecTimer);
+            this.dmxInterface = undefined;
+        }
+    }
+
+    parseRequestTimer = () => {
+        this.incomingDataHistory.push(this.incomingDataCounter);
+        if (this.incomingDataHistory.length > 20) {
+            this.incomingDataHistory = this.incomingDataHistory.slice(1)
+        }
+
+        this.sentDataHistory.push(this.sentDataCounter);
+        if (this.sentDataHistory.length > 20) {
+            this.sentDataHistory = this.sentDataHistory.slice(1)
+        }
+        this.incomingDataCounter = 0;
+        this.sentDataCounter = 0;
+    }
+}