Merge pull request #24 from yaacov/add-close-method

Add a close method
yaacov · May 30, 2016 · bf85f68 · bf85f68
2 parents ba9d237 + 265134b
commit bf85f68
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -3,6 +3,7 @@ declare namespace ModbusRTU {
     new(port?: any): IModbusRTU;
 
     open(callback: Function): void;
+    close(callback: Function): void;
 
     writeFC1(address: number, dataAddress: number, length: number, next: NodeStyleCallback<ReadCoilResult>): void;
     writeFC2(address: number, dataAddress: number, length: number, next: NodeStyleCallback<ReadCoilResult>): void;

diff --git a/index.js b/index.js
@@ -271,6 +271,17 @@ ModbusRTU.prototype.open = function (callback) {
     });
 };
 
+/**
+ * Close the serial port
+ *
+ * @param {Function} callback the function to call next on close success
+ *      or failure.
+ */
+ModbusRTU.prototype.close = function (callback) {
+    // close the serial port
+    this._port.close(callback);
+};
+
 /**
  * Write a Modbus "Read Coil Status" (FC=01) to serial port.
  *

diff --git a/test/test.js b/test/test.js
@@ -18,6 +18,16 @@ describe('ModbusRTU', function() {
         });
     });
 
+    describe('#close() - close serial port.', function () {
+        it('should close the port without errors', function (done) {
+            modbusRTU.close(function(err) {
+                expect(err).to.be.a('null');
+
+                done();
+            });
+        });
+    });
+
     describe('#writeFC3() - read holding registers.', function () {
         it('should read 3 registers [0xa12b, 0xffff, 0xb21a] without errors', function (done) {
             modbusRTU.writeFC3(1, 8, 3, function(err, data) {