Make emitted null payload behavior opt-in

codetheweb · codetheweb · commit 6958baee8ffd · 2020-10-01T12:58:20.000-04:00
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset='utf-8'>
-  <title>tuyapi 5.3.0 | Documentation</title>
+  <title>tuyapi 5.3.2 | Documentation</title>
   <meta name='description' content='An easy-to-use API for devices that use Tuya&#39;s cloud services'>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet'>
@@ -15,7 +15,7 @@
       <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
         <div class='py1 px2'>
           <h3 class='mb0 no-anchor'>tuyapi</h3>
-          <div class='mb1'><code>5.3.0</code></div>
+          <div class='mb1'><code>5.3.2</code></div>
           <input
             placeholder='Filter'
             id='filter-input'
@@ -405,6 +405,18 @@ <h3 class='fl m0' id='tuyadevice'>
 
 
               
+                <tr>
+  <td class='break-word'><span class='code bold'>options.nullPayloadOnJSONError</span> <code class='quiet'><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">Boolean</a></code>
+  
+    (default <code>false</code>)
+  </td>
+  <td class='break-word'><span>if true, emits a data event
+containing a payload of null values for on-device JSON parsing errors
+</span></td>
+</tr>
+
+
+              
             </tbody>
           </table>
           
diff --git a/index.js b/index.js
@@ -27,16 +27,29 @@ const {UDP_KEY} = require('./lib/config');
  * @param {String} options.key encryption key of device (also called `localKey`)
  * @param {String} [options.productKey] product key of device (currently unused)
  * @param {Number} [options.version=3.1] protocol version
+ * @param {Boolean} [options.nullPayloadOnJSONError=false] if true, emits a data event
+ * containing a payload of null values for on-device JSON parsing errors
  * @example
  * const tuya = new TuyaDevice({id: 'xxxxxxxxxxxxxxxxxxxx',
  *                              key: 'xxxxxxxxxxxxxxxx'})
  */
 class TuyaDevice extends EventEmitter {
-  constructor({ip, port = 6668, id, gwID = id, key, productKey, version = 3.1} = {}) {
+  constructor({
+    ip,
+    port = 6668,
+    id,
+    gwID = id,
+    key,
+    productKey,
+    version = 3.1,
+    nullPayloadOnJSONError = false
+  } = {}) {
     super();
     // Set device to user-passed options
     this.device = {ip, port, id, gwID, key, productKey, version};
 
+    this.nullPayloadOnJSONError = nullPayloadOnJSONError;
+
     // Check arguments
     if (!(isValidString(id) ||
           isValidString(ip))) {
@@ -314,20 +327,22 @@ class TuyaDevice extends EventEmitter {
           try {
             packets = this.device.parser.parse(data);
 
-            for (const packet of packets) {
-              if (packet.payload && packet.payload === 'json obj data unvalid') {
-                this.emit('error', packet.payload);
-
-                packet.payload = {
-                  dps: {
-                    1: null,
-                    2: null,
-                    3: null,
-                    101: null,
-                    102: null,
-                    103: null
-                  }
-                };
+            if (this.this.nullPayloadOnJSONError) {
+              for (const packet of packets) {
+                if (packet.payload && packet.payload === 'json obj data unvalid') {
+                  this.emit('error', packet.payload);
+
+                  packet.payload = {
+                    dps: {
+                      1: null,
+                      2: null,
+                      3: null,
+                      101: null,
+                      102: null,
+                      103: null
+                    }
+                  };
+                }
               }
             }
           } catch (error) {
