Merge pull request #22 from phillipivan/main

Update for V3

.gitignore

@@ -1,4 +1,10 @@
+.vscode/
 node_modules/
 package-lock.json
+/pkg
+/pkg.tgz
+*.zip
+*.log
 .nova/
-temp.js
+temp.js
+DEBUG-*

README.md

@@ -1,2 +1,2 @@
 # companion-module-generic-swp08
-See [HELP.md](./HELP.md) and [LICENSE](./LICENSE)
+See [HELP.md](./companion/HELP.md) and [LICENSE](./LICENSE)

HELP.md → companion/HELP.md

@@ -27,12 +27,14 @@ There are multiple ways of making crosspoint buttons to cater for different appl
 - **Route Source to selected Levels and Destination** and **Route Source name to selected Levels and Destination** Use the preset levels and destination with the source from this action and make the route
 - **Take** Make the crosspoint from preset levels, source and destination
 - **Clear** Forget any preset levels, destination or source. Optionally re-enable all levels.
-- **Set Crosspoint** Specify levels, source and destination in the action and make the route
+- **Set Crosspoint** and **Set Crosspoint by name** specify levels, source and destination in the action and make the route
 - **Refresh Source and Destination names** Ask the router for the current set of names and update
 
 ## Feedbacks
 Button background colours can be changed to show current selection status.
 
+- **Crosspoint Connected**
+- **Crosspoint Connected By Name**
 - **Selected Levels**
 - **Selected Levels and Destination**
 - **Selected Destination**
@@ -50,10 +52,16 @@ Some dynamic information is stored in variables which you can access through the
 - **Source_?** The name of each source as defined in the the router
 - **Destination_?** The name of each destination as defined in the router
 
-## Version 1.0.0
+
+## Action Recorder
+Tally and connected messages recieved from the router will create new set crosspoint actions, allowing for easy creation of salvos.
+
+## Version History
+
+### Version 1.0.0
 - First Release
 
-## Version 1.0.1
+### Version 1.0.1
 - Reworked levels to be more flexible
 - Added route source by name action
 - Added toggle level action
@@ -62,22 +70,32 @@ Some dynamic information is stored in variables which you can access through the
 - Added feedback for selected level and destination
 - Fixed packaging of bytes sent to router
 
-## Version 1.0.2
+### Version 1.0.2
 - Reworked incoming data processing
 - Reworked name decoding to support larger routers
 - Added module config option for name length
 - Added module config option to request names on connection
 - Added variables for selected destination source
 
-## Version 1.0.3
+### Version 1.0.3
 - Added module config option to disable the supported commands check
 
-## Version 1.0.4
+### Version 1.0.4
 - Added support for more than 16 levels
 - Added support for more then 1024 sources/destinations
 - Tidy up config page layout
 - Add more supported device types to the module properties
 
-## Version 1.0.5
+### Version 1.0.5
 - Added presets for some actions
-- Added feedback Source routed to selected Destination
+- Added feedback Source routed to selected Destination
+
+### Version 2.0.0
+- Update for Companion Version 3
+- Add connection keep alive
+- Accept variables for Select Source Name, Select Destination Name, Set Crosspoint by Name
+- Add Crosspoint Connected, Crosspoint Connected By Name feedback
+- Action Recorder support
+- Select Source and Destination Presets now generated according to router size (up to 256)
+- Select Source and Destination Presets now with names
+- Select Source presets have 2nd Source Routed to Destination feedback

companion/manifest.json

@@ -0,0 +1,41 @@
+{
+	"id": "generic-swp08",
+	"name": "generic-swp08",
+	"shortname": "SW-P-08",
+	"description": "General Remote Control Protocol (SW-P-08)",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/bitfocus/companion-module-generic-swp08.git",
+	"bugs": "https://github.com/bitfocus/companion-module-generic-swp08/issues",
+	"maintainers": [
+		{
+			"name": "Peter Daniel"
+		},
+		{
+			"name": "Phillip Ivan Pietruschka",
+			"email": "ivanpietruschka@gmail.com"
+		}
+	],
+	"runtime": {
+		"type": "node18",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../src/main.js"
+	},
+	"legacyIds": [],
+	"manufacturer": "Generic",
+    "products": [
+		"SW-P-08",
+		"SW-P-08 Ross Router",
+		"SW-P-08 Snell ProBel Router",
+		"SW-P-08 Grass Valley Router",
+		"SW-P-08 Lawo VSM",
+		"SW-P-08 Calrec Router",
+		"SW-P-08 NVision Router",
+		"SW-P-08 Sony Broadcast Router",
+		"SW-P-08 BNCS",
+		"SW-P-08 DirectOut M.1k2"
+	],
+	"keywords": ["Router", "Matrix", "Broadcast", "Production"]
+
+}