Merge pull request #6 from phillipivan/main

Add action recorder

Author: phillipivan

companion/HELP.md

@@ -43,8 +43,15 @@ They will not have a value assigned until used by an action.
 
 No feedbacks are provided. The native Internal Variable Check Value feedback is suitable for common feedback tasks such as mute tally when provided with a controls value or position variable.
 
+## Action Recorder
+The Action Recorder will translate any recieved numeric valueIs messages into Control Position Set (if RATCv2) or Control Set actions.
+
 ## Version History
 
+### Version 1.1.0
+- Action Recorder
+- Update dependencies
+
 ### Version 1.0.3
 - Minor fixes
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "peavy-ratc",
-	"version": "1.0.3",
+	"version": "1.1.0",
 	"main": "src/main.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
@@ -17,7 +17,7 @@
 		"@companion-module/base": "~1.8.0"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^1.5.0"
+		"@companion-module/tools": "^1.5.1"
 	},
 	"prettier": "@companion-module/tools/.prettierrc.json"
 }

src/main.js

@@ -48,6 +48,11 @@ class PEAVY_RATC extends InstanceBase {
 	initVariables() {
 	}
 
+	// Track whether actions are being recorded
+	handleStartStopRecordActions(isRecording) {
+		this.isRecordingActions = isRecording
+	}
+
 	updateActions() {
 		UpdateActions(this)
 	}

src/processcmd.js

@@ -113,6 +113,29 @@ module.exports = {
 				break
 			case resp.ratcV1.valueIs:
 				this.log('info', `${reply}`)
+				if (this.isRecordingActions) {
+					if (this.config.v2) {
+						if (!isNaN(valPos[1])) {
+							this.recordAction(
+								{
+									actionId: 'controlPositionSet',
+									options: { alias: aliases[1], value: valPos[1] },
+								},
+								`controlPositionSet ${aliases[1]}`
+							)
+						}		
+					} else {
+						if (!isNaN(Number(valPos[0])))
+						this.recordAction(
+							{
+								actionId: 'controlSet',
+								options: { alias: aliases[1], value: valPos[0] },
+							},
+							`controlSet ${aliases[1]}`
+						)
+					}
+					
+				}
 				aliases[1] = aliases[1].replaceAll(/\/| /g,'_')
 				this.log('debug', `control data for alias: ${aliases[1]} value: ${valPos[0]} position: ${valPos[1]}`)
 				aliasValues[`controlAliasValue_${aliases[1]}`] = valPos[0]
@@ -184,6 +207,29 @@ module.exports = {
 				break
 			case resp.ratcV2.valueIs:
 				this.log('debug', `${reply}`)
+				if (this.isRecordingActions) {
+					if (this.config.v2) {
+						if (!isNaN(valPos[1])) {
+							this.recordAction(
+								{
+									actionId: 'controlPositionSet',
+									options: { alias: aliases[1], value: valPos[1] },
+								},
+								`controlPositionSet ${aliases[1]}`
+							)
+						}		
+					} else {
+						if (!isNaN(Number(valPos[0])))
+						this.recordAction(
+							{
+								actionId: 'controlSet',
+								options: { alias: aliases[1], value: valPos[0] },
+							},
+							`controlSet ${aliases[1]}`
+						)
+					}
+					
+				}
 				aliases[1] = aliases[1].replace(' ', '_').replace('/','')
 				this.log('debug', `control data for alias: ${aliases[1]} value: ${valPos[0]} position: ${valPos[1]}`)
 				aliasValues[`controlAliasValue_${aliases[1]}`] = valPos[0]

yarn.lock

@@ -24,10 +24,10 @@
     p-timeout "^4.1.0"
     tslib "^2.6.2"
 
-"@companion-module/tools@^1.5.0":
-  version "1.5.0"
-  resolved "https://registry.yarnpkg.com/@companion-module/tools/-/tools-1.5.0.tgz#ce3cc1fc8aa71ebcbb8fcc65ccaad22099bb3c9e"
-  integrity sha512-J9sY2DE6i7bWYZ1uoPE8Drux53StYVqpVe+xHF0mERvV9QXOvPQ5AqxM12ts/Jd0vzd94jqLEUzm1I/y/KEWtw==
+"@companion-module/tools@^1.5.1":
+  version "1.5.1"
+  resolved "https://registry.yarnpkg.com/@companion-module/tools/-/tools-1.5.1.tgz#5f5d3e65eee22926e704de3084e3f66de9d841d0"
+  integrity sha512-9KJC0mZLpg7dlS3MKCYzbUbOjiDMpjjwHgeAxMzh9AOM1ybgsEkmYLfIyZ/EWWSSJ/1s75IJmOtIUWVkZUuqhQ==
   dependencies:
     "@typescript-eslint/eslint-plugin" "^5.59.9"
     "@typescript-eslint/parser" "^5.59.9"
@@ -38,7 +38,7 @@
     find-up "^7.0.0"
     parse-author "^2.0.0"
     prettier "^2.8.8"
-    tar "^6.2.0"
+    tar "^6.2.1"
     webpack "^5.90.0"
     webpack-cli "^5.1.4"
     zx "^7.2.3"
@@ -1941,7 +1941,7 @@ tapable@^2.1.1, tapable@^2.2.0:
   resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.1.tgz#1967a73ef4060a82f12ab96af86d52fdb76eeca0"
   integrity sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==
 
-tar@^6.2.0:
+tar@^6.2.1:
   version "6.2.1"
   resolved "https://registry.yarnpkg.com/tar/-/tar-6.2.1.tgz#717549c541bc3c2af15751bea94b1dd068d4b03a"
   integrity sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==