Skip to content

Commit 231f566

Browse files
josephdadamsjosephdadams
committed
convert to typescript, add feedbacks
1 parent 91f17db commit 231f566

26 files changed

+3068
-1973
lines changed

‎.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# These are supported funding model platforms
22

3-
github: daniep01 # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
3+
github: [josephdadams, daniep01] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
44
patreon: # Replace with a single Patreon username
55
open_collective: # Replace with a single Open Collective username
66
ko_fi: # Replace with a single Ko-fi username

‎.gitignore

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
node_modules/
2-
package-lock.json
3-
.nova
41
.DS_Store
2+
package-lock.json
3+
node_modules/
4+
/pkg
5+
/pkg.tgz
6+
/dist
7+
DEBUG-*
8+
/.yarn

‎.husky/pre-commit

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lint-staged

‎.vscode/settings.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"[javascript]": {
4+
"editor.defaultFormatter": "biomejs.biome"
5+
},
6+
"[typescript]": {
7+
"editor.defaultFormatter": "biomejs.biome"
8+
},
9+
"[json]": {
10+
"editor.defaultFormatter": "biomejs.biome"
11+
},
12+
"githubIssues.issueBranchTitle": "issue/${issueNumber}",
13+
"explorer.excludeGitIgnore": false
14+
}

‎.yarnrc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodeLinker: node-modules

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Bitfocus AS - Open Source
3+
Copyright (c) 2025 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

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# companion-module-adder-xdip
22

3-
See [HELP.md](companion/HELP.md) and [LICENSE](./LICENSE)
3+
See [HELP.md](./companion/HELP.md) and [LICENSE](./LICENSE)
4+
5+
## Getting started
6+
7+
Executing a `yarn` command should perform all necessary steps to develop the module, if it does not then follow the steps below.
8+
9+
The module can be built once with `yarn build`. This should be enough to get the module to be loadable by companion.
10+
11+
While developing the module, by using `yarn dev` the compiler will be run in watch mode to recompile the files on change.

‎companion/HELP.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Companion Module Adder XDIP
1+
# Adder XDIP
22

33
This module allows you to control an [Adder XDIP](https://www.adder.com/en/kvm-solutions/adderlink-xdip) receiver on your local network.
44

55
## Receiver Setup
66

7-
Before receivers can be controlled by Companion, the ‘Enable Remote Control’ option must be checked within the Advanced page of each receiver’s configuration. The XDIP unit must have firmware version v1.05 or above. _Note:_ XDIP firmware version v1.06 has a bug which prevents the 'Enable Remote Control' option from being saved.
7+
Before receivers can be controlled by Companion, the ‘Enable Remote Control’ option must be checked within the Advanced page of each Receiver’s configuration. The XDIP unit must have firmware version v1.05 or above. _Note:_ XDIP firmware version v1.06 has a bug which prevents the 'Enable Remote Control' option from being saved.
88

99
## Module Setup
1010

@@ -28,11 +28,15 @@ The following actions are possible.
2828

2929
A few variables are available. Variables will only update on connection or when an action is performed. There is no polling so if a channel is changed using the interface on the XDIP Companion variables will be out of date until 'Get Connected Channel' action is used.
3030

31-
**Connected channel id** The number of the channel that the receiver is switched to. These numbers are the same as those shown on the XDIP device menu.
31+
**Connected Channel Id** The number of the channel that the receiver is switched to. These numbers are the same as those shown on the XDIP device menu.
3232

33-
**Connected channel name** The name of the channel that the receiver is switched to.
33+
**Connected Channel Name** The name of the channel that the receiver is switched to.
3434

35-
**Access token state** This variable will show 'Valid' if an access token has been successfully acquired. An access token is required to switch channels.
35+
**Access Token State** This variable will show 'Valid' if an access token has been successfully acquired. An access token is required to switch channels.
36+
37+
**Receiver Name** The name of the Receiver.
38+
39+
**Receiver Description** The description of the Receiver.
3640

3741
## Versions
3842

@@ -43,3 +47,7 @@ First release
4347
### 2.0.0
4448

4549
Rewrite for Companion 3
50+
51+
### 3.0.0
52+
53+
Conversion to TypeScript, add feedbacks

‎companion/manifest.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
"name": "adder-xdip",
44
"shortname": "XDIP",
55
"description": "Companion module for Adder XDIP Receiver",
6-
"version": "2.1.0",
6+
"version": "0.0.0",
77
"license": "MIT",
88
"repository": "git+https://github.com/bitfocus/companion-module-adder-xdip.git",
99
"bugs": "https://github.com/bitfocus/companion-module-adder-xdip/issues",
1010
"maintainers": [
11-
{
12-
"name": "Peter Daniel"
13-
},
1411
{
1512
"name": "Joseph Adams",
1613
"email": "[email protected]"
14+
},
15+
{
16+
"name": "Peter Daniel"
1717
}
1818
],
1919
"legacyIds": [],
2020
"runtime": {
2121
"type": "node18",
2222
"api": "nodejs-ipc",
2323
"apiVersion": "0.0.0",
24-
"entrypoint": "../index.js"
24+
"entrypoint": "../dist/main.js"
2525
},
2626
"manufacturer": "Adder",
2727
"products": ["XDIP"],

0 commit comments

Comments
 (0)