Bump colord from 2.9.3 to 2.10.0 (#61)

Bumps [colord](https://github.com/omgovich/colord) from 2.9.3 to 2.10.0.
- [Release notes](https://github.com/omgovich/colord/releases)
- [Changelog](https://github.com/omgovich/colord/blob/master/CHANGELOG.md)
- [Commits](https://github.com/omgovich/colord/commits/v2.10)

---
updated-dependencies:
- dependency-name: colord
  dependency-version: 2.10.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: josephdadams # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,70 @@
+name: Bug report
+description: Create a bug report to help us improve.
+labels:
+  - BUG
+title: '[BUG]'
+body:
+  - type: checkboxes
+    attributes:
+      label: Make sure you have updated to the latest version of the module
+      description: This may be a beta version of the module, or may require you to update your companion.
+      options:
+        - label: I have checked this on the latest version of the module
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. Screenshots are always helpful to understand the problem.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment (please complete the following information)
+      description: |
+        examples:
+          - **OS**: Windows 10
+          - **Browser**: Chrome 94
+          - **Companion Version**: 2.2.0-b177f8fb-3722
+          - **Module Version**: 1.0.0
+          - **Device Firmware/Software Version (If applicable)**: 3.0.6
+          - **Device Model (If applicable)**: My Device PRO
+      value: |
+        - OS:
+        - Browser:
+        - Companion Version:
+        - Module Version:
+        - Device Firmware/Software Version (If applicable):
+        - Device Model (If applicable):
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: BUG OR FEATURE REQUEST FOR COMPANION ITSELF
+    url: https://github.com/bitfocus/companion/issues
+    about: Report it against the companion itself, to get the relevant people notified.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,32 @@
+name: Feature Request
+description: Request a new feature within this module
+title: '[Feature]: '
+labels:
+  - enhancement
+body:
+  - type: checkboxes
+    attributes:
+      label: Make sure you have updated to the latest version of the module
+      description: This may be a beta version of the module, or may require you to update your companion.
+      options:
+        - label: I have checked this on the latest version of the module
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the feature.
+      options:
+        - label: I have searched for similar existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe the feature
+      description: A clear and concise description of what the feature does. Mocked up screenshots (no matter how rough) are always helpful in understanding.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Usecases
+      description: Add a couple of usecases for why this should be implemented and when/why to use it.
+    validations:
+      required: false

.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
+

.gitignore

@@ -2,4 +2,5 @@ node_modules/
 
 # Companion 3
 /pkg
-/pkg.tgz
+/pkg.tgz
+.DS_Store

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rossvideo-rosstalk",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"main": "rosstalk.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
@@ -11,9 +11,9 @@
 		"url": "git+https://github.com/bitfocus/companion-module-rossvideo-rosstalk.git"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.1.0"
+		"@companion-module/base": "^1.5.0"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^0.5.2"
+		"@companion-module/tools": "^2.8.0"
 	}
 }

rosstalk.js

@@ -1,4 +1,4 @@
-const { TCPHelper, InstanceBase, runEntrypoint } = require('@companion-module/base')
+const { TCPHelper, InstanceBase, InstanceStatus, runEntrypoint } = require('@companion-module/base')
 
 const config = require('./src/config')
 const actions = require('./src/actions')
@@ -31,10 +31,16 @@ class RossTalkInstance extends InstanceBase {
 		let self = this
 		self.config = config
 		self.actions()
-		self.init_tcp()
+
+		if (self.config.keepAlive) {
+			self.init_tcp();
+		}
+		else {
+			self.updateStatus(InstanceStatus.Ok);
+		}
 	}
 
-	init_tcp() {
+	init_tcp(cmd) {
 		var self = this
 
 		if (self.socket !== undefined) {
@@ -42,6 +48,8 @@ class RossTalkInstance extends InstanceBase {
 			delete self.socket
 		}
 
+		self.log('debug', 'Opening socket.');
+
 		if (self.config.host) {
 			if (self.config.port === undefined) {
 				self.config.port = 7788
@@ -61,8 +69,18 @@ class RossTalkInstance extends InstanceBase {
 			})
 
 			self.socket.on('connect', function () {
-				self.updateStatus('ok')
+				self.updateStatus(InstanceStatus.Ok)
 				self.log('debug', 'Connected')
+				if (cmd !== undefined) {
+					self.log('debug', `sending tcp ${cmd} to ${self.config.host}`);
+					self.socket.send(cmd + '\r\n');
+
+					if (!self.config.keepAlive) {
+						self.log('debug', 'Closing socket.');
+						self.socket.destroy()
+						delete self.socket
+					}
+				}
 			})
 
 			self.socket.on('data', function (data) {})

src/actions.js

@@ -5,29 +5,20 @@ module.exports = {
 
 		const re_meSource_meNumber = '/^(ME|MME|MSC):[0-9]{1,2}$/'
 
-		const sendCommand = async (action) => {
+		const sendCommand = (cmd) => {
 			if (cmd !== undefined) {
-				self.log('debug', 'sending tcp', cmd, 'to', self.config.host)
-
-				if (self.socket !== undefined && self.socket.connected) {
-					await self.socket.send(cmd + '\r\n')
-					if (!self.config.keepAlive) {
-						self.socket = self.init_tcp()
-					}
+				if (!self.config.keepAlive) {
+					self.init_tcp(cmd);
+				}
+				else if (self.socket !== undefined && self.socket.isConnected) {
+					self.log('debug', `sending tcp ${cmd} to ${self.config.host}`)
+					self.socket.send(cmd + '\r\n')
 				} else {
 					self.log('debug', 'Socket not connected :(')
 				}
 			}
-
-			self.log('debug', 'action():', action)
 		}
 
-		const parseVariable = async (input) => {
-			if (typeof input === 'string' && input.includes('$(')) {
-				return await self.parseVariablesInString(input)
-			}
-			return input
-		}
 
 		let actions = {
 			gpi: {
@@ -39,11 +30,13 @@ module.exports = {
 						id: 'gpi',
 						default: '1',
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var gpi = parseInt(opt.gpi)
+					let gpiText = await context.parseVariablesInString(opt.gpi)
+					var gpi = parseInt(gpiText)
 					cmd =
 						'GPI ' + (gpi <= 9 && (self.config.model == 'carbonite' || self.config.model == 'acuity') ? '0' : '') + gpi
 					sendCommand(cmd)
@@ -63,17 +56,19 @@ module.exports = {
 						type: 'textinput',
 						label: 'Parameter',
 						id: 'parameter',
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
 
 					if (opt.gpi) {
-						let gpi = parseVariable(opt.gpi)
-						if (opt.parameter === null) {
+						let gpi = await context.parseVariablesInString(opt.gpi)
+						let parameter = await context.parseVariablesInString(opt.parameter)
+						if (parameter === null) {
 							cmd = 'GPI ' + gpi
 						} else {
-							cmd = 'GPI ' + gpi + ':' + opt.parameter
+							cmd = 'GPI ' + gpi + ':' + parameter
 						}
 						sendCommand(cmd)
 					}
@@ -88,11 +83,13 @@ module.exports = {
 						type: 'textinput',
 						label: 'Command',
 						id: 'cmd',
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					sendCommand(opt.cmd)
+					let cmd = await context.parseVariablesInString(opt.cmd)
+					sendCommand(cmd)
 				},
 			},
 		}
@@ -106,6 +103,7 @@ module.exports = {
 						id: 'bank',
 						default: '1',
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'textinput',
@@ -113,12 +111,15 @@ module.exports = {
 						id: 'cc',
 						default: '1',
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var cc = parseInt(opt.cc)
-					cmd = 'CC ' + parseInt(opt.bank) + ':' + (cc > 9 ? '' : '0') + cc
+					let bankText = await context.parseVariablesInString(opt.bank)
+					let ccText = await context.parseVariablesInString(opt.cc)
+					var cc = parseInt(ccText)
+					cmd = 'CC ' + parseInt(bankText) + ':' + (cc > 9 ? '' : '0') + cc
 					sendCommand(cmd)
 				},
 			}
@@ -133,9 +134,9 @@ module.exports = {
 						default: 'set1',
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let set = parseVariable(opt.set)
+					let set = await context.parseVariablesInString(opt.set)
 					cmd = 'LOADSET ' + set
 					sendCommand(cmd)
 				},
@@ -153,9 +154,9 @@ module.exports = {
 						regex: re_meSource_meNumber,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
+					let mle = await context.parseVariablesInString(opt.mle)
 					cmd = 'MECUT ' + mle
 					sendCommand(cmd)
 				},
@@ -172,9 +173,9 @@ module.exports = {
 						regex: re_meSource_meNumber,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
+					let mle = await context.parseVariablesInString(opt.mle)
 					cmd = 'MEAUTO ' + mle
 					sendCommand(cmd)
 				},
@@ -201,10 +202,10 @@ module.exports = {
 						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var src = parseVariable(opt.vidSource)
-					var dst = parseVariable(opt.vidDest)
+					var src = await context.parseVariablesInString(opt.vidSource)
+					var dst = await context.parseVariablesInString(opt.vidDest)
 					cmd = 'XPT ' + dst + ':' + src
 					console.log('ross xpt:', cmd)
 					sendCommand(cmd)
@@ -227,6 +228,7 @@ module.exports = {
 						id: 'key',
 						default: 1,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'dropdown',
@@ -250,13 +252,14 @@ module.exports = {
 						],
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
+					let mle = await context.parseVariablesInString(opt.mle)
+					let keyText = await context.parseVariablesInString(opt.key)
 					if (opt.transD === 'TOGGLE') {
-						cmd = 'KEY' + opt.transT + ' ' + mle + ':' + opt.key
+						cmd = 'KEY' + opt.transT + ' ' + mle + ':' + keyText
 					} else {
-						cmd = 'KEY' + opt.transT + opt.transD + ' ' + mle + ':' + opt.key
+						cmd = 'KEY' + opt.transT + opt.transD + ' ' + mle + ':' + keyText
 					}
 					sendCommand(cmd)
 				},
@@ -264,7 +267,7 @@ module.exports = {
 			actions.ftb = {
 				label: 'Fade to black',
 				options: [],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					cmd = 'FTB'
 					sendCommand(cmd)
 				},
@@ -279,11 +282,12 @@ module.exports = {
 						id: 'memID',
 						default: '1:1',
 						regex: '/^[0-9]{1,2}(:(ME|MME|MSC):[0-9]{1,2})+$/',
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var memID = opt.memID
+					var memID = await context.parseVariablesInString(opt.memID)
 					cmd = 'MEM ' + memID
 					sendCommand(cmd)
 				},
@@ -297,6 +301,7 @@ module.exports = {
 						id: 'takeID',
 						default: 0,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'textinput',
@@ -304,12 +309,13 @@ module.exports = {
 						id: 'Layer',
 						default: 0,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var takeID = opt.takeID
-					var layer = opt.layer
+					var takeID = await context.parseVariablesInString(opt.takeID)
+					var layer = await context.parseVariablesInString(opt.Layer)
 					cmd = 'SEQI ' + takeID + ':' + layer
 					sendCommand(cmd)
 				},
@@ -323,15 +329,53 @@ module.exports = {
 						id: 'takeID',
 						default: 0,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var takeID = opt.takeID
+					var takeID = await context.parseVariablesInString(opt.takeID)
 					cmd = 'SEQO ' + takeID
 					sendCommand(cmd)
 				},
 			}
+			actions.MVBOX = {
+				name: "Change multiviewer box",
+				options: [
+					{
+						type: 'textinput',
+						label: 'Multiviewer Number',
+						id: 'mvID',
+						default: 1,
+						regex: Regex.NUMBER,
+					},
+					{
+						type: 'textinput',
+						label: 'Box Number',
+						id: 'boxID',
+						default: 1,
+						regex: Regex.NUMBER,
+					},
+					{
+						type: 'textinput',
+						label: 'Source',
+						id: 'vidSource',
+						default: 'IN:5',
+						tooltip:
+							'Aux Bus — AUX:(aux-number), Black — BK, Clean — ME:(ME-number):CLN, Input Source — IN:(input-number), Key — ME:(ME-number):KEY:(key-number), Matte Color — BG, Media-Store — MS:(channel-number), MiniME™ — MME:(ME-number), Preview — ME:(ME-number):PV, Program — ME:(ME-number):PGM, [Graphite only], Chroma Key Video — CK:(chroma key number) [UltraChromeHR, or Carbonite Black v14.0 or higher only], Chroma Key Alpha — CKA:(chroma key number) [UltraChromeHR, or Carbonite Black v14.0 or higher only]',
+						useVariables: true
+					}
+				],
+				callback: async (event, context) => {
+					let opt = event.options
+					let mvID = parseInt(opt.mvID)
+					let boxID = parseInt(opt.boxID)
+					var src = await context.parseVariablesInString(opt.vidSource)
+
+					cmd = 'MVBOX:' + mvID + ":" + boxID + ":" + src
+					sendCommand(cmd)
+				}
+			}
 		}
 		if (self.config.model == 'acuity') {
 			actions.cc = {
@@ -343,6 +387,7 @@ module.exports = {
 						id: 'bank',
 						default: '1',
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'textinput',
@@ -350,12 +395,15 @@ module.exports = {
 						id: 'cc',
 						default: '1',
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var cc = parseInt(opt.cc)
-					cmd = 'CC ' + parseInt(opt.bank) + ':' + (cc > 9 ? '' : '0') + cc
+					let bankText = await context.parseVariablesInString(opt.bank)
+					let ccText = await context.parseVariablesInString(opt.cc)
+					var cc = parseInt(ccText)
+					cmd = 'CC ' + parseInt(bankText) + ':' + (cc > 9 ? '' : '0') + cc
 					sendCommand(cmd)
 				},
 			}
@@ -376,6 +424,7 @@ module.exports = {
 						id: 'key',
 						default: 1,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'dropdown',
@@ -388,10 +437,11 @@ module.exports = {
 						],
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
-					cmd = 'KEY' + opt.transT + ' ' + mle + ':' + opt.key
+					let mle = await context.parseVariablesInString(opt.mle)
+					let keyText = await context.parseVariablesInString(opt.key)
+					cmd = 'KEY' + opt.transT + ' ' + mle + ':' + keyText
 					sendCommand(cmd)
 				},
 			}
@@ -416,10 +466,11 @@ module.exports = {
 						default: 'set1',
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let set = parseVariable(opt.set)
-					cmd = 'LOADSET ' + opt.location + ':' + set
+					let set = await context.parseVariablesInString(opt.set)
+					let location = await context.parseVariablesInString(opt.location)
+					cmd = 'LOADSET ' + location + ':' + set
 					sendCommand(cmd)
 				},
 			}
@@ -435,9 +486,9 @@ module.exports = {
 						default: '1',
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
+					let mle = await context.parseVariablesInString(opt.mle)
 					cmd = 'MECUT ' + mle
 					sendCommand(cmd)
 				},
@@ -445,7 +496,7 @@ module.exports = {
 			actions.ftb = {
 				label: 'Fade to black',
 				options: [],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					cmd = 'FTB'
 					sendCommand(cmd)
 				},
@@ -460,11 +511,12 @@ module.exports = {
 						id: 'memID',
 						default: '1:1',
 						regex: '/^[0-9]{1,2}|?(:[0-9]{1,2})+$/',
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var memID = opt.memID
+					var memID = await context.parseVariablesInString(opt.memID)
 					cmd = 'MEM ' + memID
 					sendCommand(cmd)
 				},
@@ -482,9 +534,9 @@ module.exports = {
 						regex: Regex.NUMBER,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
+					let mle = await context.parseVariablesInString(opt.mle)
 					cmd = 'MEAUTO ' + mle
 					sendCommand(cmd)
 				},
@@ -512,10 +564,10 @@ module.exports = {
 						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					var src = parseVariable(opt.vidSource)
-					var dst = parseVariable(opt.vidDest)
+					var src = await context.parseVariablesInString(opt.vidSource)
+					var dst = await context.parseVariablesInString(opt.vidDest)
 					cmd = 'XPT ' + dst + ':' + src
 					console.log('ross xpt:', cmd)
 					sendCommand(cmd)
@@ -544,12 +596,14 @@ module.exports = {
 						id: 'timerID',
 						default: 0,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
 					var timerAction = opt.timerAction
-					var timerID = parseInt(opt.timerID)
+					var timerIDText = await context.parseVariablesInString(opt.timerID)
+					var timerID = parseInt(timerIDText)
 					cmd = 'TIMER ' + timerID + ':' + timerAction
 					sendCommand(cmd)
 				},
@@ -560,7 +614,7 @@ module.exports = {
 				label: 'Fade to black',
 				description: 'Not supported on the MDK-111A-K.',
 				options: [],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					cmd = 'FTB'
 					sendCommand(cmd)
 				},
@@ -583,6 +637,7 @@ module.exports = {
 						id: 'key',
 						default: 1,
 						regex: Regex.NUMBER,
+						useVariables: true,
 					},
 					{
 						type: 'dropdown',
@@ -595,10 +650,11 @@ module.exports = {
 						],
 					},
 				],
-				callback: async (event) => {
+				callback: async (event, context) => {
 					let opt = event.options
-					let mle = parseVariable(opt.mle)
-					cmd = 'KEY' + opt.transT + ' ' + mle + ':' + opt.key
+					let mle = await context.parseVariablesInString(opt.mle)
+					let keyText = await context.parseVariablesInString(opt.key)
+					cmd = 'KEY' + opt.transT + ' ' + mle + ':' + keyText
 					sendCommand(cmd)
 				},
 			}