Initial commit

.eslintrc.cjs

@@ -0,0 +1,19 @@
+module.exports = {
+	extends: './node_modules/@companion-module/tools/eslint/main.cjs',
+	overrides: [
+		{
+			files: ['*.ts'],
+			rules: {
+				'no-use-before-define': 'off',
+				'@typescript-eslint/no-use-before-define': 'off',
+				'no-unused-vars': 'off',
+				'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+				'@typescript-eslint/camelcase': 'off',
+				'@typescript-eslint/ban-ts-ignore': 'off',
+				'@typescript-eslint/explicit-function-return-type': 'off',
+				'@typescript-eslint/no-explicit-any': 'off',
+				'prettier/prettier': ['warn', { endOfLine: 'auto' }],
+			},
+		},
+	],
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -1,5 +1,9 @@
 node_modules/
+dist/
 package-lock.json
+.DS_STORE
+
+.idea
 /pkg
 /pkg.tgz
-DEBUG-*
+DEBUG-PACKAGED

.node-version

@@ -0,0 +1 @@
+v18.17.1

.prettierignore

@@ -1,2 +1,4 @@
 package.json
-/LICENSE.md
+pkg
+/LICENSE.md
+node_modules/

.prettierrc

@@ -0,0 +1,9 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"printWidth": 120,
+	"semi": false,
+	"singleQuote": true,
+	"useTabs": true,
+	"endOfLine": "auto"
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Bitfocus AS - Open Source
+Copyright (c) 2024 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,3 +1,14 @@
-# companion-module-[replace with module name]
+# companion-module-getontime-ontime
 
-See [HELP.md](./companion/HELP.md) and [LICENSE](./LICENSE)
+This module is created for use with GoStream Devices.
+
+- [Read the docs](./How%20to%20connect%20to%20computer%20software%20and%20companion.pdf)
+- [Follow on github](https://github.com/bitfocus/companion-module-osee-gostream)
+
+## Help
+
+See [HELP.md](./companion/HELP.md)
+
+## License
+
+[MIT License](./LICENSE)

companion/HELP.md

@@ -1,3 +1,52 @@
-## Your module
+## GoStreamDeck
 
-Write some help for your users here!
+Should work with all models of GoStreamDeck.
+
+Firmware versions 7.5.2 and later are known to work, other versions may experience problems.  
+Firmware versions after 9.2 are not verified to be working at the time of writing, but they likely will work fine.
+
+Devices must be controlled over a network, USB control is NOT supported.
+
+**Available commands for GoStreamDeck**
+
+- Set input on Program
+- Set input on Preview
+- Set inputs on Upstream KEY
+- Set inputs on Downstream KEY
+- Set AUX bus
+- Set Upstream KEY OnAir
+- Auto DSK Transition
+- Tie DSK to transition
+- Set Downstream Key On Air
+- CUT operation
+- AUTO transition operation
+- Change transition type
+- Change transition selection
+- Change transition selection component
+- Change transition rate
+- Set fade to black rate
+- Execute fade to/from black
+- Run MACRO
+- Continue MACRO
+- Stop MACROS
+- Set SuperSource
+- Change media player source
+- Cycle media player source
+- recording control
+- streaming control
+- Classic audio inputs control
+- Fairlight audio inputs control
+
+## Common issues
+
+### Macros not showing as running
+
+Companion is not always able to detect that a macro has been run. This happens when the macro has zero length.
+You can resolve this by giving the macro a pause/sleep of 1 frame.
+
+### Diagnosing connection issues
+
+The most common cause of Companion not being able to connect to your GoStreamDeck is misconfiguration of the networking. Due to how the discovery protocol works, it will see GoStreamDeck that you may not be able to connect to.  
+A good way to rule out Companion as being at fault, is to disconnect the USB to your GoStreamDeck, and use the GoStreamDeck software. If that is unable to connect then it is most likely a network configuration issue.
+
+To be able to connect to your GoStreamDeck, both the GoStreamDeck and your Companion machine must be connected to the same network (ideally cabled, but wifi should work). They must also be of the same IP address range. For example, your network could be `192.168.0.x`, where each machine has a different number instead of the `x`. In most cases the subnet mask should be 255.255.255.0, unless your network is setup to use something else.

companion/manifest.json

@@ -1,26 +1,29 @@
 {
-	"id": "your-module-name",
-	"name": "your-module-name",
-	"shortname": "module-shortname",
-	"description": "A short one line description of your module",
-	"version": "0.0.0",
+	"id": "osee-gostreamdeck",
+	"name": "osee-gostreamdeck",
+	"shortname": "gostreamdeck",
+	"description": "Companion module for GoStreamDeck",
+	"version": "1.0.1",
 	"license": "MIT",
-	"repository": "git+https://github.com/bitfocus/companion-module-your-module-name.git",
-	"bugs": "https://github.com/bitfocus/companion-module-your-module-name/issues",
+	"repository": "git+https://github.com/bitfocus/companion-module-osee-gostream.git",
+	"bugs": "https://github.com/bitfocus/companion-module-osee-gostream/issues",
 	"maintainers": [
 		{
-			"name": "Your name",
-			"email": "Your email"
+			"name": "Carlos Valente",
+			"email": "[email protected]"
+		},
+		{
+			"name": "Fabian Posenau"
 		}
 	],
+	"legacyIds": [],
 	"runtime": {
 		"type": "node18",
 		"api": "nodejs-ipc",
 		"apiVersion": "0.0.0",
-		"entrypoint": "../main.js"
+		"entrypoint": "../dist/index.js"
 	},
-	"legacyIds": [],
-	"manufacturer": "Your company",
-	"products": ["Your product"],
-	"keywords": []
+	"manufacturer": "OSEE",
+	"products": ["GoStreamDeck"],
+	"keywords": ["GoStreamDeck", "companion"]
 }

package.json

@@ -1,21 +1,49 @@
 {
-	"name": "your-module-name",
-	"version": "0.1.0",
-	"main": "main.js",
-	"scripts": {
-		"format": "prettier -w .",
-		"package": "companion-module-build"
-	},
+	"name": "osee-gostreamdeck",
+	"version": "1.0.1",
+	"main": "/dist/index.js",
 	"license": "MIT",
+	"prettier": "@companion-module/tools/.prettierrc.json",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/bitfocus/companion-module-your-module-name.git"
+		"url": "git+https://github.com/bitfocus/companion-module-osee-gostream.git"
+	},
+	"scripts": {
+		"prepare": "husky install",
+		"dev": "yarn build:watch",
+		"build": "rimraf dist && yarn build:main",
+		"build:main": "tsc -p tsconfig.build.json",
+		"build:watch": "tsc -p tsconfig.build.json --watch",
+		"lint": "eslint ./src --ext .ts",
+		"lint:raw": "eslint --ext .ts --ext .js --ignore-pattern dist --ignore-pattern pkg",
+		"format": "prettier -w .",
+		"postinstall": "yarn build"
+	},
+	"engines": {
+		"node": ">=18.12.0"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.7.0"
+		"@companion-module/base": "~1.2.1",
+		"socket.io-client": "^4.5.1"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^1.4.2"
+		"@companion-module/tools": "^1.1.0",
+		"@types/node": "^18.14.0",
+		"@typescript-eslint/eslint-plugin": "^5.53.0",
+		"@typescript-eslint/parser": "^5.53.0",
+		"eslint": "^8.34.0",
+		"eslint-plugin-prettier": "^4.0.0",
+		"husky": "^7.0.4",
+		"lint-staged": "^13.1.2",
+		"prettier": "^2.8.4",
+		"typescript": "~4.9.5"
 	},
-	"prettier": "@companion-module/tools/.prettierrc.json"
+	"lint-staged": {
+		"*.{js,json,md}": [
+			"prettier --write"
+		],
+		"*.ts": [
+			"yarn lint --fix"
+		]
+	}
 }