added basic show control functionality: recall scene

Author: janikwitzig

src/actions/control.ts

@@ -0,0 +1,73 @@
+import { CompanionActionDefinitions } from '@companion-module/base'
+import { CompanionActionWithCallback } from './common.js'
+import { InstanceBaseExt } from '../types.js'
+import { WingConfig } from '../config.js'
+import { ControlCommands } from '../commands/control.js'
+import { StateUtil } from '../state/index.js'
+import { GetDropdown } from '../choices/common.js'
+import { getIdLabelPair } from '../choices/utils.js'
+
+export enum OtherActionId {
+	RecallScene = 'recall-scene',
+	SendLibraryAction = 'send-library-action',
+}
+
+export function createControlActions(self: InstanceBaseExt<WingConfig>): CompanionActionDefinitions {
+	const send = self.sendCommand
+	const state = self.state
+	const ensureLoaded = self.ensureLoaded
+
+	const actions: { [id in OtherActionId]: CompanionActionWithCallback | undefined } = {
+		[OtherActionId.RecallScene]: {
+			name: 'Recall Scene',
+			options: [
+				{
+					type: 'number',
+					id: 'num',
+					label: 'Argument',
+					min: 1,
+					max: 16384,
+					default: 1,
+				},
+			],
+			callback: async (event) => {
+				send(ControlCommands.LibrarySceneSelectionIndex(), event.options.num as number)
+				send(ControlCommands.LibraryAction(), 'GO')
+			},
+			subscribe: () => {
+				const cmd = ControlCommands.LibraryActiveSceneIndex()
+				ensureLoaded(cmd)
+			},
+			learn: () => {
+				const cmd = ControlCommands.LibraryActiveSceneIndex()
+				return { num: StateUtil.getNumberFromState(cmd, state) }
+			},
+		},
+		[OtherActionId.SendLibraryAction]: {
+			name: 'Send Library Action',
+			description: 'Set the scribble light color of a channel, aux, bus, matrix or main.',
+			options: [
+				GetDropdown(
+					'Action',
+					'act',
+					[
+						getIdLabelPair('GOPREV', 'Select Previous and Go'),
+						getIdLabelPair('GONEXT', 'Select Next and Go'),
+						getIdLabelPair('GO', 'Go'),
+						getIdLabelPair('PREV', 'Select Previous'),
+						getIdLabelPair('NEXT', 'Select Next'),
+						// getIdLabelPair('GOTAG', 'G'),
+					],
+					'GO',
+				),
+			],
+			callback: async (event) => {
+				const act = event.options.act as string
+				const cmd = ControlCommands.LibraryAction()
+				send(cmd, act)
+			},
+		},
+	}
+
+	return actions
+}

src/actions/index.ts

@@ -10,6 +10,7 @@ import { createMainActions } from './main.js'
 import { createUsbPlayerActions } from './usbplayer.js'
 import { createCardsActions } from './cards.js'
 import { createCommonActions } from './common.js'
+import { createControlActions } from './control.js'
 
 export function createActions(self: InstanceBaseExt<WingConfig>): CompanionActionDefinitions {
 	const actions = {
@@ -22,6 +23,7 @@ export function createActions(self: InstanceBaseExt<WingConfig>): CompanionActio
 		...createUsbPlayerActions(self),
 		...createCardsActions(self),
 		...createConfigurationActions(self),
+		...createControlActions(self),
 	}
 
 	return actions

src/actions/other.ts

@@ -6,6 +6,7 @@ import { WingConfig } from '../config.js'
 export enum OtherActionId {
 	SendCommand = 'send-command',
 	SendCommandWithNumber = 'send-command-with-number',
+	SendCommandWithString = 'send-command-with-string',
 }
 
 export function GetOtherActions(self: InstanceBaseExt<WingConfig>): CompanionActionDefinitions {
@@ -46,6 +47,24 @@ export function GetOtherActions(self: InstanceBaseExt<WingConfig>): CompanionAct
 				send(event.options.cmd as string, event.options.num as number)
 			},
 		},
+		[OtherActionId.SendCommandWithString]: {
+			name: 'Send Command with String',
+			options: [
+				{
+					type: 'textinput',
+					id: 'cmd',
+					label: 'Command',
+				},
+				{
+					type: 'textinput',
+					id: 'val',
+					label: 'Value',
+				},
+			],
+			callback: async (event) => {
+				send(event.options.cmd as string, event.options.val as string)
+			},
+		},
 	}
 
 	return actions

src/commands/control.ts

@@ -0,0 +1,34 @@
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export namespace ControlCommands {
+	export function Node(): string {
+		return `/$ctl`
+	}
+
+	export function LibraryNode(): string {
+		return `${Node()}/lib`
+	}
+
+	export function LibraryScenes(): string {
+		return `${LibraryNode()}/$scenes`
+	}
+
+	export function LibraryActiveSceneIndex(): string {
+		return `${LibraryNode()}/$actidx`
+	}
+
+	export function LibraryActiveSceneName(): string {
+		return `${LibraryNode()}/$active`
+	}
+
+	export function LibraryActiveShowName(): string {
+		return `${LibraryNode()}/$actshow`
+	}
+
+	export function LibraryAction(): string {
+		return `${LibraryNode()}/$action`
+	}
+
+	export function LibrarySceneSelectionIndex(): string {
+		return `${LibraryNode()}/$actionidx`
+	}
+}

src/index.ts

@@ -271,11 +271,11 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 		this.osc.on('message', (message): void => {
 			this.updateStatus(InstanceStatus.Ok)
 			const args = message.args as osc.MetaArgument[]
-			// this.log('debug', `Received ${JSON.stringify(message)}`)
+			this.log('debug', `Received ${JSON.stringify(message)}`)
 			this.state.set(message.address, args)
 
 			if (this.inFlightRequests[message.address]) {
-				this.log('debug', `Received answer for request ${message.address}`)
+				// this.log('debug', `Received answer for request ${message.address}`)
 				this.inFlightRequests[message.address]()
 				delete this.inFlightRequests[message.address]
 			}
@@ -327,12 +327,14 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 		const busNameRe = /\/bus\/\d+\/\$name/
 		const mtxNameRe = /\/mtx\/\d+\/\$name/
 		const mainNameRe = /\/main\/\d+\/\$name/
+		const libRe = /\/$ctl\/lib/
 		if (
 			channelNameRe.test(msg.address) ||
 			busNameRe.test(msg.address) ||
 			auxNameRe.test(msg.address) ||
 			mtxNameRe.test(msg.address) ||
-			mainNameRe.test(msg.address)
+			mainNameRe.test(msg.address) ||
+			libRe.test(msg.address)
 		) {
 			// this.log('info', 'Would update now')
 
@@ -398,10 +400,10 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 			args: args,
 		}
 		this.osc.send(command)
-		this.osc.send({ address: cmd, args: [] })
+		// this.osc.send({ address: cmd, args: [] })
 	}
 
-	ensureLoaded = (path: string): void => {
+	ensureLoaded = (path: string, arg?: string | number): void => {
 		this.requestQueue
 			.add(async () => {
 				if (this.inFlightRequests[path]) {
@@ -418,7 +420,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 					this.inFlightRequests[path] = resolve
 				})
 
-				this.sendCommand(path, undefined)
+				this.sendCommand(path, arg ?? undefined)
 
 				await p
 			})

src/state/state.ts

@@ -13,6 +13,7 @@ type NameChoices = {
 	mains: DropdownChoice[]
 	dcas: DropdownChoice[]
 	mutegroups: DropdownChoice[]
+	scenes: DropdownChoice[]
 }
 
 type Names = {
@@ -23,6 +24,7 @@ type Names = {
 	mains: string[]
 	dcas: string[]
 	mutegroups: string[]
+	scenes: string[]
 }
 export class WingState implements IStoredChannelSubject {
 	private readonly data: Map<string, osc.MetaArgument[]>
@@ -37,6 +39,7 @@ export class WingState implements IStoredChannelSubject {
 		mains: [],
 		dcas: [],
 		mutegroups: [],
+		scenes: [],
 	}
 
 	names: Names = {
@@ -47,6 +50,7 @@ export class WingState implements IStoredChannelSubject {
 		mains: [],
 		dcas: [],
 		mutegroups: [],
+		scenes: [],
 	}
 
 	constructor(model: ModelSpec) {
@@ -191,7 +195,7 @@ export class WingState implements IStoredChannelSubject {
 		}
 	}
 
-	public requestNames(model: ModelSpec, ensureLoaded: (path: string) => void): void {
+	public requestNames(model: ModelSpec, ensureLoaded: (path: string, arg?: string | number) => void): void {
 		for (let ch = 1; ch <= model.channels; ch++) {
 			ensureLoaded(Commands.Channel.RealName(ch))
 		}