Merge pull request #11 from peternewman/presets

Handle source input presets

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/node.yaml

@@ -0,0 +1,40 @@
+name: Node CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Prepare Environment
+        run: |
+          yarn install
+        env:
+          CI: true
+      - name: prettier
+        run: |
+          yarn prettier --check .
+      - name: Test jest
+        run: |
+          yarn test
+        env:
+          CI: true
+      - name: Test package
+        run: |
+          yarn companion-module-build
+        env:
+          CI: true

index.js

@@ -63,8 +63,6 @@ class braviaInstance extends InstanceBase {
 			this.log('info', 'Verbose mode enabled. Log entries will contain detailed information.')
 		}
 
-		this.updateStatus(InstanceStatus.Connecting)
-
 		this.initConnection()
 
 		this.initActions()

package.json

@@ -4,7 +4,7 @@
 	"main": "index.js",
 	"scripts": {
 		"format": "prettier -w .",
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"test": "jest --silent=false"
 	},
 	"repository": {
 		"type": "git",
@@ -17,6 +17,7 @@
 		"node-rest-client": "^3.1.1"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^1.3.2"
+		"@companion-module/tools": "^1.3.2",
+		"jest": "^29.7.0"
 	}
 }

src/actions.js

@@ -66,8 +66,11 @@ module.exports = {
 					id: 'kind',
 					choices: [
 						{ id: 'hdmi', label: 'HDMI' },
+						// TODO(Someone): Add CEC, but the URI has a type and port is optional
+						{ id: 'component', label: 'Component' },
 						{ id: 'composite', label: 'Composite' },
 						{ id: 'scart', label: 'SCART' },
+						{ id: 'widi', label: 'Wi-Fi Display' },
 					],
 				},
 				{

src/api.js

@@ -6,7 +6,7 @@ module.exports = {
 	initConnection: function () {
 		let self = this
 
-		self.updateStatus(InstanceStatus.Ok)
+		self.updateStatus(InstanceStatus.Connecting)
 
 		self.sendCommand('avContent', 'getCurrentExternalInputsStatus', {}, 'allinputs')
 
@@ -19,7 +19,7 @@ module.exports = {
 
 		self.stopInterval()
 
-		if (self.config.interval > 0) {
+		if (self.config.polling !== undefined && self.config.polling && self.config.interval > 0) {
 			self.INTERVAL = setInterval(self.getInformation.bind(self), self.config.interval)
 			self.log('info', 'Starting Update Interval: Every ' + self.config.interval + 'ms')
 		}
@@ -72,13 +72,15 @@ module.exports = {
 					//do something with response
 					try {
 						if (response.statusCode == 200) {
+							self.updateStatus(InstanceStatus.Ok)
 							if (request) {
 								if (data.result) {
 									switch (request) {
 										case 'allinputs':
 											self.DATA.inputs = data.result[0]
 											self.buildInputList()
 											self.initFeedbacks()
+											self.initPresets()
 											break
 										case 'power':
 											self.DATA.powerState = data.result[0].status === 'active' ? true : false
@@ -104,26 +106,53 @@ module.exports = {
 							self.checkVariables()
 						} else {
 							if (response.statusCode == 403) {
+								self.updateStatus(InstanceStatus.ConnectionFailure, 'Error 403, PSK may be incorrect.')
 								self.log('error', 'PSK may be incorrect. Please check your PSK and try again.')
 								self.stopInterval()
 							}
 						}
 					} catch (error) {
+						self.updateStatus(InstanceStatus.UnknownError, 'Failed to process response: ' + error)
 						self.log('error', 'Error processing response: ' + error)
 						console.log(error)
 						console.log(data)
 					}
 				})
 				.on('error', function (error) {
+					self.updateStatus(InstanceStatus.UnknownError, 'Failed to sending command ' + error.toString())
 					self.log('error', 'Error Sending Command ' + error.toString())
 				})
 		} else {
+			self.updateStatus(InstanceStatus.BadConfig, 'No PSK set, not sending.')
 			if (self.config.verbose) {
 				self.log('debug', 'No PSK set. Not sending command.')
 			}
 		}
 	},
 
+	parseDeviceResourceURI: function (uri) {
+		try {
+			resourceURI = new URL(uri)
+			if (resourceURI.protocol == 'extinput:') {
+				let params = resourceURI.searchParams
+				return {
+					// Seemingly not URL.host!
+					kind: resourceURI.pathname,
+					port: parseInt(params.get('port')),
+				}
+			} else {
+				return undefined
+			}
+		} catch (e) {
+			// instanceof doesn't seem to work directly
+			if (e.name == 'TypeError') {
+				return undefined
+			} else {
+				throw e
+			}
+		}
+	},
+
 	buildInputList: function () {
 		let self = this
 

src/api.test.js

@@ -0,0 +1,9 @@
+const api = require('./api.js')
+
+test('parse URI', () => {
+	expect(api.parseDeviceResourceURI('extInput:hdmi?port=1')).toEqual({ kind: 'hdmi', port: 1 })
+	expect(api.parseDeviceResourceURI('extInput:component?port=4')).toEqual({ kind: 'component', port: 4 })
+	expect(api.parseDeviceResourceURI('foo:component?port=4')).toEqual(undefined)
+	expect(api.parseDeviceResourceURI('')).toEqual(undefined)
+	expect(api.parseDeviceResourceURI(undefined)).toEqual(undefined)
+})

src/config.js

@@ -30,6 +30,7 @@ module.exports = {
 				id: 'polling',
 				label: 'Enable Polling',
 				width: 12,
+				default: false,
 			},
 			{
 				type: 'static-text',