Merge pull request #306 from OpenZWave/feature/294-sendRawData

Feature/294 send raw data

Author: ekarak

README-api.md

@@ -2,14 +2,11 @@
 
 > This library is as similar as possible to the [C++ OpenZwave::Manager API](http://www.openzwave.com/dev/classOpenZWave_1_1Manager.html) for Node.js. Please note that this is not always possible to have the _exact_ same behaviour as in the C++ library.
 
-Start by loading the addon with `require` and then create a new instance of the addon:
+Start by loading the addon with `require` and then create a new instance of the addon. You can also pass in an optional object specifying any desired option overrides:
 ```js
 var OZW = require('openzwave-shared');
 var zwave = new OZW();
-```
-
-You can also pass in an optional object specifying any desired option overrides:
-```js
+// OR pass extra options
 var zwave = new OZW({
     Logging: false,     // disable file logging (OZWLog.txt)
     ConsoleOutput: true // enable console logging
@@ -44,6 +41,7 @@ zwave.disconnect('dev/ttyUSB0');// disconnect from the current connection
 zwave.connect('\\\\.\\COM3');  // connect to a USB ZWave controller on COM3
 zwave.disconnect('\\\\.\\COM3');// disconnect from the current connection on COM3
 ```
+
 **Important notice**: the connect() call is asynchronous following the
 node/v8 javascript paradigm.  This means that connect() will yield
 control to your script *immediately*, but the underlying OpenZWave C++
@@ -60,26 +58,19 @@ Javascipt object or as 4 discrete integer arguments:
 - 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:
+Some examples:
 
 ```js
+// if Zwave Node #3 is a binary switch, to turn it on and off, use command class 37
 zwave.setValue(3, 37,  1,  0,  true);  // node 3: turn on
 zwave.setValue(3, 37,  1,  0,  false); // node 3: turn off
 zwave.setValue({ node_id:3, class_id: 37, instance:1, index:0}, false); // the same turn-off command using an object
-```
-
-Another example: if Zwave Node #5 is a dimmer, use class 38:
-
-```js
+// if Zwave Node #5 is a dimmer, use class 38:
 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):
-```
-
-The 'standard' way to control your devices is by `setValue` which is also the
-_only_ way to control multi-instance devices, such as the Fibaro FGS-221
-(double in-wall 2x1,5kw relay) for example:
-```js
+// The 'standard' way to control your devices is by `setValue` which is also the
+// _only_ way to control multi-instance devices, such as the Fibaro FGS-221
+// (double in-wall 2x1,5kw relay) for example:
 zwave.setValue(8, 37, 1, 0, true); // node 8: turn on 1st relay
 zwave.setValue(8, 37, 1, 0, false);// node 8: turn off 1st relay
 zwave.setValue(8, 37, 2, 0, true); // node 8: turn on 2nd relay
@@ -161,3 +152,5 @@ zwave.requestAllConfigParams(nodeId);
 zwave.requestConfigParam(nodeId, paramId);
 zwave.setConfigParam(nodeId, paramId, paramValue, <sizeof paramValue>);
 ```
+
+You can always refer to [the official OpenZWave::Manager API](http://www.openzwave.com/dev/classOpenZWave_1_1Manager.html) for more details on calling Manager methods. The aim of this wrapper is to provide a 1-to-1 mapping to all available methods, with the only change here being that the first letter of each method is downcased (eg. `RequestNodeInfo` in C++ is named `requestNodeInfo` in Javascript)

README.md

@@ -3,6 +3,7 @@ node-openzwave-shared
 [Linux![Linux Build Status](https://travis-ci.org/OpenZWave/node-openzwave-shared.svg?branch=master)](https://travis-ci.org/OpenZWave/node-openzwave-shared)
 [Windows![Windows Build status](https://ci.appveyor.com/api/projects/status/txg360huomtpgc8o?svg=true)](https://ci.appveyor.com/project/ekarak/node-openzwave-shared)
 [![Join the chat at https://gitter.im/OpenZWave/node-openzwave-shared](https://badges.gitter.im/OpenZWave/node-openzwave-shared.svg)](https://gitter.im/OpenZWave/node-openzwave-shared?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Google group](http://www.google.com/images/icons/product/groups-32.png)](https://groups.google.com/d/forum/node-openzwave-shared)
 
 This is the homepage for *node-openzwave-shared*, the official binary add-on for
 Node.js, which wraps [Open ZWave](http://openzwave.com/), a high quality C++
@@ -147,7 +148,8 @@ download the
 - [Management of nodes](../master/README-mgmt.md)
 - [Security API](../master/README-security.md)
 - [Usage example](../master/README-example.md)
-
+- [Deprecated API calls in OpenZWave 1.6](../master/README-deprecated-16.md)
+  
 ## Environment-specific documentation
 - [Installing on Rapsbian](../master/README-raspbian.md)
 - [Installing on Ubuntu 15.04](../master/README-ubuntu.md)

src/openzwave-driver.cc

@@ -46,8 +46,8 @@ namespace OZW {
 		version = OpenZWave::Manager::getVersionAsString();
 #if OPENZWAVE_EXCEPTIONS
 	} catch ( OpenZWave::OZWException& e ) {
-		char buffer [100];
-		sprintf(buffer, "Exception connecting in %s(%d): %s",
+		char buffer [200];
+		snprintf(buffer, 200, "Exception connecting in %s(%d): %s",
 			e.GetFile().c_str(), e.GetLine(), e.GetMsg().c_str());
 		Nan::ThrowError( buffer );
 	}
@@ -122,8 +122,8 @@ namespace OZW {
 		OpenZWave::Options::Destroy();
 #if OPENZWAVE_EXCEPTIONS
 	} catch ( OpenZWave::OZWException& e ) {
-		char buffer [100];
-		sprintf(buffer, "Exception disconnecting in %s(%d): %s",
+		char buffer [200];
+		snprintf(buffer, 200, "Exception disconnecting in %s(%d): %s",
 			 e.GetFile().c_str(), e.GetLine(), e.GetMsg().c_str());
 		Nan::ThrowError( buffer );
 	}

src/openzwave-nodes.cc

@@ -93,7 +93,30 @@ namespace OZW {
 		OZWManager( SwitchAllOff, homeid);
 	}
 #endif
-
+#ifdef OPENZWAVE_16
+	// ===================================================================
+	NAN_METHOD(OZW::SendRawData)
+	// ===================================================================
+	{
+		Nan::HandleScope scope;
+		CheckMinArgs(5, "nodeid, logText<str>, msgType<uint8>, sendSecure<bool>, content<Buffer> (,length)");
+		uint8 nodeid     = Nan::To<Number>(info[0]).ToLocalChecked()->Value();
+		::std::string logText(*Nan::Utf8String( info[1] ));
+		uint8 msgType    = Nan::To<Number>(info[2]).ToLocalChecked()->Value();
+		bool sendSecure  = Nan::To<Boolean>(info[3]).ToLocalChecked()->Value();
+		checkType(Buffer::HasInstance(info[4]));
+		uint8 *content   = (uint8*)Buffer::Data(info[4]);
+		double buflength =  Buffer::Length(info[4]);
+		uint8 length    = 0;
+		// can either deduce length from JS buffer, or use the length provided
+		if (info.Length() > 5) {
+			length = ::std::min<double>( Nan::To<Number>(info[5]).ToLocalChecked()->Value(), buflength );
+		} else {
+			length = buflength;
+		}
+		OZWManager( SendRawData, homeid, nodeid, logText, msgType, sendSecure, content, length );
+	}
+#endif
 	// ===================================================================
 	NAN_METHOD(OZW::PressButton)
 	// ===================================================================

src/openzwave.cc

@@ -120,6 +120,9 @@ namespace OZW {
 		Nan::SetPrototypeMethod(t, "setNodeLevel", OZW::SetNodeLevel);
 		Nan::SetPrototypeMethod(t, "switchAllOn", OZW::SwitchAllOn);
 		Nan::SetPrototypeMethod(t, "switchAllOff", OZW::SwitchAllOff);
+#endif
+#ifdef OPENZWAVE_16
+		Nan::SetPrototypeMethod(t, "sendRawData", OZW::SendRawData);
 #endif
 		Nan::SetPrototypeMethod(t, "pressButton", OZW::PressButton);
 		Nan::SetPrototypeMethod(t, "releaseButton", OZW::ReleaseButton);

src/openzwave.hpp

@@ -18,6 +18,7 @@
 #ifndef __NODE_OPENZWAVE_HPP_INCLUDED__
 #define __NODE_OPENZWAVE_HPP_INCLUDED__
 
+#include <algorithm>
 #include <iostream>
 #include <sstream>
 #include <list>
@@ -114,6 +115,9 @@ namespace OZW {
 		static NAN_METHOD(SetNodeLevel);
 		static NAN_METHOD(SwitchAllOn);
 		static NAN_METHOD(SwitchAllOff);
+#endif
+#ifdef OPENZWAVE_16
+		static NAN_METHOD(SendRawData);
 #endif
 		static NAN_METHOD(PressButton);
 		static NAN_METHOD(ReleaseButton);

src/utils.cc

@@ -69,12 +69,12 @@ namespace OZW {
 
 	::std::string getValueIdDescriptor(OpenZWave::ValueID value) {
 		char buffer[32];
-		sprintf(buffer, "%d-%d-%d-%d", value.GetNodeId(), value.GetCommandClassId(), value.GetInstance(), value.GetIndex());
+		snprintf(buffer, 32, "%d-%d-%d-%d", value.GetNodeId(), value.GetCommandClassId(), value.GetInstance(), value.GetIndex());
 		return ::std::string(buffer);
 	}
-	::std::string getValueIdDescriptor(uint8 node_id, uint8 class_id, uint8 instance, uint8 index) {
+	::std::string getValueIdDescriptor(uint8 node_id, uint8 class_id, OZWValueIdIndex instance, uint8 index) {
 		char buffer[32];
-		sprintf(buffer, "%d-%d-%d-%d", node_id, class_id, instance, index);
+		snprintf(buffer, 32, "%d-%d-%d-%d", node_id, class_id, instance, index);
 		return ::std::string(buffer);
 	}
 

src/utils.hpp

@@ -80,8 +80,8 @@ OZWValueIdIndex;
 
 #define CheckMinArgs(NUM, DESC) \
 	if(info.Length() < NUM) { \
-		char buffer [100]; \
-		sprintf(buffer, "This OpenZwave method requires at least %d argument(s): %s", NUM, DESC); \
+		char buffer [200]; \
+		snprintf(buffer, 200, "This OpenZwave method requires at least %d argument(s): %s", NUM, DESC); \
 		Nan::ThrowError( buffer ); \
 	}