Merge pull request #15 from VideoBSO/fix-fw261-messaging

Fix variables and breakage with latest pulse fw release `2.6.1`

Author: josephdadams

README.md

@@ -15,4 +15,23 @@ See HELP.md and LICENSE
 * Added presets for new commands
 
 **V1.1.4**
-* Added the ability to block Standby and Eco modes
+* Added the ability to block Standby and Eco modes
+
+**V2.1.0**
+* Add command to set Illumination value and get back the current value as Variable
+
+**V2.2.0**
+* Add Activation of Profiles
+
+**V2.3.0**
+* Added variable `illumination_value` that returns percentage of current laser power
+* Generally fixed following variables:
+  * `identification` for article number
+  * `identifiction_family` for model name
+  * `illumination_state` which returns power state of laser unit
+  * `serial_number`
+  * `firmware_version`
+* Fixed breakage through Pulse Firmware `V2.6.1`:
+  * `power_state`
+  * `illumination_value`
+  * `shutter_postion`

companion/HELP.md

@@ -4,6 +4,7 @@
 
 * **Power state** on/off
 * **Ilumination** on/off
+* **Illumination Values** Integer Percentage (default = 100, min = 15, max = 100)
 * **Input selection** Currently HDMI / Displayport **Not tested**
 * **OSD** on/off
 * **Shutter** open/close/toggle
@@ -17,4 +18,15 @@
 * **Factory Reset** Factory Reset the device
 * **Activate Profile** Run a profile/macro on the device
 
-* **Presets availible for all included commands!**
+* **Presets availible for all included commands!**
+
+## Currently supported variables:
+
+* **Firmware Version** firmware_version 
+* **Identification** identification 
+* **Identification Family** identification_family 
+* **Illumination State** illumination_state 
+* **Illumination Value** illumination_value 
+* **Power State** power_state 
+* **Serial Number** serial_number 
+* **Shutter State** shutter_position 

companion/manifest.json

@@ -3,7 +3,7 @@
 	"name": "barco-pulse",
 	"shortname": "pulse",
 	"description": "Barcos Pulse Platform",
-	"version": "0.0.0",
+	"version": "2.3.0",
 	"license": "MIT",
 	"repository": "git+https://github.com/bitfocus/companion-module-barco-pulse.git",
 	"bugs": "https://github.com/bitfocus/companion-module-barco-pulse/issues",
@@ -28,4 +28,4 @@
 		"Projector",
 		"Protocol"
 	]
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "barco-pulse",
-	"version": "2.2.0",
+	"version": "2.2.1",
 	"main": "./index.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"

src/feedbacks.js

@@ -82,7 +82,7 @@ module.exports = {
 				return false
 			}
 		}
-		
+
 		self.setFeedbackDefinitions(feedbacks);
 	}
 }

src/utils.js

@@ -185,16 +185,39 @@ module.exports = {
 		});
 
 		self.sendCommand("property.get", { "property": "illumination.state" }, function(err, res) {
-			console.log("property.get():",err,"RES",res);
+			self.INFO['illumination_state'] = res;
 			self.checkVariables();
 			self.checkFeedbacks();
 		});
-		
+		self.sendCommand("property.get", { "property": "firmware.firmwareversion" }, function(err, res) {
+			self.INFO['firmware_version'] = res;
+			self.checkVariables();
+			self.checkFeedbacks();
+		});
+
+		self.sendCommand("property.get", { "property": "system.serialnumber" }, function(err, res) {
+			self.INFO['serial_number'] = res;
+			self.checkVariables();
+			self.checkFeedbacks();
+		});
+
+		self.sendCommand("property.get", { "property": "system.modelname" }, function(err, res) {
+			self.INFO['identification_family'] = res;
+			self.checkVariables();
+			self.checkFeedbacks();
+		});
+
+		self.sendCommand("property.get", { "property": "system.articlenumber" }, function(err, res) {
+			self.INFO['identification'] = res;
+			self.checkVariables();
+			self.checkFeedbacks();
+		});
+
 		/* Laser Power */
 		self.sendCommand("property.get", { "property": "illumination.sources.laser.power" }, function(err, res) {
 			self.INFO['illumination_value'] = res;
 			self.checkVariables();
 			self.checkFeedbacks();
 		});
 	}
-}
+}

src/variables.js

@@ -4,7 +4,7 @@ module.exports = {
 		let variables = [];
 
 		variables.push({ variableId: 'power_state', name: 'Power State' });
-		//variables.push({ variableId: 'illumination_state', name: 'Illumination State' });
+		variables.push({ variableId: 'illumination_state', name: 'Illumination State' });
 		variables.push({ variableId: 'illumination_value', name: 'Illumination Value' });
 		variables.push({ variableId: 'shutter_position', name: 'Shutter State' });
 
@@ -31,18 +31,18 @@ module.exports = {
 			}
 
 			if ('illumination_state' in self.INFO) {
-				//variableObj['illumination_state'] = self.INFO['illumination_state'];
-			}
+				variableObj['illumination_state'] = self.INFO['illumination_state'];
+			}	
 
 			if ('shutter_position' in self.INFO) {
 				variableObj['shutter_position'] = self.INFO['shutter_position'];
 			}
 
 			if ('identification' in self.INFO) {
-				variableObj['identification_family'] = self.INFO['identification']['IdentificationFamily'];
-				variableObj['identification'] = self.INFO['identification']['Identification'];
-				variableObj['serial_number'] = self.INFO['identification']['SerialNumber'];
-				variableObj['firmware_version'] = self.INFO['identification']['version'];
+				variableObj['identification_family'] = self.INFO['identification_family'];
+				variableObj['identification'] = self.INFO['identification'];
+				variableObj['serial_number'] = self.INFO['serial_number'];
+				variableObj['firmware_version'] = self.INFO['firmware_version'];
 			}
 
 			self.setVariableValues(variableObj);
@@ -51,4 +51,4 @@ module.exports = {
 			self.log('error', 'Error Processing Variables: ' + String(error));
 		}
 	}
-}
+}