Merge pull request #2 from phillipivan/main

Better status updates

Author: phillipivan

Diff for: companion/HELP.md

@@ -1,18 +1,18 @@
 ## Peavy RATC Control Protocol
 
-This module is for control of Peavy NION DSPs. The RATC v1, v2, and v2 RAW modes are supported. All testing performed against Nion's running firmware 2.0. The selected protocol must match what your DSP is configured to use. RATC v2 is a more powerful protocol offering relative (incremental) changes, multiple change groups, and a keep alive. It should be used preferentially unless RATC v1 is required for compatibility reasons. Similarly RATCv2 offers a better experience than RATCv2 RAW unless control of an arbitraily large number of aliases is required, or the system can't be changed due to other dependencies. 
+This module is for control of Peavy NION DSPs. The RATC v1, v2, and v2 RAW modes are supported. All testing performed against Nion's running firmware 2.0. The selected protocol version must match what your DSP configuration. RATC v2 is more powerful, offering relative changes, multiple change groups, and a keep alive. It should be used preferentially unless RATC v1 is required for compatibility reasons. Similarly, RATCv2 offers a better experience than RATCv2 RAW unless control of an arbitrarily large number of aliases is required, or the system can't be changed due to other dependencies. 
 
-This module may work with older Media Matrix units in RATCv1 mode, but this is untested and unsupported.
+This module may work with older Media Matrix units in RATCv1 mode, however this is untested and unsupported.
 
 ### Configuration
 
 **Host** 
 
-Enter the hostname or IP address of the DSP
+Enter the hostname or IP address of the DSP.
 
 **Port**
 
-This should normally normally remain 1632.
+This should normally remain 1632.
 
 **Username / Password**
 
@@ -26,17 +26,17 @@ Disable to use RATC v1 commands.
 
 ### Actions
 
-Most actions require reference to a control alias. The module will auto query and build a drop down list of the control aliases upon connection. You may enter a custom alias if working offline. Refer to Peavy's External Control User Guide for further details.
+Most actions require reference to a control alias. The module will auto query and build a drop-down list of the control aliases upon connection. You may enter a custom alias if working offline. Refer to Peavy's External Control User Guide for further details.
 
 All control aliases in use are added to the default change group so they can be polled periodically. If you use a variable without an associated action, you should manually add it to the default control group.
 
-To create a toggle button use the Control Position Invert action (RATCv2 only), and insert the variable for the controls position as its position value.
+To create a toggle button, use the Control Position Invert action (RATCv2 only), and insert the variable for the controls position as its position value.
 
 ### Variables
 
 The detected control aliases, their values & positions (RATCv2) are returned as variables. Variable names for control aliases containing white space ' ' will be replaced with '_'. Values are kept as strings and retain their units; positions are converted to a number. Note: Returned strings containing whitespace will be truncated at the first whitespace.
 
-Variables are not defined when in RATC v2 RAW mode to preseve system resources. They can still be referenced if you follow the pattern of (yourModuleName:controlAliasValue_rawAlias) or (yourModuleName:controlAliasPosition_rawAlias). However, in the rawAlias the '/' have been substituted with '_'. Ie, $(Nion_N3:controlAliasValue___devices_10_controls_hold_time)
+Variables are not defined when in RATC v2 RAW mode to preserve system resources. They can still be referenced if you follow the pattern of (yourModuleName:controlAliasValue_rawAlias) or (yourModuleName:controlAliasPosition_rawAlias). However, in the rawAlias the '/' have been substituted with '_'. I.e., $(Nion_N3:controlAliasValue___devices_10_controls_hold_time)
 They will not have a value assigned until used by an action.
 
 ### Feedbacks
@@ -45,5 +45,10 @@ No feedbacks are provided. The native Internal Variable Check Value feedback is
 
 ## Version History
 
+### Version 1.0.1
+- Better status updates
+- Minor fixes & typos
+- Companion-module-base updated to 1.8.0
+
 ### Version 1.0.0
 - Initial release

Diff for: package.json

@@ -1,6 +1,6 @@
 {
 	"name": "peavy-ratc",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"main": "src/main.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
@@ -14,7 +14,7 @@
 		"url": "git+https://github.com/bitfocus/companion-module-peavy-ratc.git"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.7.0"
+		"@companion-module/base": "~1.8.0"
 	},
 	"devDependencies": {
 		"@companion-module/tools": "^1.5.0"

Diff for: src/choices.js

@@ -1,5 +1,4 @@
 const { combineRgb } = require('@companion-module/base')
-//const {} = require('./consts.js')
 
 module.exports = async function (self) {
 	self.setFeedbackDefinitions({})

Diff for: src/feedbacks.js

@@ -4,10 +4,8 @@ const UpdateActions = require('./actions.js')
 const UpdateFeedbacks = require('./feedbacks.js')
 const UpdateVariableDefinitions = require('./variables.js')
 const config = require('./config.js')
-//const choices = require('./choices.js')
 const tcp = require('./tcp.js')
 const processCmd = require('./processcmd.js')
-//const {} = require('./consts.js')
 
 class PEAVY_RATC extends InstanceBase {
 	constructor(internal) {
@@ -21,6 +19,11 @@ class PEAVY_RATC extends InstanceBase {
 	async init(config) {
 		this.updateStatus('Starting')
 		this.config = config
+		if (this.config.host === undefined || this.config.port === undefined) {
+			this.log('error', 'Host or port undefined')
+			this.updateStatus(InstanceStatus.BadConfig)
+			return undefined
+		}
 		this.initVariables()
 		this.startTimeOut()
 		this.updateActions() // export actions
@@ -37,7 +40,6 @@ class PEAVY_RATC extends InstanceBase {
 		this.stopTimeOut()
 		this.stopActionUpdateTimer()
 		if (this.socket) {
-			//this.sendCommand(EndSession) no clear disconnect
 			this.socket.destroy()
 		}
 		this.updateStatus(InstanceStatus.Disconnected)

Diff for: src/main.js

@@ -1,4 +1,5 @@
 const { resp, cmd, alert, aliasSep, paramSep, rawAliasIdent } = require('./consts.js')
+const { InstanceStatus } = require('@companion-module/base')
 
 module.exports = {
 	actionUpdate() {
@@ -71,7 +72,7 @@ module.exports = {
 		}
 		if (params[params.length -1] == resp.ratcV1.username) {
 			if (this.config.v2) {
-				this.updateStatus('error', 'Device in RATCv1 mode')
+				this.updateStatus(InstanceStatus.BadConfig, 'Device in RATCv1 mode')
 				this.log('error', `Device in RATCv1 mode`)
 				return false
 			} else {
@@ -82,7 +83,7 @@ module.exports = {
 			case resp.ratcV1.username:
 				//this.sendCommand(this.config.username) - doing this will get stuck in a loop if user/pass is incorrect.
 				if (this.config.v2) {
-					this.updateStatus('error', 'Device in RATCv1 mode')
+					this.updateStatus(InstanceStatus.BadConfig, 'Device in RATCv1 mode')
 					this.log('error', `Device in RATCv1 mode`)
 				}
 				break
@@ -93,7 +94,7 @@ module.exports = {
 				this.log('info', `${reply}`)
 				break
 			case resp.ratcV1.welcome:
-				this.updateStatus('ok', 'Logged in')
+				this.updateStatus(InstanceStatus.Ok, 'Logged in')
 				this.log('info', `${reply}`)
 				this.stopTimeOut()
 				this.startCmdQueue()
@@ -105,7 +106,7 @@ module.exports = {
 				return true
 			case resp.ratcV1.overflow:
 				this.log('error', `${reply}`)
-				this.updateStatus('error', 'Overflow')
+				this.updateStatus(InstanceStatus.UnknownError, 'Overflow')
 				return undefined	
 			case resp.ratcV1.statusIs:
 				this.log('info', `${reply}`)
@@ -143,14 +144,14 @@ module.exports = {
 				break
 			case resp.ratcV1.notRunning:
 				this.log('error', `${reply}`)
-				this.updateStatus('error', 'Project not running')
+				this.updateStatus(InstanceStatus.UnknownError, 'Project not running')
 				break
 			case resp.ratcV1.badCommand:
 				this.log('warn', `${reply}`)
 				break
 			case resp.ratcV1.loginFailed:
 				this.log('error', 'Password is incorrect')
-				this.updateStatus('error', 'Username / Password is incorrect')
+				this.updateStatus(InstanceStatus.BadConfig, 'Username / Password is incorrect')
 				this.stopCmdQueue()
 				this.stopKeepAlive()
 				this.startTimeOut()
@@ -190,7 +191,7 @@ module.exports = {
 				this.setVariableValues(aliasValues)
 				break
 			case resp.ratcV2.loggedIn:
-				this.updateStatus('ok', 'Logged in')
+				this.updateStatus(InstanceStatus.Ok, 'Logged in')
 				this.log('info', 'OK: Logged In')
 				this.stopTimeOut()
 				this.startCmdQueue()
@@ -203,10 +204,12 @@ module.exports = {
 				break
 			case resp.ratcV2.quietModeEnabled:
 				this.log('warn', `${reply} - Quiet Mode Should be disabled for correct operation of this module`)
+				this.updateStatus(InstanceStatus.UnknownWarning, 'Quiet Mode Enabled')
 				this.addCmdtoQueue(cmd.ratcV2.quietModeDisable)
 				break
 			case resp.ratcV2.quietModeDisabled:
 				this.log('info', `Quiet Mode Disabled: ${reply}`)
+				this.updateStatus(InstanceStatus.Ok, 'Quiet Mode Disabled')
 				break
 			case resp.ratcV2.changeGroupControlAdded:
 				this.log('debug', `${reply}`)
@@ -228,7 +231,7 @@ module.exports = {
 				break
 			case resp.ratcV2.overflow:
 				this.log('error', `${reply}`)
-				this.updateStatus('error', 'Overflow')
+				this.updateStatus(InstanceStatus.UnknownError, 'Overflow')
 				return undefined
 			case resp.ratcV2.unlistedControl:
 				this.log('warn', `${reply}`)
@@ -244,11 +247,12 @@ module.exports = {
 				break
 			case resp.ratcV2.notLoggedIn:
 				this.log('error', `${reply}`)
+				this.updateStatus(InstanceStatus.BadConfig, `${reply}`)
 				this.sendCommand(cmd.ratcV2.logIn + paramSep + this.config.username + paramSep + this.config.password)
 				break
 			case resp.ratcV2.loginFailed:
 				this.log('error', 'Password is incorrect')
-				this.updateStatus('error', 'Username / Password is incorrect')
+				this.updateStatus(InstanceStatus.BadConfig, 'Username / Password is incorrect')
 				this.stopCmdQueue()
 				this.stopKeepAlive()
 				this.startTimeOut()

Diff for: src/processcmd.js

@@ -24,18 +24,21 @@ module.exports = {
 		this.log('debug', 'starting cmdTimer')
 		if (this.cmdTimer) {
 			clearTimeout(this.cmdTimer)
-			delete this.cmdTimer
 		}
-		clearTimeout(this.cmdTimer)
 		this.cmdTimer = setTimeout(() => {
 			this.processCmdQueue()
 		}, msgDelay)
 	},
 
 	stopCmdQueue() {
 		this.log('debug', 'stopping cmdTimer')
-		clearTimeout(this.cmdTimer)
-		delete this.cmdTimer
+		if (this.cmdTimer){
+			clearTimeout(this.cmdTimer)
+			delete this.cmdTimer
+		} else {
+			this.log('debug', 'stopCmdQueue called, but this.cmdTimer does not exist')
+		}
+		
 	},
 
 	sendCommand(msg) {
@@ -94,8 +97,12 @@ module.exports = {
 
 	stopKeepAlive() {
 		this.log('debug', 'stopping keepAliveTimer')
-		clearTimeout(this.keepAliveTimer)
-		delete this.keepAliveTimer
+		if (this.keepAliveTimer) {
+			clearTimeout(this.keepAliveTimer)
+			delete this.keepAliveTimer
+		} else {
+			this.log('debug', 'stopKeepAlive called, but this.keepAliveTimer does not exist')
+		}
 	},
 
 	timeOut() {
@@ -119,8 +126,12 @@ module.exports = {
 
 	stopTimeOut() {
 		this.log('debug', 'stopping timeOutTimer')
-		clearTimeout(this.timeOutTimer)
-		delete this.timeOutTimer
+		if (this.timeOutTimer) {
+			clearTimeout(this.timeOutTimer)
+			delete this.timeOutTimer
+		} else {
+			this.log('debug', 'stopTimeOut called, but this.timeOutTimer does not exist')
+		}
 	},
 
 	initTCP() {
@@ -137,21 +148,23 @@ module.exports = {
 		if (this.config.host) {
 			this.log('debug', 'Creating New Socket')
 
-			this.updateStatus(`Connecting to RATC Host: ${this.config.host}:${this.config.port}`)
+			this.updateStatus(InstanceStatus.Connecting, `Connecting to Host: ${this.config.host}`)
 			this.socket = new TCPHelper(this.config.host, this.config.port)
 
 			this.socket.on('status_change', (status, message) => {
 				this.updateStatus(status, message)
 			})
 			this.socket.on('error', (err) => {
 				this.log('error', `Network error: ${err.message}`)
+				this.updateStatus(InstanceStatus.ConnectionFailure, err.message)
 				this.stopCmdQueue()
 				this.stopKeepAlive()
 				this.startTimeOut()
 				this.stopActionUpdateTimer()
 			})
 			this.socket.on('connect', () => {
 				this.log('info', `Connected to ${this.config.host}:${this.config.port}`)
+				this.updateStatus(InstanceStatus.Connecting, `Logging In`)
 				this.receiveBuffer = ''
 				this.queryOnConnect()
 			})