Convert module to v3 format

.eslintrc

@@ -1,8 +1,6 @@
 {
-	"env": { es6: true, browser: true },
-	"extends": [
-		"eslint:recommended"
-	],
+	"env": { "es6": true, "browser": true },
+	"extends": ["eslint:recommended"],
 	"parserOptions": {
 		"ecmaVersion": 9,
 		"sourceType": "module"

README.md

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

actions.js

@@ -1,52 +1,124 @@
-exports.getActions = function() {
-
-	var actions = {
-		'go': {
-			label: 'GO'
+exports.getActions = function (self) {
+	return {
+		go: {
+			name: 'GO',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'go')
+			},
 		},
-		'stop_all': {
-			label: 'Stop all cue\'s'
+		stop_all: {
+			name: 'Stop all cues',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'stop_all')
+			},
 		},
-		'fade_all': {
-			label: 'Fade all cue\'s'
+		fade_all: {
+			name: 'Fade all cues',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'fade_all')
+			},
 		},
-		'pause_all': {
-			label: 'Pause all cue\'s'
+		pause_all: {
+			name: 'Pause all cues',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'pause_all')
+			},
 		},
-		'resume_all': {
-			label: 'Resume all cue\'s'
+		resume_all: {
+			name: 'Resume all cues',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'resume_all')
+			},
 		},
-		'stopwatch_start': {
-			label: 'Stopwatch start'
+		stopwatch_start: {
+			name: 'Stopwatch start',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'stopwatch_start')
+			},
 		},
-		'stopwatch_stop': {
-			label: 'Stopwatch stop'
+		stopwatch_stop: {
+			name: 'Stopwatch stop',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'stopwatch_stop')
+			},
 		},
-		'stopwatch_reset': {
-			label: 'Stopwatch reset'
+		stopwatch_reset: {
+			name: 'Stopwatch reset',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'stopwatch_reset')
+			},
 		},
-		'advance': {
-			label: 'Advance current GO position'
+		advance: {
+			name: 'Advance current GO position',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'advance')
+			},
 		},
-		'pause': {
-			label: 'Pause cue'
+		pause: {
+			name: 'Pause cue',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'pause')
+			},
 		},
-		'resume': {
-			label: 'Resume cue'
+		resume: {
+			name: 'Resume cue',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'resume')
+			},
 		},
-		'stop': {
-			label: 'Stop cue'
+		stop: {
+			name: 'Stop cue',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'stop')
+			},
 		},
-		'jump': {
-			label: 'Jump to near end of cue'
+		jump: {
+			name: 'Jump to near end of cue',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'jump')
+			},
 		},
-		'next_track': {
-			label: 'Next track in playlist'
+		next_track: {
+			name: 'Next track in playlist',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'next_track')
+			},
 		},
-		'previous_track': {
-			label: 'Previous track in playlist'
-		}
-	};
+		previous_track: {
+			name: 'Previous track in playlist',
+			options: [],
+			callback: async (action) => {
+				await sendCommand(self, 'previous_track')
+			},
+		},
+	}
+}
 
-	return(actions);
+async function sendCommand(self, command) {
+	try {
+		console.log('sending command: ' + command)
+		if (command !== undefined) {
+			if (self.socket !== undefined && self.socket.isConnected) {
+				self.socket.send(command + '\n')
+			} else {
+				console.error('Socket not connected :(')
+			}
+		}
+	} catch (error) {
+		self.log(`error`, `sendCommand Action Callback Error: ${error.message}`)
+	}
 }

companion/HELP.md

@@ -0,0 +1,31 @@
+## Da-Share MultiPlay module
+
+This module connects to the MultiPlay program with a Telnet connection.
+
+> At the moment no data from the player is returned therefor no feedback is provided.
+> Make sure to activate the TCP connection: File > Production Properties > Telnet Patches > Command Listen > Port number & ACTIVE
+
+Go to [da-share MultiPlay](https://www.da-share.com/software/multiplay/) for download.
+
+### Commands supported
+
+| Action          | Description                                                          |
+| --------------- | -------------------------------------------------------------------- |
+| clear           | Clears the Telnet client window                                      |
+| version         | Reports the MultiPlay version                                        |
+| quit            | Terminates the Telnet session                                        |
+| go              | GO at current cue list position                                      |
+| stop all        | Stop all cues                                                        |
+| fade all        | Fade all cues out                                                    |
+| pause all       | Pause all playing cues                                               |
+| resume all      | Resume all paused cues                                               |
+| stopwatch start | Start the stopwatch                                                  |
+| stopwatch stop  | Stop the stopwatch                                                   |
+| stopwatch reset | Reset the stopwatch                                                  |
+| advance         | Advance the current GO position                                      |
+| pause           | Pause the currently selected cue                                     |
+| resume          | Resume the currently selected cue                                    |
+| stop            | Stop the currently selected cue                                      |
+| jump            | Jump the currently selected cue to near the end                      |
+| next track      | Jump to next track on the currently selected cue (playlist only)     |
+| previous track  | Jump to previous track on the currently selected cue (playlist only) |

companion/manifest.json

@@ -0,0 +1,26 @@
+{
+	"id": "dashare-multiplay",
+	"name": "dashare-multiplay",
+	"shortname": "multiplay",
+	"description": "Remote control of MultiPlay via Telnet.",
+	"version": "0.0.0",
+	"license": "MIT",
+	"repository": "git+https://github.com/bitfocus/companion-module-dashare-multiplay.git",
+	"bugs": "https://github.com/bitfocus/companion-module-dashare-multiplay/issues",
+	"maintainers": [
+		{
+			"name": "Jeffrey Davidsz",
+			"email": "jeffrey.davidsz@vicreo.eu"
+		}
+	],
+	"legacyIds": ["da-share-multiplay"],
+	"runtime": {
+		"type": "node18",
+		"api": "nodejs-ipc",
+		"apiVersion": "0.0.0",
+		"entrypoint": "../index.js"
+	},
+	"manufacturer": "da-share",
+	"products": ["MultiPlay"],
+	"keywords": ["Media Server", "Playback", "Software"]
+}