Merge pull request #33 from phillipivan/master

Add Set Value ENUM from Variable

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "generic-emberplus",
-	"version": "2.3.0",
+	"version": "2.3.1",
 	"main": "dist/index.js",
 	"scripts": {
 		"prepare": "husky",
@@ -34,7 +34,7 @@
 		"emberplus-connection": "^0.2.1"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^2.0.3",
+		"@companion-module/tools": "^2.0.4",
 		"eslint": "^9.10.0",
 		"husky": "^9.1.6",
 		"lint-staged": "^15.2.0",

src/actions.ts

@@ -18,6 +18,7 @@ export enum ActionId {
 	SetValueString = 'setValueString',
 	SetValueBoolean = 'setValueBoolean',
 	SetValueEnum = 'setValueEnum',
+	SetValueEnumVariable = 'setValueEnumVariable',
 	MatrixConnect = 'matrixConnect',
 	MatrixDisconnect = 'matrixDisconnect',
 	MatrixSetConnection = 'matrixSetConnection',
@@ -32,6 +33,7 @@ const pathInput: CompanionInputFieldTextInput = {
 	label: 'Path',
 	id: 'path',
 	useVariables: true,
+	tooltip: `Path may be supplied in decimals: 1.2.3, or with a descriptor and the decimals wrapped in brackets: path/to/ember/element[1.2.3.4]`,
 }
 const matrixInputs: Array<CompanionInputFieldTextInput | CompanionInputFieldNumber> = [
 	pathInput,
@@ -53,10 +55,18 @@ const matrixInputs: Array<CompanionInputFieldTextInput | CompanionInputFieldNumb
 	},
 ]
 
+async function resolvePath(self: InstanceBase<EmberPlusConfig>, path: string): Promise<string> {
+	const pathString: string = await self.parseVariablesInString(path)
+	if (pathString.includes('[') && pathString.includes(']')) {
+		return pathString.substring(pathString.indexOf('[') + 1, pathString.indexOf(']'))
+	}
+	return pathString
+}
+
 const setValue =
 	(self: InstanceBase<EmberPlusConfig>, emberClient: EmberClient, type: EmberModel.ParameterType) =>
 	async (action: CompanionActionEvent): Promise<void> => {
-		const path = await self.parseVariablesInString(action.options['path']?.toString() ?? '')
+		const path = await resolvePath(self, action.options['path']?.toString() ?? '')
 		const node = await emberClient.getElementByPath(path)
 		// TODO - do we handle not found?
 		if (node && node.contents.type === EmberModel.ElementType.Parameter) {
@@ -72,7 +82,18 @@ const setValue =
 					request.response?.catch(() => null) // Ensure the response is 'handled'
 				} else if (type === EmberModel.ParameterType.Integer) {
 					const value: number = parseInt(await self.parseVariablesInString(action.options['value']?.toString() ?? ''))
-					if (isNaN(value)) {
+					if (isNaN(value) || value > 4294967295 || value < -4294967295) {
+						return
+					}
+					const request = await emberClient.setValue(
+						node as EmberModel.NumberedTreeNode<EmberModel.Parameter>,
+						value,
+						false,
+					)
+					request.response?.catch(() => null) // Ensure the response is 'handled'
+				} else if (type === EmberModel.ParameterType.Enum) {
+					const value: number = parseInt(await self.parseVariablesInString(action.options['value']?.toString() ?? ''))
+					if (isNaN(value) || value > 4294967295 || value < 0) {
 						return
 					}
 					const request = await emberClient.setValue(
@@ -107,7 +128,7 @@ const doMatrixAction =
 		method: EmberClient['matrixConnect'] | EmberClient['matrixDisconnect'] | EmberClient['matrixSetConnection'],
 	) =>
 	async (action: CompanionActionEvent): Promise<void> => {
-		const path = await self.parseVariablesInString(action.options['path']?.toString() ?? '')
+		const path = await resolvePath(self, action.options['path']?.toString() ?? '')
 		self.log('debug', 'Get node ' + path)
 		const node = await emberClient.getElementByPath(path)
 		// TODO - do we handle not found?
@@ -349,6 +370,22 @@ export function GetActionsList(
 			],
 			callback: setValue(self, emberClient, EmberModel.ParameterType.Enum),
 		},
+		[ActionId.SetValueEnumVariable]: {
+			name: 'Set Value ENUM from Variable (as Integer)',
+			options: [
+				pathInput,
+				{
+					type: 'textinput',
+					label: 'Value',
+					id: 'value',
+					required: true,
+					useVariables: true,
+					default: '0',
+					tooltip: 'Return an integer between 0 and 4294967295',
+				},
+			],
+			callback: setValue(self, emberClient, EmberModel.ParameterType.Enum),
+		},
 		[ActionId.SetValueString]: {
 			name: 'Set Value String',
 			options: [

yarn.lock

@@ -22,9 +22,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@companion-module/tools@npm:^2.0.3":
-  version: 2.0.3
-  resolution: "@companion-module/tools@npm:2.0.3"
+"@companion-module/tools@npm:^2.0.4":
+  version: 2.0.4
+  resolution: "@companion-module/tools@npm:2.0.4"
   dependencies:
     "@eslint/js": "npm:^9.10.0"
     eslint-config-prettier: "npm:^9.1.0"
@@ -52,7 +52,7 @@ __metadata:
     companion-generate-manifest: scripts/generate-manifest.js
     companion-module-build: scripts/build.js
     companion-module-check: scripts/check.js
-  checksum: 10c0/b69b27071442c92f1df1aa1ddc860556502e2774b12d1cdcae0db162f7b0ca534b1d2050894e188b5c48edcf34e67a3ca7843bd6bb7cc7352abe0bbf4508d543
+  checksum: 10c0/ce795f8ede524b2984a5c4fc744267fc8b9dab8fa9602295f13348ce340cf9e8ec5ebbb1ab4cf415f8780ba8d89f4d67f936a4d5b9f0539ba9573cdbc129d6d4
   languageName: node
   linkType: hard
 
@@ -1533,7 +1533,7 @@ asn1@evs-broadcast/node-asn1:
   resolution: "generic-emberplus@workspace:."
   dependencies:
     "@companion-module/base": "npm:~1.10.0"
-    "@companion-module/tools": "npm:^2.0.3"
+    "@companion-module/tools": "npm:^2.0.4"
     "@types/node": "npm:^18.19.45"
     emberplus-connection: "npm:^0.2.1"
     eslint: "npm:^9.10.0"