Merge pull request #6 from phillipivan/master

Update Help, add subscription callbacks, update companion-module-base

companion/HELP.md

@@ -10,42 +10,141 @@ Enter the IP address, port of the media player. If a password is required, enter
 
 ## Actions
 - **Stop** 
-- **Play** 
-- **Record** 
-- **Pause** 
-- **Jog** 
-- **Shuttle** 
-- **Flash Load** 
-- **Eject** 
+
+
+ STOP puts the controlled device into the stop state and also takes the controlled device out of input monitor mode.
+- **Play**
+
+
+ Play puts the controlled device into playback mode and also brings the controlled device from record ready mode to recording mode.
+- **Record**
+
+
+ RECORD puts the controlled device into record ready mode. It also numbers tracks during recording and puts the controlled device into input monitoring mode when no media is in the controlled device.
+- **Pause**
+
+
+ READY puts the controlled device into playback standby mode or record ready mode.
+- **Jog**
+
+
+ Enables JOG playback of the controlled device.
+- **Shuttle**
+
+
+ SHUTTLE puts the controlled device into the shuttle mode. The controlled device remains in the shuttle mode until it receives a command such as STOP, PLAY, or PAUSE.
+- **Flash Load**
+
+
+ FLASH LOAD puts the controlled device into Flash Load mode.
+- **Eject**
+
+
+ EJECT ejects a CD Media from the controlled device. (If the controlled device is SS-R250N, it returns ILLEGAL [F2].) If the device selected on the controlled device is not CD, this command is ignored.
 - **Skip**
 
+
+ SKIP allows the controlled device to skip a track.
 - **Call**
+
+
+ CALL locates the controlled device to a call point and puts the controlled device into the ready state.
 - **Auto Cue Select**
+
+
+ AUTO CUE SELECT turns the Auto-cue mode of the controlled device on or off.
 - **Auto Cue Level Preset**
+
+
+ AUTO CUE LEVEL PRESET sets the auto cue level of the controlled device.
 - **Direct Track Search Preset**
+
+
+ DIRECT TRACK SEARCH PRESET performs a search for a track on the controlled device by specifying the track number.
 - **Auto Track Select**
+
+
+ AUTO TRACK SELECT turns the Auto-cue mode of the controlled device on or off.
 - **Auto Track Level Preset**
+
+
+ AUTO TRACK LEVEL PRESET sets the auto track level of the controlled device.
 - **Sync Rec Level Preset**
 
+ SYNC REC LEVEL PRESET sets the level of the sync recording of the controlled device.
 - **Pitch Control Select**
+
+
+ PITCH CONTROL SELECT turns the pitch control mode of the controlled device on or off.
 - **Auto Ready Select**
+
+
+ AUTO READY SELECT turns the auto ready mode of the controlled device on or off.
 - **Repeat Mode**
+
+
+ REPEAT SELECT turns the repeat mode of the controlled device on or off.
 - **Sync Rec Select**
+
+
+ SYNC REC SELECT turns the sync rec mode of the controlled device on or off.
 - **Incremental Playback Select**
+
+
+ INCR PLAY SELECT turns the incremental playback mode of the controlled device on or off.
 - **Key Control Select**
+
+
+ KEY CONTROL SELECT turns the key control mode of the controlled device on or off.
 - **Remote/Local Select**
+
+
+ REMOTE/LOCAL SELECT enables or disables key operation on the controlled device.
 - **Play Mode Select**
+
+
+ PLAY MODE SELECT sets the playback mode of the controlled device.
 - **Specified Device Status Sense**
+
+
+ SPECIFIED DEVICE STATUS SENSE requests to return the status of the specified device of the controlled device.
 - **Current Track Time Sense**
+
+
+ CURRENT TRACK TIME SENSE requests the controlled device to return the selected time information about the current track or the whole media, when in a playback or a ready state.
 - **Power Control**
+
+
+ POWER CONTROL turns ON / OFF (standby) the power of the controlled device.
 - **Device Select**
+
+
+ DEVICE SELECT changes the device to be used on the controlled device.
 - **Divide**
+
+
+ The File currently in playback standby mode on the controlled device is divided into two files at that point.
 - **Delete**
+
+
+ The file(s) for the current track on the controlled device are deleted.
 - **Play Area Select**
+
+
+ PLAY AREA SELECT sets the playback area of the controlled device.
 - **File Name Select**
+
+
+ Set the format of the recording file name of the controlled device.
 - **Media Format**
+
+
+ Formats the selected media in the controlled device.
 - **Input Select**
 
+
+ INPUT SELECT sets the input source select of the controlled device.
+
 ## Variables
 - **Track Number** 
 - **Track Time**
@@ -67,5 +166,10 @@ Enter the IP address, port of the media player. If a password is required, enter
 
 ## Version History
 
+### Version 2.0.1
+- Add action & feedback subscription callbacks
+- Update package.josn
+- Update companion-module-base to 1.7.0
+
 ### Version 2.0.0
 - Brand new module vs 1.0.0

companion/manifest.json

@@ -3,7 +3,7 @@
 	"name": "tascam-cd",
 	"shortname": "SS-CDR250N / SS-R250N",
 	"description": "Bitfocus Companion module for the Tascam SS-CDR250N and SS-R250N",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"license": "MIT",
 	"repository": "git+https://github.com/bitfocus/companion-module-tascam-cd.git",
 	"bugs": "https://github.com/bitfocus/companion-module-tascam-cd/issues",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tascam-cd",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"main": "src/main.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
@@ -11,10 +11,10 @@
 	"license": "MIT",
 	"repository": {
 		"type": "git",
-		"url": "git+"
+		"url": "git+https://github.com/bitfocus/companion-module-tascam-cd.git"
 	},
 	"dependencies": {
-		"@companion-module/base": "~1.6.0"
+		"@companion-module/base": "~1.7.0"
 	},
 	"devDependencies": {
 		"@companion-module/tools": "^1.4.2"

src/actions.js

@@ -137,7 +137,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoCueLevelPreset + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoCueLevelPreset + 'FF')
+			},
 		},
 		autoTrackLevelPreset: {
 			name: 'Auto Track Level Preset',
@@ -155,7 +157,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoTrackLevelPreset + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoTrackLevelPreset + 'FF')
+			},
 		},
 		directTrackSearchPreset: {
 			name: 'Direct Track Search Preset',
@@ -196,7 +200,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoTrackLevelPreset + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoTrackLevelPreset + 'FF')
+			},
 		},
 		autoCueSelect: {
 			name: 'Auto Cue Select',
@@ -214,7 +220,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoCueSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoCueSelect + 'FF')
+			},
 		},
 		autoTrackSelect: {
 			name: 'Auto Track Select',
@@ -232,7 +240,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoTrackSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoTrackSelect + 'FF')
+			},
 		},
 		pitchControlSelect: {
 			name: 'Pitch Control Select',
@@ -250,7 +260,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.pitchControlSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.pitchControlSelect + 'FF')
+			},
 		},
 		autoReadySelect: {
 			name: 'Auto Ready Select',
@@ -268,7 +280,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.autoReadySelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.autoReadySelect + 'FF')
+			},
 		},
 		repeatMode: {
 			name: 'Repeat Mode',
@@ -286,7 +300,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.repeatModeSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.repeatModeSelect + 'FF')
+			},
 		},
 		syncRecSelect: {
 			name: 'Sync Rec Select',
@@ -304,7 +320,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.syncRecSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.syncRecSelect + 'FF')
+			},
 		},
 		incrPlaySelect: {
 			name: 'Incremental Playback Select',
@@ -322,7 +340,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.incrPlaySelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.incrPlaySelect + 'FF')
+			},
 		},
 		keyControlSelect: {
 			name: 'Key Control Select',
@@ -340,7 +360,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.keyControlSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.keyControlSelect + 'FF')
+			},
 		},
 		remoteLocalMode: {
 			name: 'Remote/Local Select',
@@ -358,7 +380,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.remoteLocalModeSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.remoteLocalModeSelect + 'FF')
+			},
 		},
 		playMode: {
 			name: 'Play Mode Select',
@@ -451,7 +475,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.deviceSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.deviceSelect + 'FF')
+			},
 		},
 		divide: {
 			name: 'Divide',
@@ -486,7 +512,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.playAreaSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.playAreaSelect + 'FF')
+			},
 		},
 		fileNameSelect: {
 			name: 'File Name Select',
@@ -504,7 +532,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.fileNameSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.fileNameSelect + 'FF')
+			},
 		},
 		mediaFormat: {
 			name: 'Media Format',
@@ -540,7 +570,9 @@ module.exports = function (self) {
 				self.addCmdtoQueue(SOM + cmd.inputSelect + options.mode)
 			},
 			//learn: async () => {},
-			//subscribe: async () => {},
+			subscribe: async () => {
+				self.addCmdtoQueue(SOM + cmd.inputSelect + 'FF')
+			},
 		},
 	})
 }

src/config.js

@@ -36,6 +36,7 @@ module.exports = {
 				width: 6,
 				default: 'SS-CDR250N',
 				regex: '/^.{0,10}/g',
+				tooltip: 'Defaults to model name: SS-CDR250N / SS-R250N',
 			},
 		]
 	},