Skip to content

Commit 5c3bc42

Browse files
authored
Merge pull request #26 from janikwitzig/v3
Initial Set of updates and changes for Companion Version 3
2 parents 0fd459e + 511a97f commit 5c3bc42

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+9763
-2355
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Companion Module Checks
2+
3+
on:
4+
push:
5+
6+
jobs:
7+
check:
8+
name: Check module
9+
10+
if: ${{ !contains(github.repository, 'companion-module-template-') }}
11+
12+
permissions:
13+
packages: read
14+
15+
uses: bitfocus/actions/.github/workflows/module-checks.yaml@main
16+
# with:
17+
# upload-artifact: true # uncomment this to upload the built package as an artifact to this workflow that you can download and share with others
18+

.github/workflows/node.yaml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Node CI
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
tags:
8+
- 'v[0-9]+.[0-9]+.[0-9]+*'
9+
pull_request:
10+
11+
jobs:
12+
lint:
13+
name: Lint
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 15
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
- name: Use Node.js 18.x
20+
# This should match the version of Node.js you have defined in the manifest.json runtime field
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 18.x
24+
- name: Prepare Environment
25+
run: |
26+
corepack enable
27+
- name: Prepare Environment (For template repository)
28+
# Only run this step if the repository is a template repository
29+
# If you are using this in a module, you can remove this step
30+
if: ${{ contains(github.repository, 'companion-module-template-') }}
31+
run: |
32+
# Perform an install to generate the lockfile
33+
yarn install
34+
env:
35+
CI: false
36+
- name: Prepare module
37+
run: |
38+
yarn install
39+
env:
40+
CI: true
41+
- name: Build and check types
42+
run: |
43+
yarn build
44+
env:
45+
CI: true
46+
- name: Run lint
47+
run: |
48+
yarn lint
49+
env:
50+
CI: true
51+
52+
# Uncomment this to enable running unit tests
53+
# test:
54+
# name: Test
55+
# runs-on: ubuntu-latest
56+
# timeout-minutes: 15
57+
58+
# steps:
59+
# - uses: actions/checkout@v4
60+
# - name: Use Node.js 22.x
61+
# uses: actions/setup-node@v4
62+
# with:
63+
# node-version: 22.x
64+
# - name: Prepare Environment
65+
# run: |
66+
# corepack enable
67+
# yarn install
68+
# env:
69+
# CI: true
70+
# - name: Run tests
71+
# run: |
72+
# yarn test
73+
# env:
74+
# CI: true
75+
# - name: Send coverage
76+
# uses: codecov/codecov-action@v5

.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
node_modules/
2-
floattest.js
2+
package-lock.json
3+
/pkg
4+
/pkg.tgz
5+
/dist
6+
DEBUG-*
7+
/.yarn

.husky/pre-commit

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lint-staged

.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
package.json
2+
/LICENSE.md

.yarnrc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodeLinker: node-modules

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Bitfocus AS
3+
Copyright (c) 2022 Bitfocus AS - Open Source
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,64 @@
11
# companion-module-behringer-wing
22
See also HELP.md and LICENSE
33

4-
**V0.5.0**
5-
* Initial release / testing
6-
* Fader, Mute, LED, Colors, Solo, Sends
7-
* With dynamic variables and Feedback
84

9-
**V0.9.0**
10-
* Protocol update
5+
# Changelog
116

12-
**V0.9.1**
13-
* Feedback and Variables
7+
## 2.0.0
148

15-
**V0.9.2**
16-
* Talkback bus control
9+
### Added
10+
- Support for Companion 3.0
11+
- Device discovery listing Behringer Wing devices in configuration screen (inspired by [Behringer X32](https://github.com/bitfocus/companion-module-behringer-x32/tree/master))
12+
- Fade-Curve Easings (copied from [Behringer X32](https://github.com/bitfocus/companion-module-behringer-x32/tree/master))
13+
- Support for Wing Rack and Wing Comapct
1714

18-
**V1.0.0**
19-
* Implement a 'Clear All Solo' function
20-
* Cleanup: remove excess debugging code
15+
### Changed
16+
- Re-structued repository to accomodate for large number of commands (inspired by [ATEM](https://github.com/bitfocus/companion-module-bmd-atem))
17+
- chaned from `action.ts` to `action/` as directory with one file per category
18+
- OSC commands are documented the `commands/` directory, with one file per category. Each command category is its own namespace.
2119

22-
**V1.0.1**
23-
* Fix typos on certain mute actions
20+
## 1.0.4
2421

25-
**V1.0.2**
26-
* Fix Repo URL in HELP.md
22+
### Fixed
23+
- Fix DCA Channel count (16 not 8)
2724

28-
**V1.0.3**
29-
* Fix remaining switch/toggle actions
25+
## 1.0.3
3026

31-
**V1.0.4**
32-
* Fix DCA Channel count (16 not 8)
27+
### Fixed
28+
- Fix remaining switch/toggle actions
29+
30+
## 1.0.2
31+
32+
### Fixed
33+
- Fix Repo URL in HELP.md
34+
35+
## 1.0.1
36+
37+
### Fixed
38+
- Fix typos on certain mute actions
39+
40+
## 1.0.0
41+
42+
### Added
43+
- Implement a 'Clear All Solo' function
44+
45+
### Changed
46+
- Cleanup: remove excess debugging code
47+
48+
## 0.9.2
49+
### Added
50+
- Talkback bus control
51+
52+
## 0.9.1
53+
### Added
54+
- Feedback and Variables
55+
56+
## 0.9.0
57+
### Changed
58+
- Protocol update
59+
60+
## 0.5.0
61+
### Added
62+
- Initial release / testing
63+
- Fader, Mute, LED, Colors, Solo, Sends
64+
- With dynamic variables and Feedback

companion/HELP.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Your module
2+
3+
Write some help for your users here!

companion/manifest.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"id": "behringer-wing",
3+
"name": "behringer-wing",
4+
"shortname": "wing",
5+
"description": "WING OSC",
6+
"version": "0.0.0",
7+
"license": "MIT",
8+
"repository": "git+https://github.com/janikwitzig/companion-module-behringer-wing.git",
9+
"bugs": "https://github.com/janikwitzig/companion-module-behringer-wing/issues",
10+
"maintainers": [
11+
{
12+
"name": "Janik Witzig",
13+
"email": "janik.witzig@bluewin.ch"
14+
}
15+
],
16+
"runtime": {
17+
"type": "node18",
18+
"api": "nodejs-ipc",
19+
"apiVersion": "0.0.0",
20+
"entrypoint": "../dist/index.js"
21+
},
22+
"legacyIds": [],
23+
"manufacturer": "Behringer",
24+
"products": ["WING"],
25+
"keywords": []
26+
}

0 commit comments

Comments
 (0)