Add close events to each class

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.9.1 - 2022-05-20
+
+### Added
+
+* Added `close` event to FindUnits, RemoteLogin, and UnitConnection for when the connection to the endpoint has closed.
+
 ## v1.9.0 - 2022-05-20
 
 ### Added

README.md

@@ -126,6 +126,8 @@ Closes the socket.
 
 #### Events
 
+* `close` - Indicates that `close()` has been called on the finder.
+* `error` - Indicates that an unhandled error was caught.
 * `serverFound` - Indicates that a ScreenLogic unit has been found. Event handler receives a [`UnitConnection`](#unitconnection) object.
 
 Examples:
@@ -162,8 +164,9 @@ Closes the connection
 
 #### Events
 
+* `close` - Indicates that the connection to the remote login server has been closed. Event handler receives a bool indicating whether there was a transmission error.
+* `error` - Indicates that an unhandled error was caught (such as the connection timing out).
 * `gatewayFound` - Indicates that the search for the named unit has completed (may or may not be successful). Event handler receives a [`SLGetGatewayDataMessage`](#slgetgatewaydatamessage) argument.
-* `error` - Indicates that an unhandled error was caught (such as the connection timing out)
 
 ### UnitConnection
 
@@ -318,6 +321,7 @@ Sets the current date and time of the ScreenLogic system. Emits the `setSystemTi
 * `cancelDelay` - Indicates that a response to `cancelDelay()` has been received. Event handler receives a [`SLCancelDelay`](#slcanceldelay) object.
 * `chemicalData` - Indicates that a response to `getChemicalData()` has been received. Event handler receives a [`SLChemDataMessage`](#slchemdatamessage) object.
 * `circuitStateChanged` - Indicates that a response to `setCircuitState()` has been received. Event handler receives a [`SLSetCircuitStateMessage`](#slsetcircuitstatemessage) object.
+* `close` - Indicates that the connection to the unit has been closed. Event handler receives a bool indicating whether there was a transmission error.
 * `controllerConfig` - Indicates that a response to `getControllerConfig()` has been received. Event handler receives a [`SLControllerConfigMessage`](#slcontrollerconfigmessage) object.
 * `deleteScheduleById` - Indicates that a response to `deleteScheduleById()` has been received. Event handler receives a [`SLDeleteScheduleEventById`](#sldeletescheduleeventbyid) object.
 * `error` - Indicates that an unhandled error was caught (such as the connection timing out)

index.js

@@ -18,6 +18,7 @@ class FindUnits extends EventEmitter {
       _this.foundServer(message, remote);
     }).on('close', function() {
       debugFind('closed');
+      _this.emit('close');
     }).on('error', function(e) {
       debugFind('error: %O', e);
       _this.emit('error', e);
@@ -77,6 +78,7 @@ class RemoteLogin extends EventEmitter {
       _this.onClientMessage(msg);
     }).on('close', function(had_error) {
       debugRemote('remote login server connection closed');
+      _this.emit('close', had_error);
     }).on('error', function(e) {
       debugRemote('error: %o', e);
       _this.emit('error', e);
@@ -157,6 +159,7 @@ class UnitConnection extends EventEmitter {
       }
     }).on('close', function(had_error) {
       debugUnit('closed');
+      _this.emit('close', had_error);
     }).on('error', function(e) {
       debugUnit('error: %o', e);
       _this.emit('error', e);

package.json

@@ -1,7 +1,7 @@
 {
     "name": "node-screenlogic",
     "description": "Tool for connecting to Pentair ScreenLogic systems on the local network",
-    "version": "1.9.0",
+    "version": "1.9.1",
     "main": "index.js",
     "license": "MIT",
     "repository": "https://github.com/parnic/node-screenlogic.git",