feat: add grid location to tcp/udp api

lib/Service/Tcp.js

@@ -46,7 +46,7 @@ class ServiceTcp extends ServiceTcpBase {
 	constructor(registry) {
 		super(registry, 'tcp', 'Service/Tcp', 'tcp_enabled', 'tcp_listen_port')
 
-		this.#api = new ServiceTcpUdpApi(registry)
+		this.#api = new ServiceTcpUdpApi(registry, 'tcp')
 
 		this.graphics.on('button_drawn', (location, render) => {
 			const bgcolor = render.style?.bgcolor || 0

lib/Service/TcpUdpApi.js

@@ -1,4 +1,6 @@
 import CoreBase from '../Core/Base.js'
+import { parseColorToNumber } from '../Resources/Util.js'
+import { formatLocation } from '../Shared/ControlId.js'
 import RegexRouter from './RegexRouter.js'
 
 /**
@@ -27,22 +29,39 @@ export class ServiceTcpUdpApi extends CoreBase {
 	 * Message router
 	 * @type {RegexRouter}
 	 * @access private
+	 * @readonly
 	 */
 	#router
 
+	/**
+	 * Protocol name
+	 * @type {string}
+	 * @access private
+	 * @readonly
+	 */
+	#protocolName
+
+	get router() {
+		return this.#router
+	}
+
 	/**
 	 * @param {import('../Registry.js').default} registry - the core registry
+	 * @param {stirng} protocolName - the protocol name
 	 */
-	constructor(registry) {
+	constructor(registry, protocolName) {
 		super(registry, 'api', 'Service/Api')
 
 		this.#router = new RegexRouter(() => {
 			throw new ApiMessageError('Syntax error')
 		})
-		this.#setupRoutes()
+		this.#protocolName = protocolName
+
+		this.#setupLegacyRoutes()
+		this.#setupNewRoutes()
 	}
 
-	#setupRoutes() {
+	#setupLegacyRoutes() {
 		this.#router.addPath('page-set :page(\\d+) :deviceId', (match) => {
 			const page = parseInt(match.page)
 			const deviceId = match.deviceId
@@ -73,13 +92,13 @@ export class ServiceTcpUdpApi extends CoreBase {
 
 			this.logger.info(`Got bank-press (trigger) ${controlId}`)
 
-			if (!this.controls.pressControl(controlId, true)) {
+			if (!this.controls.pressControl(controlId, true, this.#protocolName)) {
 				throw new ApiMessageError('Page/bank out of range')
 			}
 
 			setTimeout(() => {
 				this.logger.info(`Auto releasing bank-press ${controlId}`)
-				this.controls.pressControl(controlId, false)
+				this.controls.pressControl(controlId, false, this.#protocolName)
 			}, 20)
 		})
 
@@ -88,7 +107,7 @@ export class ServiceTcpUdpApi extends CoreBase {
 
 			this.logger.info(`Got bank-down (trigger) ${controlId}`)
 
-			if (!this.controls.pressControl(controlId, true)) {
+			if (!this.controls.pressControl(controlId, true, this.#protocolName)) {
 				throw new ApiMessageError('Page/bank out of range')
 			}
 		})
@@ -98,7 +117,7 @@ export class ServiceTcpUdpApi extends CoreBase {
 
 			this.logger.info(`Got bank-up (trigger) ${controlId}`)
 
-			if (!this.controls.pressControl(controlId, false)) {
+			if (!this.controls.pressControl(controlId, false, this.#protocolName)) {
 				throw new ApiMessageError('Page/bank out of range')
 			}
 		})
@@ -170,13 +189,211 @@ export class ServiceTcpUdpApi extends CoreBase {
 				throw new ApiMessageError('Scan failed')
 			}
 		})
+	}
+
+	#surfaceSetPage = (match) => {
+		const page = parseInt(match.page)
+		const surfaceId = match.surfaceId
+
+		this.surfaces.devicePageSet(surfaceId, page)
+
+		return `If ${surfaceId} is connected`
+	}
+	#surfacePageUp = (match) => {
+		const surfaceId = match.surfaceId
+
+		this.surfaces.devicePageUp(surfaceId)
+
+		return `If ${surfaceId} is connected`
+	}
+	#surfacePageDown = (match) => {
+		const surfaceId = match.surfaceId
+
+		this.surfaces.devicePageDown(surfaceId)
+
+		return `If ${surfaceId} is connected`
+	}
+
+	#locationPress = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location press at ${formatLocation(location)} (${controlId})`)
+
+		if (!controlId || !this.controls.pressControl(controlId, true, this.#protocolName)) {
+			throw new ApiMessageError('No control at location')
+		}
+
+		setTimeout(() => {
+			this.logger.info(`Auto releasing ${formatLocation(location)} (${controlId})`)
+			this.controls.pressControl(controlId, false, this.#protocolName)
+		}, 20)
+	}
+	#locationDown = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location down at ${formatLocation(location)} (${controlId})`)
+
+		if (!controlId || !this.controls.pressControl(controlId, true, this.#protocolName)) {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+	#locationUp = (match) => {
+		const { location, controlId } = this.#locationParse(match)
 
-		this.#router.addPath('custom-variable :name set-value :value(.*)', async (match) => {
-			const result = this.instance.variable.custom.setValue(match.name, match.value)
-			if (result) {
-				throw new ApiMessageError(result)
+		this.logger.info(`Got location up at ${formatLocation(location)} (${controlId})`)
+
+		if (!controlId || !this.controls.pressControl(controlId, false, this.#protocolName)) {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+	#locationRotateLeft = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location rotate-left at ${formatLocation(location)} (${controlId})`)
+
+		if (!controlId || !this.controls.rotateControl(controlId, false, this.#protocolName)) {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+	#locationRotateRight = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location rotate-right at ${formatLocation(location)} (${controlId})`)
+
+		if (!controlId || !this.controls.rotateControl(controlId, true, this.#protocolName)) {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+	#locationSetStep = (match) => {
+		const step = parseInt(match.step)
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location set-step at ${formatLocation(location)} (${controlId}) to ${step}`)
+		if (!controlId) {
+			throw new ApiMessageError('No control at location')
+		}
+
+		const control = this.controls.getControl(controlId)
+		if (!control || typeof control.stepMakeCurrent !== 'function') {
+			throw new ApiMessageError('No control at location')
+		}
+
+		if (!control.stepMakeCurrent(step)) throw new ApiMessageError('Step out of range')
+	}
+
+	#locationStyleText = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location style text at ${formatLocation(location)} (${controlId}) `)
+		if (!controlId) {
+			throw new ApiMessageError('No control at location')
+		}
+
+		const control = this.controls.getControl(controlId)
+		if (control && typeof control.styleSetFields === 'function') {
+			const text = match.text || ''
+
+			control.styleSetFields({ text: text })
+		} else {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+
+	#locationStyleColor = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location style color at ${formatLocation(location)} (${controlId}) `)
+		if (!controlId) {
+			throw new ApiMessageError('No control at location')
+		}
+
+		const control = this.controls.getControl(controlId)
+		if (control && typeof control.styleSetFields === 'function') {
+			const color = parseColorToNumber(match.color)
+
+			control.styleSetFields({ color: color })
+		} else {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+
+	#locationStyleBgcolor = (match) => {
+		const { location, controlId } = this.#locationParse(match)
+
+		this.logger.info(`Got location style bgcolor at ${formatLocation(location)} (${controlId}) `)
+		if (!controlId) {
+			throw new ApiMessageError('No control at location')
+		}
+
+		const control = this.controls.getControl(controlId)
+		if (control && typeof control.styleSetFields === 'function') {
+			const color = parseColorToNumber(match.bgcolor)
+
+			control.styleSetFields({ bgcolor: color })
+		} else {
+			throw new ApiMessageError('No control at location')
+		}
+	}
+
+	#setupNewRoutes() {
+		// surface pages
+		this.#router.addPath('surface :surfaceId page-set :page(\\d+)', this.#surfaceSetPage)
+		this.#router.addPath('surface :surfaceId page-up', this.#surfacePageUp)
+		this.#router.addPath('surface :surfaceId page-down', this.#surfacePageDown)
+
+		// control by location
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) press', this.#locationPress)
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) down', this.#locationDown)
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) up', this.#locationUp)
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) rotate-left', this.#locationRotateLeft)
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) rotate-right', this.#locationRotateRight)
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) set-step :step(\\d+)', this.#locationSetStep)
+
+		this.#router.addPath('location :page(\\d+)/:row(\\d+)/:column(\\d+) style text{ :text}?', this.#locationStyleText)
+		this.#router.addPath(
+			'location :page(\\d+)/:row(\\d+)/:column(\\d+) style color :color(.+)',
+			this.#locationStyleColor
+		)
+		this.#router.addPath(
+			'location :page(\\d+)/:row(\\d+)/:column(\\d+) style bgcolor :bgcolor(.+)',
+			this.#locationStyleBgcolor
+		)
+
+		// surfaces
+		this.#router.addPath('surfaces rescan', async () => {
+			this.logger.debug('Rescanning USB')
+
+			try {
+				await this.surfaces.triggerRefreshDevices()
+			} catch (e) {
+				throw new ApiMessageError('Scan failed')
 			}
 		})
+
+		// custom variables
+		this.#router.addPath('custom-variable :name set-value :value(.*)', this.#customVariableSetValue)
+	}
+
+	#customVariableSetValue = (match) => {
+		const result = this.instance.variable.custom.setValue(match.name, match.value)
+		if (result) {
+			throw new ApiMessageError(result)
+		}
+	}
+
+	#locationParse = (match) => {
+		const location = {
+			pageNumber: Number(match.page),
+			row: Number(match.row),
+			column: Number(match.column),
+		}
+
+		const controlId = this.registry.page.getControlIdAt(location)
+
+		return {
+			location,
+			controlId,
+		}
 	}
 
 	/**

lib/Service/Udp.js

@@ -44,7 +44,7 @@ class ServiceUdp extends ServiceUdpBase {
 	constructor(registry) {
 		super(registry, 'udp', 'Service/Udp', 'udp_enabled', 'udp_listen_port')
 
-		this.#api = new ServiceTcpUdpApi(registry)
+		this.#api = new ServiceTcpUdpApi(registry, 'udp')
 
 		this.init()
 	}

test/Service/OscApi.test.js

@@ -1,9 +1,6 @@
 import { jest } from '@jest/globals'
 import { mock } from 'jest-mock-extended'
 import { ServiceOscApi } from '../../lib/Service/OscApi'
-import express from 'express'
-import supertest from 'supertest'
-import bodyParser from 'body-parser'
 import { rgb } from '../../lib/Resources/Util'
 
 const mockOptions = {