Merge pull request #174 from OpenZWave/feature/refactor-polling

Feature/refactor polling

Author: ekarak

README-api.md

@@ -45,19 +45,26 @@ minutes!) to scan the ZWave network and set up its data structures.
 So, be sure to register a "scan complete" callback, and after it gets called,
 you can safely start issuing commands to your ZWave devices.
 
-Modifying device state:
+**Controlling zwave valueIDs** is usually done by passing the ValueID as a
+Javascipt object or as 4 discrete integer arguments:
+- 1: ZWave Node Id,
+- 2: Command Class,
+- 3: Instance and
+- 4: Index
+
+For example if Zwave Node #3 is a binary switch, to turn it on and off, use
+command class 37:
+
 ```js
-/*
- * Set arbitrary values.
- */
-// 1) by means of passing each individual ValueID constituent:
-zwave.setValue(nodeid, commandclass, instance, index, value);
-zwave.setValue(3,      37,           1,        0,     true); // node 3: turn on
-zwave.setValue(3,      37,           1,        0,     false); // node 3: turn off
-// dimmer node 5: set to 50%
-zwave.setValue(5,      38,           1,        0,     50);
-// 2) or by passing the valueID object (emitted by ValueAdded event):
-zwave.setValue({ node_id:5, class_id: 38, instance:1, index:0}, 50);
+zwave.setValue(3, 37,  1,  0,  true);  // node 3: turn on
+zwave.setValue(3, 37,  1,  0,  false); // node 3: turn off
+```
+
+Another example: if Zwave Node #5 is a dimmer, use class 38:
+
+```js
+zwave.setValue(5,  38,  1,  0, 50); // 1) passing each individual ValueID constituent:
+zwave.setValue({ node_id:5, class_id: 38, instance:1, index:0}, 50); // 2) or a valueID object (emitted by ValueAdded event):
 
 /*
  * Turn a binary switch on/off.
@@ -94,13 +101,13 @@ zwave.setNodeName(nodeid, name);            // arbitrary name string
 
 Polling a device for changes (not all devices require this):
 ```js
-zwave.enablePoll(nodeid, commandclass, intensity);
-zwave.disablePoll(nodeid, commandclass);
-zwave.setPollInterval(nodeid, )
-zwave.getPollInterval();
-zwave.isPolled();
-zwave.setPollIntensity();
-zwave.getPollIntensity();
+zwave.enablePoll({valueId}, intensity);
+zwave.disablePoll({valueId});
+zwave.setPollInterval(intervalMillisecs) // set the polling interval in msec
+zwave.getPollInterval();  // return the polling interval
+zwave.setPollIntensity({valueId}, intensity); // Set the frequency of polling (0=none, 1=every time through the list, 2-every other time, etc)
+zwave.getPollIntensity({valueId});
+zwave.isPolled({valueId});
 ```
 
 Association groups management:

README-example.md

@@ -42,10 +42,10 @@ zwave.on('node added', function(nodeid) {
     };
 });
 
-zwave.on('value added', function(nodeid, comclass, value) {
+zwave.on('value added', function(nodeid, comclass, valueId) {
     if (!nodes[nodeid]['classes'][comclass])
         nodes[nodeid]['classes'][comclass] = {};
-    nodes[nodeid]['classes'][comclass][value.index] = value;
+    nodes[nodeid]['classes'][comclass][valueId.index] = value;
 });
 
 zwave.on('value changed', function(nodeid, comclass, value) {
@@ -85,16 +85,17 @@ zwave.on('node ready', function(nodeid, nodeinfo) {
             nodeinfo.type,
             nodeinfo.loc);
     for (comclass in nodes[nodeid]['classes']) {
-        switch (comclass) {
+      console.log('node%d: class %d', nodeid, comclass);
+      switch (comclass) {
         case 0x25: // COMMAND_CLASS_SWITCH_BINARY
         case 0x26: // COMMAND_CLASS_SWITCH_MULTILEVEL
-            zwave.enablePoll(nodeid, comclass);
+          var valueIds = nodes[nodeid]['classes'][comclass];
+          for (valueId in valueIds) {
+            zwave.enablePoll(valueId);
             break;
-        }
-        var values = nodes[nodeid]['classes'][comclass];
-        console.log('node%d: class %d', nodeid, comclass);
-        for (idx in values)
-            console.log('node%d:   %s=%s', nodeid, values[idx]['label'], values[idx]['value']);
+          }
+          console.log('node%d:   %s=%s', nodeid, values[idx]['label'], values[idx]['value']);
+      }
     }
 });
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openzwave-shared",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "Node.JS bindings for OpenZWave including management and security functions",
   "main": "./lib/openzwave-shared.js",
   "dependencies": {
@@ -38,7 +38,10 @@
     "Adam Rensel",
     "David Moxey",
     "Bart Bakker",
-    "vectah0"
+    "vectah0",
+    "yybd",
+    "Rob Huehn",
+    "Michael Franken"
   ],
   "license": {
     "type": "ISC",

src/openzwave-polling.cc

@@ -53,30 +53,20 @@ namespace OZW {
 		OpenZWave::Manager::Get()->SetPollInterval (intervalMillisecs, false);
 	}
 
-
 	/*
-	* Enable/Disable polling on a COMMAND_CLASS basis.
+	* Enable/Disable polling on a ValueID
 	*/
 	// ===================================================================
 	NAN_METHOD(OZW::EnablePoll)
 	// ===================================================================
 	{
 		Nan::HandleScope scope;
-		CheckMinArgs(2, "nodeid, commandclass");
-		uint8 nodeid = info[0]->ToNumber()->Value();
-		uint8 comclass = info[1]->ToNumber()->Value();
-		uint8 intensity = (info.Length() > 2) ? info[2]->ToNumber()->Value() : 1;
-
-		NodeInfo *node;
-		std::list<OpenZWave::ValueID>::iterator vit;
+		CheckMinArgs(2, "valueId_object, intensity");
+		OpenZWave::ValueID* vit = populateValueId(info);
 		bool b = false;
-		if ((node = get_node_info(nodeid))) {
-			for (vit = node->values.begin(); vit != node->values.end(); ++vit) {
-				if ((*vit).GetCommandClassId() == comclass) {
-					b = OpenZWave::Manager::Get()->EnablePoll((*vit), intensity);
-					break;
-				}
-			}
+		if (vit) {
+			uint8 intensity = (info.Length() > 4) ? info[4]->ToNumber()->Value() : 1;
+			b = OpenZWave::Manager::Get()->EnablePoll((*vit), intensity);
 		}
 		info.GetReturnValue().Set(Nan::New<Boolean>(b));
 	}
@@ -86,19 +76,11 @@ namespace OZW {
 	// ===================================================================
 	{
 		Nan::HandleScope scope;
-		CheckMinArgs(2, "nodeid, commandclass");
-		uint8 nodeid = info[0]->ToNumber()->Value();
-		uint8 comclass = info[1]->ToNumber()->Value();
-		NodeInfo *node;
-		std::list<OpenZWave::ValueID>::iterator vit;
+		CheckMinArgs(1, "valueId");
+		OpenZWave::ValueID* vit = populateValueId(info);
 		bool b = false;
-		if ((node = get_node_info(nodeid))) {
-			for (vit = node->values.begin(); vit != node->values.end(); ++vit) {
-				if ((*vit).GetCommandClassId() == comclass) {
-					b = OpenZWave::Manager::Get()->DisablePoll((*vit));
-					break;
-				}
-			}
+		if (vit) {
+			b = OpenZWave::Manager::Get()->DisablePoll((*vit));
 		}
 		info.GetReturnValue().Set(Nan::New<Boolean>(b));
 	}