Merge pull request #26 from janikwitzig/v3

Initial Set of updates and changes for Companion Version 3

.github/workflows/companion-module-checks.yaml

@@ -0,0 +1,18 @@
+name: Companion Module Checks
+
+on:
+  push:
+
+jobs:
+  check:
+    name: Check module
+
+    if: ${{ !contains(github.repository, 'companion-module-template-') }}
+
+    permissions:
+      packages: read
+
+    uses: bitfocus/actions/.github/workflows/module-checks.yaml@main
+    # with:
+    #   upload-artifact: true # uncomment this to upload the built package as an artifact to this workflow that you can download and share with others
+

.github/workflows/node.yaml

@@ -0,0 +1,76 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 18.x
+        # This should match the version of Node.js you have defined in the manifest.json runtime field
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Prepare Environment
+        run: |
+          corepack enable
+      - name: Prepare Environment (For template repository)
+        # Only run this step if the repository is a template repository
+        # If you are using this in a module, you can remove this step
+        if: ${{ contains(github.repository, 'companion-module-template-') }}
+        run: |
+          # Perform an install to generate the lockfile
+          yarn install
+        env:
+          CI: false
+      - name: Prepare module
+        run: |
+          yarn install
+        env:
+          CI: true
+      - name: Build and check types
+        run: |
+          yarn build
+        env:
+          CI: true
+      - name: Run lint
+        run: |
+          yarn lint
+        env:
+          CI: true
+
+  # Uncomment this to enable running unit tests
+  # test:
+  #   name: Test
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 15
+
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - name: Use Node.js 22.x
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: 22.x
+  #     - name: Prepare Environment
+  #       run: |
+  #         corepack enable
+  #         yarn install
+  #       env:
+  #         CI: true
+  #     - name: Run tests
+  #       run: |
+  #         yarn test
+  #       env:
+  #         CI: true
+  #     - name: Send coverage
+  #       uses: codecov/codecov-action@v5

.gitignore

@@ -1,2 +1,7 @@
 node_modules/
-floattest.js
+package-lock.json
+/pkg
+/pkg.tgz
+/dist
+DEBUG-*
+/.yarn

.husky/pre-commit

@@ -0,0 +1 @@
+lint-staged

.prettierignore

@@ -0,0 +1,2 @@
+package.json
+/LICENSE.md

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Bitfocus AS
+Copyright (c) 2022 Bitfocus AS - Open Source
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,32 +1,64 @@
 # companion-module-behringer-wing
 See also HELP.md and LICENSE
 
-**V0.5.0**
-* Initial release / testing
-* Fader, Mute, LED, Colors, Solo, Sends
-* With dynamic variables and Feedback
 
-**V0.9.0**
-* Protocol update
+# Changelog
 
-**V0.9.1**
-* Feedback and Variables
+## 2.0.0
 
-**V0.9.2**
-* Talkback bus control
+### Added
+- Support for Companion 3.0
+- Device discovery listing Behringer Wing devices in configuration screen (inspired by [Behringer X32](https://github.com/bitfocus/companion-module-behringer-x32/tree/master))
+- Fade-Curve Easings (copied from [Behringer X32](https://github.com/bitfocus/companion-module-behringer-x32/tree/master))
+- Support for Wing Rack and Wing Comapct
 
-**V1.0.0**
-* Implement a 'Clear All Solo' function
-* Cleanup: remove excess debugging code
+### Changed
+- Re-structued repository to accomodate for large number of commands (inspired by [ATEM](https://github.com/bitfocus/companion-module-bmd-atem))
+    - chaned from `action.ts` to `action/` as directory with one file per category
+    - OSC commands are documented the `commands/` directory, with one file per category. Each command category is its own namespace.
 
-**V1.0.1**
-* Fix typos on certain mute actions
+## 1.0.4
 
-**V1.0.2**
-* Fix Repo URL in HELP.md
+### Fixed
+- Fix DCA Channel count (16 not 8)
 
-**V1.0.3**
-* Fix remaining switch/toggle actions
+## 1.0.3
 
-**V1.0.4**
-* Fix DCA Channel count (16 not 8)
+### Fixed
+- Fix remaining switch/toggle actions
+
+## 1.0.2
+
+### Fixed
+- Fix Repo URL in HELP.md
+
+## 1.0.1
+
+### Fixed
+- Fix typos on certain mute actions
+
+## 1.0.0
+
+### Added
+- Implement a 'Clear All Solo' function
+
+### Changed
+- Cleanup: remove excess debugging code
+
+## 0.9.2
+### Added
+- Talkback bus control
+
+## 0.9.1
+### Added
+- Feedback and Variables
+
+## 0.9.0
+### Changed
+- Protocol update
+
+## 0.5.0
+### Added
+- Initial release / testing
+- Fader, Mute, LED, Colors, Solo, Sends
+- With dynamic variables and Feedback

companion/HELP.md

@@ -0,0 +1,3 @@
+## Your module
+
+Write some help for your users here!

companion/manifest.json

@@ -0,0 +1,26 @@
+{
+	"id": "behringer-wing",
+	"name": "behringer-wing",
+	"shortname": "wing",
+	"description": "WING OSC",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/janikwitzig/companion-module-behringer-wing.git",
+	"bugs": "https://github.com/janikwitzig/companion-module-behringer-wing/issues",
+	"maintainers": [
+		{
+			"name": "Janik Witzig",
+			"email": "[email protected]"
+		}
+	],
+	"runtime": {
+		"type": "node18",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../dist/index.js"
+	},
+	"legacyIds": [],
+	"manufacturer": "Behringer",
+	"products": ["WING"],
+	"keywords": []
+}