feat: atem micro panel support (requires companion 3.4)

openapi.yaml

@@ -272,7 +272,9 @@ components:
           type: string
           description: Plugin name of the surface
         pluginComment:
-          type: string
+          type: array
+          items:
+            type: string
           description: Comment about the plugin
       required:
         - pluginId

package.json

@@ -26,7 +26,7 @@
     "dev": "yarn workspace satellite dev",
     "dev:electron": "yarn workspace satellite dev:electron",
     "dev:webui": "yarn workspace webui dev",
-	"build:openapi": "openapi-typescript ./openapi.yaml -o ./satellite/src/generated/openapi.ts",
+    "build:openapi": "openapi-typescript ./openapi.yaml -o ./satellite/src/generated/openapi.ts",
     "build": "yarn workspaces foreach --all run build",
     "lint:raw": "eslint",
     "lint": "eslint .",
@@ -45,6 +45,7 @@
     "eslint-plugin-react-refresh": "^0.4.18",
     "husky": "^9.1.7",
     "lint-staged": "^15.4.3",
+    "openapi-typescript": "^7.6.1",
     "prettier": "^3.4.2",
     "tsx": "^4.19.2",
     "typescript": "~5.7.3",
@@ -54,8 +55,5 @@
   "engines": {
     "node": "^20.14"
   },
-  "packageManager": "[email protected]",
-  "dependencies": {
-    "openapi-typescript": "^7.6.1"
-  }
+  "packageManager": "[email protected]"
 }

satellite/package.json

@@ -36,6 +36,7 @@
 		"node": "^20.14"
 	},
 	"dependencies": {
+		"@blackmagic-controller/node": "^0.1.1",
 		"@elgato-stream-deck/node": "^7.1.2",
 		"@julusian/bonjour-service": "^1.3.0-2",
 		"@julusian/image-rs": "^1.1.1",

satellite/src/client.ts

@@ -84,6 +84,7 @@ export type CompanionSatelliteClientEvents = {
 	brightness: [{ deviceId: string; percent: number }]
 	newDevice: [{ deviceId: string }]
 	clearDeck: [{ deviceId: string }]
+	variableValue: [{ deviceId: string; name: string; value: string }]
 	deviceErrored: [{ deviceId: string; message: string }]
 }
 
@@ -304,6 +305,9 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 			case 'KEYS-CLEAR':
 				this.handleClear(params)
 				break
+			case 'VARIABLE-VALUE':
+				this.handleVariableValue(params)
+				break
 			case 'BRIGHTNESS':
 				this.handleBrightness(params)
 				break
@@ -319,6 +323,7 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 				break
 			case 'KEY-PRESS':
 			case 'KEY-ROTATE':
+			case 'SET-VARIABLE-VALUE':
 				// Ignore
 				break
 			default:
@@ -379,6 +384,26 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 
 		this.emit('clearDeck', { deviceId: params.DEVICEID })
 	}
+	private handleVariableValue(params: Record<string, string | boolean>) {
+		if (typeof params.DEVICEID !== 'string') {
+			console.log('Mising DEVICEID in VARIABLE-VALUE response')
+			return
+		}
+		if (typeof params.VARIABLE !== 'string') {
+			console.log('Missing VARIABLE in VARIABLE-VALUE response')
+			return
+		}
+		if (typeof params.VALUE !== 'string') {
+			console.log('Missing VALUE in VARIABLE-VALUE response')
+			return
+		}
+
+		this.emit('variableValue', {
+			deviceId: params.DEVICEID,
+			name: params.VARIABLE,
+			value: Buffer.from(params.VALUE, 'base64').toString(),
+		})
+	}
 
 	private handleBrightness(params: Record<string, string | boolean>): void {
 		if (typeof params.DEVICEID !== 'string') {
@@ -429,6 +454,16 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 			this.socket.write(`KEY-PRESS DEVICEID=${deviceId} KEY=${keyIndex} PRESSED=0\n`)
 		}
 	}
+	public keyDownXY(deviceId: string, x: number, y: number): void {
+		if (this._connected && this.socket) {
+			this.socket.write(`KEY-PRESS DEVICEID=${deviceId} KEY=${y}/${x} PRESSED=1\n`)
+		}
+	}
+	public keyUpXY(deviceId: string, x: number, y: number): void {
+		if (this._connected && this.socket) {
+			this.socket.write(`KEY-PRESS DEVICEID=${deviceId} KEY=${y}/${x} PRESSED=0\n`)
+		}
+	}
 	public rotateLeft(deviceId: string, keyIndex: number): void {
 		if (this._connected && this.socket) {
 			this.socket.write(`KEY-ROTATE DEVICEID=${deviceId} KEY=${keyIndex} DIRECTION=0\n`)
@@ -439,6 +474,14 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 			this.socket.write(`KEY-ROTATE DEVICEID=${deviceId} KEY=${keyIndex} DIRECTION=1\n`)
 		}
 	}
+	public sendVariableValue(deviceId: string, variable: string, value: string): void {
+		if (this._connected && this.socket) {
+			const encodedValue = Buffer.from(value).toString('base64')
+			this.socket.write(
+				`SET-VARIABLE-VALUE DEVICEID=${deviceId} VARIABLE="${variable}" VALUE="${encodedValue}"\n`,
+			)
+		}
+	}
 
 	public addDevice(deviceId: string, productName: string, props: DeviceRegisterProps): void {
 		if (this._registeredDevices.has(deviceId)) {
@@ -453,12 +496,14 @@ export class CompanionSatelliteClient extends EventEmitter<CompanionSatelliteCli
 		if (this._connected && this.socket) {
 			this._pendingDevices.set(deviceId, Date.now())
 
+			const transferVariables = Buffer.from(JSON.stringify(props.transferVariables ?? [])).toString('base64')
+
 			this.socket.write(
 				`ADD-DEVICE DEVICEID=${deviceId} PRODUCT_NAME="${productName}" KEYS_TOTAL=${
 					props.keysTotal
 				} KEYS_PER_ROW=${props.keysPerRow} BITMAPS=${
 					this._supportsBitmapResolution ? (props.bitmapSize ?? 0) : props.bitmapSize ? 1 : 0
-				} COLORS=${props.colours ? 1 : 0} TEXT=${props.text ? 1 : 0} BRIGHTNESS=${props.brightness ? 1 : 0}\n`,
+				} COLORS=${props.colours ? 1 : 0} TEXT=${props.text ? 1 : 0} VARIABLES=${transferVariables} BRIGHTNESS=${props.brightness ? 1 : 0}\n`,
 			)
 		}
 	}

satellite/src/device-types/api.ts

@@ -20,6 +20,20 @@ export interface DeviceRegisterProps {
 	bitmapSize: number | null
 	colours: boolean
 	text: boolean
+	transferVariables?: Array<DeviceRegisterInputVariable | DeviceRegisterOutputVariable>
+}
+
+export interface DeviceRegisterInputVariable {
+	id: string
+	type: 'input'
+	name: string
+	description?: string
+}
+export interface DeviceRegisterOutputVariable {
+	id: string
+	type: 'output'
+	name: string
+	description?: string
 }
 
 export interface DiscoveredSurfaceInfo<T> {
@@ -50,7 +64,7 @@ export interface SurfacePluginDetection<TInfo> extends EventEmitter<SurfacePlugi
 export interface SurfacePlugin<TInfo> {
 	readonly pluginId: string
 	readonly pluginName: string
-	readonly pluginComment?: string
+	readonly pluginComment?: string[]
 
 	/**
 	 * Some plugins are forced to use a builtin detection mechanism by their surfaces or inner library
@@ -120,6 +134,8 @@ export interface WrappedSurface extends EventEmitter<WrappedSurfaceEvents> {
 
 	draw(data: DeviceDrawProps): Promise<void>
 
+	onVariableValue?(name: string, value: string): void
+
 	showStatus(hostname: string, status: string): void
 }
 
@@ -142,6 +158,11 @@ export interface CompanionClient {
 	keyDown(deviceId: string, keyIndex: number): void
 	keyUp(deviceId: string, keyIndex: number): void
 
+	keyDownXY(deviceId: string, x: number, y: number): void
+	keyUpXY(deviceId: string, x: number, y: number): void
+
 	rotateLeft(deviceId: string, keyIndex: number): void
 	rotateRight(deviceId: string, keyIndex: number): void
+
+	sendVariableValue(deviceId: string, variable: string, value: any): void
 }