smart-bus 0.6.0 → 0.8.0

package/.travis.yml

@@ -1,9 +1,7 @@
 language: node_js
-script: 
+script:
   - npm run lint
   - npm run coverage
 node_js:
   - "stable"
-  - "4.1"
-  - "4.0"
-  - "0.12"
+  - "6"

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.8.0
+
+  * Update for Node.js v22 compatibility
+  * Replace deprecated `new Buffer()` constructors with modern APIs
+  * Update minimum Node.js version from >=0.12 to >=12.0.0
+  * Update development dependencies (mocha, eslint, should, simple-mock)
+  * Replace istanbul with nyc for test coverage
+
+**BREAKING:**
+
+  - Node.js version requirement increased from >=0.12 to >=12.0.0
+
+## 0.7.0
+
+  * Add Read Dry Contact Status commaands (`0x15CE`, `0x15CF`)
+
 ## 0.6.0
 
   * Allow to reuse same UDP address

package/README.md

@@ -242,7 +242,7 @@ bus.send({
   target: dimmer,
 
   command: 0x0031,
-  payload: new Buffer('04640190', 'hex')
+  payload: Buffer.from('04640190', 'hex')
 }, function(err) { /* ... */ });
 ```
 

package/lib/bus.js

@@ -9,16 +9,16 @@ var EventEmitter = require('events');
 
 module.exports = Bus;
 
-var Constants = new Buffer(12);
+var Constants = Buffer.allocUnsafe(12);
 
-Constants.write('HDLMIRACLE');
+Constants.write('HDLMIRACLE', 0, 'ascii');
 Constants.writeUInt16BE(0xAAAA, 10);
 
 function Bus(resource) {
   var config = parse(resource);
   var port = config.port;
 
-  this.address = new Buffer([0, 0, 0, 0]);
+  this.address = Buffer.from([0, 0, 0, 0]);
 
   this.port = port ? parseInt(port) : 6000;
   this.gateway = config.gateway;
@@ -113,7 +113,7 @@ Bus.prototype.send = function(options, callback) {
     return callback(err);
   }
 
-  var checksum = new Buffer(2);
+  var checksum = Buffer.allocUnsafe(2);
 
   checksum.writeUInt16BE(crc(content), 0);
 
@@ -227,7 +227,7 @@ function createSocket(bus) {
   socket.on('listening', function() {
     var address = socket.address();
 
-    bus.address = new Buffer(address.address.split('.'));
+    bus.address = Buffer.from(address.address.split('.'));
 
     debug('UDP Server is listening on ' + address.address + ':' + address.port);
 

package/lib/command.js

@@ -99,7 +99,7 @@ function encode() {
   var length = 11;
   var sender = this.sender;
   var target = this.target;
-  var header = new Buffer(9);
+  var header = Buffer.allocUnsafe(9);
   var payload = this.payload;
 
   if (payload) length += payload.length;

package/lib/commands.js

@@ -89,7 +89,7 @@ var AC = {
   },
 
   encode: function(data) {
-    var buffer = new Buffer(13);
+    var buffer = Buffer.allocUnsafe(13);
 
     var temperature = data.temperature || {};
     var current = data.current || {};
@@ -144,7 +144,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.scene]);
+      return Buffer.from([data.area, data.scene]);
     },
 
     response: 0x0003
@@ -180,7 +180,7 @@ module.exports = {
       var channels = data.channels || [];
       var length = channels.length;
       var bytes = Math.ceil(length / 8);
-      var buffer = new Buffer(3 + bytes);
+      var buffer = Buffer.allocUnsafe(3 + bytes);
 
       buffer.writeUInt8(data.area, 0);
       buffer.writeUInt8(data.scene, 1);
@@ -210,7 +210,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area]);
+      return Buffer.from([data.area]);
     },
 
     response: 0x000D
@@ -226,7 +226,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.scene]);
+      return Buffer.from([data.area, data.scene]);
     }
   },
 
@@ -266,7 +266,7 @@ module.exports = {
       var channels = data.channels || [];
       var length = channels.length;
       var bytes = Math.ceil(length / 8);
-      var buffer = new Buffer(2 + areas.length + bytes);
+      var buffer = Buffer.allocUnsafe(2 + areas.length + bytes);
 
       buffer.writeUInt8(areas.length, 0);
 
@@ -329,7 +329,7 @@ module.exports = {
       var device = data.device;
       var channels = data.channels;
       var length = channels.length;
-      var buffer = new Buffer(5 + length);
+      var buffer = Buffer.allocUnsafe(5 + length);
 
       word.encode(buffer, device.type, 0);
       buffer.writeUInt8(device.subnet, 2);
@@ -360,7 +360,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.scene]);
+      return Buffer.from([data.area, data.scene]);
     },
 
     response: 0x0001
@@ -391,7 +391,7 @@ module.exports = {
     encode: function(data) {
       var channels = data.channels || [];
       var length = channels.length;
-      var buffer = new Buffer(4 + length);
+      var buffer = Buffer.allocUnsafe(4 + length);
 
       buffer.writeUInt8(data.area, 0);
       buffer.writeUInt8(data.scene, 1);
@@ -420,7 +420,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(1);
+      var buffer = Buffer.allocUnsafe(1);
 
       status.encode(buffer, data.success, 0);
 
@@ -440,7 +440,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.sequence]);
+      return Buffer.from([data.area, data.sequence]);
     },
 
     response: 0x001B
@@ -456,7 +456,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.sequence]);
+      return Buffer.from([data.area, data.sequence]);
     }
   },
 
@@ -467,7 +467,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area]);
+      return Buffer.from([data.area]);
     },
 
     response: 0xE015
@@ -483,7 +483,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.area, data.sequence]);
+      return Buffer.from([data.area, data.sequence]);
     }
   },
 
@@ -502,7 +502,7 @@ module.exports = {
     encode: function(data) {
       var areas = data.areas || [];
       var length = areas.length;
-      var buffer = new Buffer(length);
+      var buffer = Buffer.allocUnsafe(length);
 
       for (var i = 0; i < length; i++)
         buffer.writeUInt8(areas[i].sequence, i);
@@ -524,7 +524,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(4);
+      var buffer = Buffer.allocUnsafe(4);
 
       buffer.writeUInt8(data.channel, 0);
       buffer.writeUInt8(data.level, 1);
@@ -546,7 +546,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(3);
+      var buffer = Buffer.allocUnsafe(3);
 
       buffer.writeUInt8(data.channel, 0);
       status.encode(buffer, data.success, 1);
@@ -576,7 +576,7 @@ module.exports = {
     encode: function(data) {
       var channels = data.channels || [];
       var length = channels.length;
-      var buffer = new Buffer(length + 1);
+      var buffer = Buffer.allocUnsafe(length + 1);
 
       buffer.writeUInt8(length, 0);
 
@@ -608,7 +608,7 @@ module.exports = {
     encode: function(data) {
       var channels = data.channels || [];
       var length = channels.length;
-      var buffer = new Buffer(length + 1);
+      var buffer = Buffer.allocUnsafe(length + 1);
 
       buffer.writeUInt8(length, 0);
 
@@ -631,7 +631,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.block, data.status ? 1 : 0]);
+      return Buffer.from([data.block, data.status ? 1 : 0]);
     }
   },
 
@@ -646,7 +646,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.block, data.status ? 1 : 0]);
+      return Buffer.from([data.block, data.status ? 1 : 0]);
     }
   },
 
@@ -657,7 +657,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.block]);
+      return Buffer.from([data.block]);
     }
   },
 
@@ -673,7 +673,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.block, data.status ? 1 : 0]);
+      return Buffer.from([data.block, data.status ? 1 : 0]);
     }
   },
 
@@ -688,7 +688,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.block, data.status ? 1 : 0]);
+      return Buffer.from([data.block, data.status ? 1 : 0]);
     }
   },
 
@@ -707,7 +707,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(8);
+      var buffer = Buffer.allocUnsafe(8);
 
       status.encode(buffer, data.success, 0);
       date.encode(buffer, data.date, 1);
@@ -727,7 +727,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(7);
+      var buffer = Buffer.allocUnsafe(7);
 
       date.encode(buffer, data.date, 0);
 
@@ -744,7 +744,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(1);
+      var buffer = Buffer.allocUnsafe(1);
 
       status.encode(buffer, data.success, 0);
 
@@ -759,7 +759,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(6);
+      var buffer = Buffer.allocUnsafe(6);
 
       date.encode(buffer, data.date, 0);
 
@@ -779,7 +779,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(2);
+      var buffer = Buffer.allocUnsafe(2);
 
       buffer.writeUInt8(data.switch, 0);
       buffer.writeUInt8(data.status ? 255 : 0, 1);
@@ -800,7 +800,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(2);
+      var buffer = Buffer.allocUnsafe(2);
 
       buffer.writeUInt8(data.switch, 0);
       buffer.writeUInt8(data.status ? 1 : 0, 1);
@@ -816,7 +816,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.switch]);
+      return Buffer.from([data.switch]);
     },
 
     response: 0xE019
@@ -833,7 +833,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(2);
+      var buffer = Buffer.allocUnsafe(2);
 
       buffer.writeUInt8(data.switch, 0);
       buffer.writeUInt8(data.status ? 1 : 0, 1);
@@ -860,7 +860,7 @@ module.exports = {
     encode: function(data) {
       var switches = data.switches || [];
       var length = switches.length;
-      var buffer = new Buffer(length + 1);
+      var buffer = Buffer.allocUnsafe(length + 1);
 
       buffer.writeUInt8(length, 0);
 
@@ -883,7 +883,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.curtain, data.status]);
+      return Buffer.from([data.curtain, data.status]);
     },
 
     response: 0xE3E1
@@ -900,7 +900,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.curtain, data.status]);
+      return Buffer.from([data.curtain, data.status]);
     }
   },
 
@@ -911,7 +911,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.curtain]);
+      return Buffer.from([data.curtain]);
     },
 
     response: 0xE3E3
@@ -928,7 +928,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.curtain, data.status]);
+      return Buffer.from([data.curtain, data.status]);
     }
   },
 
@@ -953,7 +953,7 @@ module.exports = {
     encode: function(data) {
       var curtains = data.curtains || [];
       var length = curtains.length;
-      var buffer = new Buffer(length * 2);
+      var buffer = Buffer.allocUnsafe(length * 2);
 
       for (var i = 0; i < length; i++) {
         var curtain = curtains[i];
@@ -986,7 +986,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.key, data.value]);
+      return Buffer.from([data.key, data.value]);
     },
 
     response: 0xE3D9
@@ -1003,7 +1003,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.key, data.value]);
+      return Buffer.from([data.key, data.value]);
     }
   },
 
@@ -1014,7 +1014,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.key]);
+      return Buffer.from([data.key]);
     },
 
     response: 0xE3DB
@@ -1031,7 +1031,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.key, data.value]);
+      return Buffer.from([data.key, data.value]);
     }
   },
 
@@ -1091,7 +1091,7 @@ module.exports = {
 
     encode: function(data) {
       var timerPresent = (data.timer === undefined) ? 0 : 1;
-      var buffer = new Buffer(8 + timerPresent);
+      var buffer = Buffer.allocUnsafe(8 + timerPresent);
       var temperature = data.temperature;
 
       buffer.writeUInt8(temperature.type, 0);
@@ -1128,7 +1128,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(7);
+      var buffer = Buffer.allocUnsafe(7);
       var temperature = data.temperature;
 
       buffer.writeInt8(temperature.type, 0);
@@ -1164,7 +1164,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(8);
+      var buffer = Buffer.allocUnsafe(8);
       var temperature = data.temperature;
 
       status.encode(buffer, data.success, 0);
@@ -1189,7 +1189,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.channel]);
+      return Buffer.from([data.channel]);
     },
 
     response: 0x1C5F
@@ -1227,7 +1227,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(13);
+      var buffer = Buffer.allocUnsafe(13);
 
       var work = data.work;
       var watering = data.watering;
@@ -1276,7 +1276,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(10);
+      var buffer = Buffer.allocUnsafe(10);
 
       var work = data.work;
       var temperature = data.temperature;
@@ -1324,7 +1324,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(10);
+      var buffer = Buffer.allocUnsafe(10);
 
       var work = data.work;
       var temperature = data.temperature;
@@ -1381,7 +1381,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.logic]);
+      return Buffer.from([data.logic]);
     },
 
     response: 0xDB01
@@ -1407,7 +1407,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(8);
+      var buffer = Buffer.allocUnsafe(8);
       var contacts = data.dryContacts || [];
 
       for (var i = 0; i < 2; i++)
@@ -1459,7 +1459,7 @@ module.exports = {
       var contacts = data.dryContacts || [];
       var hasSonic = data.hasOwnProperty('sonic');
 
-      var buffer = new Buffer(hasSonic ? 8 : 7);
+      var buffer = Buffer.allocUnsafe(hasSonic ? 8 : 7);
 
       status.encode(buffer, data.success, 0);
       buffer.writeUInt8(data.temperature + 20, 1);
@@ -1505,7 +1505,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(7);
+      var buffer = Buffer.allocUnsafe(7);
       var contacts = data.dryContacts || [];
 
       buffer.writeUInt8(data.temperature + 20, 0);
@@ -1554,7 +1554,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(10);
+      var buffer = Buffer.allocUnsafe(10);
       var contacts = data.dryContacts || [];
 
       status.encode(buffer, data.success, 0);
@@ -1599,7 +1599,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(9);
+      var buffer = Buffer.allocUnsafe(9);
       var contacts = data.dryContacts || [];
 
       status.encode(buffer, data.success, 0);
@@ -1625,7 +1625,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.channel]);
+      return Buffer.from([data.channel]);
     },
 
     response: 0xE3E8
@@ -1649,7 +1649,7 @@ module.exports = {
 
       if (temperature < 0) temperature = -temperature;
 
-      return new Buffer([data.channel, temperature | sign]);
+      return Buffer.from([data.channel, temperature | sign]);
     }
   },
 
@@ -1676,7 +1676,7 @@ module.exports = {
 
       if (temperature < 0) temperature = -temperature;
 
-      return new Buffer([data.channel, temperature | sign]);
+      return Buffer.from([data.channel, temperature | sign]);
     }
   },
 
@@ -1689,7 +1689,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.channel]);
+      return Buffer.from([data.channel]);
     },
 
     response: 0x1949
@@ -1705,7 +1705,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(5);
+      var buffer = Buffer.allocUnsafe(5);
 
       buffer.writeUInt8(data.channel, 0);
       buffer.writeFloatLE(data.temperature, 1);
@@ -1757,10 +1757,46 @@ module.exports = {
   // 0x15D1
 
   // 16.1.3 Read Dry Contact Status
-  // 0x15CE
+  0x15CE: {
+    parse: function(buffer) {
+      return {
+        area: buffer.readUInt8(0),
+        switch: buffer.readUInt8(1)
+      };
+    },
+
+    encode: function(data) {
+      var buffer = Buffer.allocUnsafe(2);
+
+      buffer.writeUInt8(data.area, 0);
+      buffer.writeUInt8(data.switch, 1);
+
+      return buffer;
+    },
+
+    response: 0x15CF
+  },
 
   // 16.1.4 Response Read Dry Contact Status
-  // 0x15CF
+  0x15CF: {
+    parse: function(buffer) {
+      var data = {
+        area: buffer.readUInt8(0),
+        switch: buffer.readUInt8(1),
+        contact: Boolean(buffer.readUInt8(2))
+      };
+      return data;
+    },
+
+    encode: function(data) {
+      var buffer = Buffer.allocUnsafe(3);
+      buffer.writeUInt8(data.area, 0);
+      buffer.writeUInt8(data.switch, 1);
+      buffer.writeUInt8(data.contact ? 1 : 0, 2);
+
+      return buffer;
+    }
+  },
 
   /* 17. DLP Music Play Control Command */
 
@@ -1848,7 +1884,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(3);
+      var buffer = Buffer.allocUnsafe(3);
 
       buffer.writeUInt8(data.backlight, 0);
       buffer.writeUInt8(data.statusLights, 1);
@@ -1867,7 +1903,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(1);
+      var buffer = Buffer.allocUnsafe(1);
 
       status.encode(buffer, data.success, 0);
 
@@ -1888,7 +1924,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      var buffer = new Buffer(7);
+      var buffer = Buffer.allocUnsafe(7);
 
       buffer.writeUInt8(data.button, 0);
       buffer.writeUInt8(data.color.on[0], 1);
@@ -1911,7 +1947,7 @@ module.exports = {
     },
 
     encode: function(data) {
-      return new Buffer([data.button]);
+      return Buffer.from([data.button]);
     }
   }
 };