Merge pull request #3 from phillipivan/main

better status updates

companion/HELP.md

@@ -6,12 +6,12 @@ This module will control NTP Audio Routers that support DOT Protocol.
 
 ## Configuration
 Enter the IP address of the control port of the router controller. The default port is 10005.
-In the case of redundant router controllers, enter the secondary controller IP and port, and enable the redundant controllers switch. 
-When the module is enabled it will try and connect to the Primary, if this fails at anytime it will try and connect to the Secondary, and visa versa. This process typically takes 20 seconds or so, as it relies on the TCP connection going into error before attempting connection to the other controller.
+In the case of redundant router controllers, enter the secondary controller IP and port, and enable the redundant controllers' switch. 
+When the module is enabled, it will try and connect to the Primary, if this fails it will try and connect to the Secondary, and visa-versa. This process typically takes 20 seconds or so, as it relies on the TCP connection going into error before attempting connection to the other controller.
 
 Configure the Source and Destination count, this should be equal to highest index number used for each. The system will limit values entered to the specified range. Refer to the VMC-Config app, Configure>Logical Lines to identify Index values.
 
-The alarms should match the number of configured alarm indexs in your system. Refer to VMC-Config, Configure>Messages. You can edit each entry and check/set the Number field to set the Alarm index.
+The alarms should match the number of configured alarm indexes in your system. Refer to VMC-Config, Configure>Messages. You can edit each entry and check/set the Number field to set the Alarm index.
 
 ## Actions
 
@@ -30,6 +30,10 @@ The alarms should match the number of configured alarm indexs in your system. Re
 
 ## Version History
 
+### Version 1.0.3
+- Better status updates
+- Update dependencies
+
 ### Version 1.0.2
 - Minor TCP improvements & fixes
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ntp-technology-dot",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"main": "src/main.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
@@ -14,10 +14,10 @@
 		"url": "git+https://github.com/bitfocus/companion-module-ntp-technology-dot.git"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.7.0"
+		"@companion-module/base": "~1.8.0"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^1.4.2"
+		"@companion-module/tools": "^1.5.0"
 	},
 	"prettier": "@companion-module/tools/.prettierrc.json"
 }

src/config.js

@@ -1,8 +1,15 @@
-const { Regex } = require('@companion-module/base')
+const { Regex, InstanceStatus } = require('@companion-module/base')
 
 module.exports = {
 	async configUpdated(config) {
 		this.config = config
+		if (this.config.redundant) {
+			if (this.config.hostSec == '' || this.config.portSec == '') {
+				this.log('error', 'Secondary host / port not defined')
+				this.updateStatus(InstanceStatus.BadConfig, 'Secondary not defined')
+				return undefined
+			}
+		}
 		this.useSecondary = false
 		this.initTCP()
 		this.initVariables()
@@ -19,6 +26,7 @@ module.exports = {
 				type: 'textinput',
 				id: 'hostPri',
 				label: 'Primary Host',
+				default: '',
 				width: 8,
 				regex: Regex.HOSTNAME,
 				required: true,
@@ -38,6 +46,7 @@ module.exports = {
 				type: 'textinput',
 				id: 'hostSec',
 				label: 'Secondary Host',
+				default: '',
 				width: 8,
 				regex: Regex.HOSTNAME,
 			},

src/main.js

@@ -15,8 +15,15 @@ class NTP_DOT_PROTOCOL extends InstanceBase {
 		Object.assign(this, { ...config, ...tcp, ...processCmd, ...choices })
 	}
 	async init(config) {
-		this.updateStatus('Starting')
+		this.updateStatus(InstanceStatus.Connecting)
 		this.config = config
+		if (this.config.redundant) {
+			if (this.config.hostSec == '' || this.config.portSec == '') {
+				this.log('error', 'Secondary host / port not defined')
+				this.updateStatus(InstanceStatus.BadConfig, 'Secondary not defined')
+				return undefined
+			}
+		}
 		this.keepAliveTimer = {}
 		this.useSecondary = false
 		this.cmdTimer = setTimeout(() => {
@@ -33,10 +40,14 @@ class NTP_DOT_PROTOCOL extends InstanceBase {
 	// When module gets deleted
 	async destroy() {
 		this.log('debug', `destroy. ID: ${this.id}`)
-		clearTimeout(this.keepAliveTimer)
-		clearTimeout(this.cmdTimer)
-		delete this.keepAliveTimer
-		delete this.cmdTimer
+		if (this.keepAliveTimer) {
+			clearTimeout(this.keepAliveTimer)
+			delete this.keepAliveTimer
+		}
+		if (this.cmdTimer) {
+			clearTimeout(this.cmdTimer)
+			delete this.cmdTimer
+		}
 		if (this.socket) {
 			this.sendCommand(EndSession)
 			this.socket.destroy()

src/processcmd.js

@@ -19,7 +19,6 @@ module.exports = {
 		let alarmIndex = dst
 		let alarmState = src
 		let alarmText = params[2] === undefined ? '' : params[2].toString()
-		//this.log('debug', `control ${ctrl} tag ${tag} param 1 ${params[0]} param 2 ${params[1]} address ${address}`)
 		switch (ctrl) {
 			case control.ackSet:
 				switch (tag) {

src/tcp.js

@@ -74,17 +74,18 @@ module.exports = {
 		if (this.config.hostPri && this.config.portPri) {
 			this.log('debug', 'Creating New Socket')
 			if (this.useSecondary && this.config.hostSec && this.config.portSec) {
-				this.updateStatus('Connecting to Secondary')
+				this.updateStatus(InstanceStatus.Connecting, 'Connecting to Secondary')
 				this.socket = new TCPHelper(this.config.hostSec, this.config.portSec)
 			} else {
-				this.updateStatus('Connecting to Primary')
+				this.updateStatus(InstanceStatus.Connecting, 'Connecting to Primary')
 				this.socket = new TCPHelper(this.config.hostPri, this.config.portPri)
 			}
 			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.clearToTx = true
 				clearTimeout(this.keepAliveTimer)
 				if (this.config.redundant) {
@@ -95,8 +96,10 @@ module.exports = {
 			this.socket.on('connect', () => {
 				if (this.useSecondary && this.config.hostSec) {
 					this.log('info', `Connected on Secondary ${this.config.hostSec}:${this.config.portSec}`)
+					this.updateStatus(InstanceStatus.Ok, `Connected to Secondary`)
 				} else {
 					this.log('info', `Connected on Primary ${this.config.hostPri}:${this.config.portPri}`)
+					this.updateStatus(InstanceStatus.Ok, `Connected to Primary`)
 				}
 				this.clearToTx = true
 				this.receiveBuffer = ''