27 Commits

Author SHA1 Message Date
4cfffdd9df Drop support for nodejs 10.x, add 14.x and 16.x
Update package.json version
2021-10-13 14:14:41 -05:00
ba6dac4399 Update changelog, dependencies 2021-10-13 14:12:05 -05:00
f406bccb5d Update coolSetPoint documentation per user findings
Closes #57
2021-09-06 23:09:44 -05:00
a5d207d3aa Add support for setting the current system date/time
#56
2021-09-06 23:02:02 -05:00
f271554d89 Add DateTime writing support to SLMessages
There may be some value in providing a read version of this as well, but
it is comprised of so many properties that I'm leaving that out for now.
If it becomes a need in the future, it will be straightforward to add.
2021-09-06 23:01:42 -05:00
37d40b3386 Add support for retrieving the current system date/time
#56
2021-09-06 23:00:51 -05:00
6f1ee3c13f Add info about add/remove client function events 2021-09-06 22:56:16 -05:00
0b990bbc28 Add links to time conversion functions 2021-09-06 21:51:50 -05:00
2aa14cc114 Fix SLGetScheduleData documentation 2021-09-06 21:51:50 -05:00
bef8e6a379 Bump glob-parent from 5.1.1 to 5.1.2
Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2.
- [Release notes](https://github.com/gulpjs/glob-parent/releases)
- [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md)
- [Commits](https://github.com/gulpjs/glob-parent/compare/v5.1.1...v5.1.2)

---
updated-dependencies:
- dependency-name: glob-parent
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-11 07:23:37 -05:00
5bbbfb6f41 Bump lodash from 4.17.20 to 4.17.21
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.20...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-10 22:26:51 -05:00
fa43b3c03e Bump y18n from 4.0.0 to 4.0.1
Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1.
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/commits)

Signed-off-by: dependabot[bot] <support@github.com>
2021-03-31 14:36:05 -05:00
789f75f4a6 Add missing break 2020-12-12 21:14:41 -06:00
1ea8548991 Add handling/documentation for the scheduleChanged event
See discussion on #44 for more info
2020-12-12 21:12:15 -06:00
542d2f3e94 Disabled scheduled CodeQL runs 2020-11-28 19:44:23 -06:00
5f5b52f1ab Tag new version, update dev dependencies 2020-11-23 08:15:44 -06:00
7f76cb2a54 Update changelog for release 2020-11-23 08:13:43 -06:00
863cd7b1e6 Create codeql-analysis.yml 2020-10-01 11:57:43 -05:00
a53909eaa2 Add table of contents to readme 2020-08-22 21:33:24 -05:00
27bdf0380e Ensure all messages populate the response senderId
Fixed `addClient` and `removeClient` events returning `SLCancelDelay` objects. This shouldn't really make a difference as there are no properties to worry about on one or the other, but it was still incorrect and could cause bugs if stuff was added to those messages in the future.
2020-08-12 08:51:44 -05:00
8294947f8c Update dev dependencies due to vulnerabilities 2020-08-11 22:31:18 -05:00
b0225c69bd Update to point at the new default branch name 2020-08-11 22:28:07 -05:00
89b8775ce3 Add support for specifying the sender id to each call
This parameter is optional, so compatibility shouldn't be affected. Each SLMessage can set its own sender ID which is present on the returned message. This allows callers to fire multiple requests at once, even of the same type, while being able to identify which response went with which request. If not specified, the default value is 0.

Also went ahead and documented some of the helper functions present on SLMessage (so, available on all message instances).

Finally, since I was in and messing with each message anyway, I simplified and removed some repeated code from each derived message and had it call into the super to take advantage of shared decoding functionality.

The lambdas ("arrow functions") in test functions were removed per advice from Mocha's documentation where the implicit `this` rebinding can apparently cause problems. This should probably have been its own commit, but, again, I was already in there messing with stuff, so...oh well.

Closes #43
2020-08-11 22:20:58 -05:00
ab36d17a38 Increase version for NPM-specific fix
I had local changes to the example script that inadvertently were pushed to npm as part of 1.6.0, so that release on npm didn't match the repo's contents.
2020-07-15 20:58:41 -05:00
c36e4cbaa2 Fix changelog release date
Time is meaningless these days anyway...
2020-07-14 15:55:34 -05:00
df22901ea1 Add another missed attribution 2020-07-14 12:51:05 -05:00
b23f488822 Remove specific node versions tested against
These change frequently and it's probably not worth documenting anyway. I'm pretty sure these versions were no longer valid anyway since, for example, Mocha no longer supports node v8.
2020-07-14 12:50:50 -05:00
35 changed files with 1271 additions and 1229 deletions

69
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@ -0,0 +1,69 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"
on:
push:
branches: [main]
pull_request:
# The branches below must be a subset of the branches above
branches: [main]
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
# Override automatic language detection by changing the below list
# Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
language: ['javascript']
# Learn more...
# https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2
# If this run was triggered by a pull request event, then checkout
# the head of the pull request instead of the merge commit.
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

View File

@ -5,9 +5,9 @@ name: Node.js CI
on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]
jobs:
build:
@ -16,7 +16,7 @@ jobs:
strategy:
matrix:
node-version: [10.x, 12.x]
node-version: [12.x, 14.x, 16.x]
steps:
- uses: actions/checkout@v2

View File

@ -5,7 +5,24 @@ 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.6.0 - 2020-06-14
## v1.7.0 - 2021-10-13
### Added
* Added handling/documentation for the scheduleChanged event (#44).
* Added support for getting and setting the system date/time.
### Fixed
* Documentation updates for `SLGetScheduleData`, more linkage for easy navigation, `addClient`/`removeClient` methods, clarified `coolSetPoint` for spas.
## v1.6.1 - 2020-11-23
### Added
* Every call now can optionally specify an ID that will be returned with the result, allowing tracking of simultaneous commands.
## v1.6.0 - 2020-07-14
### Added
@ -20,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* ScreenLogic.HEAT_MODE_DONTCHANGE
* Debug logs using the "debug" NPM package. You'll need to run an `npm install` after updating to this version.
* Ability to cancel delays in pool equipment. #20 - thanks @bshep
* Ability to register for push messages from the equipment so the connection can be kept open instead of repeatedly reconnecting and polling for changes. See the `addClient()` and `removeClient()` functions on the `UnitConnection` docs.
* Ability to register for push messages from the equipment so the connection can be kept open instead of repeatedly reconnecting and polling for changes. See the `addClient()` and `removeClient()` functions on the `UnitConnection` docs. Thanks @bshep
## v1.5.0 - 2020-06-06

236
README.md
View File

@ -2,7 +2,39 @@
This is a Node.JS library for interfacing with Pentair ScreenLogic systems over your local network or remotely through the Pentair dispatcher. Local connections require a Pentair ScreenLogic device on the same network (a network which supports UDP broadcasts).
Tested on node v8.11.1, v10.15.1 with a system on firmware versions 5.2 Build 736.0 Rel, 5.2 Build 738.0 Rel
Tested with a Pentair ScreenLogic system on firmware versions 5.2 Build 736.0 Rel, 5.2 Build 738.0 Rel
* [Usage](#usage)
* [Notes](#notes)
* [Packet format](#packet-format)
* [API reference](#api-reference)
* [FindUnits](#findunits)
* [RemoteLogin](#remotelogin)
* [UnitConnection](#unitconnection)
* [All messages](#all-messages)
* [SLVersionMessage](#slversionmessage)
* [SLPoolStatusMessage](#slpoolstatusmessage)
* [SLChemDataMessage](#slchemdatamessage)
* [SLSaltCellConfigMessage](#slsaltcellconfigmessage)
* [SLSetSaltCellConfigMessage](#slsetsaltcellconfigmessage)
* [SLControllerConfigMessage](#slcontrollerconfigmessage)
* [SLSetCircuitStateMessage](#slsetcircuitstatemessage)
* [SLSetHeatSetPointMessage](#slsetheatsetpointmessage)
* [SLSetHeatModeMessage](#slsetheatmodemessage)
* [SLLightControlMessage](#sllightcontrolmessage)
* [SLGetGatewayDataMessage](#slgetgatewaydatamessage)
* [SLAddNewScheduleEvent](#sladdnewscheduleevent)
* [SLDeleteScheduleEventById](#sldeletescheduleeventbyid)
* [SLGetScheduleData](#slgetscheduledata)
* [SLSetScheduleEventById](#slsetscheduleeventbyid)
* [SLSetCircuitRuntimeById](#slsetcircuitruntimebyid)
* [SLGetPumpStatus](#slgetpumpstatus)
* [SLSetPumpFlow](#slsetpumpflow)
* [SLCancelDelay](#slcanceldelay)
* [SLAddClient](#sladdclient)
* [SLRemoveClient](#slremoveclient)
* [SLGetSystemTime](#slgetsystemtime)
* [SLSetSystemTime](#slsetsystemtime)
## Usage
@ -178,87 +210,95 @@ client.connect();
Closes the connection.
#### getVersion()
#### getVersion(senderId)
Requests the system version string from the connected unit. Emits the `version` event when the response comes back.
Requests the system version string from the connected unit. Emits the `version` event when the response comes back. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getPoolStatus()
#### getPoolStatus(senderId)
Requests pool status from the connected unit. Emits the `poolStatus` event when the response comes back.
Requests pool status from the connected unit. Emits the `poolStatus` event when the response comes back. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getChemicalData()
#### getChemicalData(senderId)
Requests chemical data from the connected unit (may require an IntelliChem or similar). Emits the `chemicalData` event when the response comes back.
Requests chemical data from the connected unit (may require an IntelliChem or similar). Emits the `chemicalData` event when the response comes back. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getSaltCellConfig()
#### getSaltCellConfig(senderId)
Requests salt cell status/configuration from the connected unit (requires an IntelliChlor or compatible salt cell). Emits the `saltCellConfig` event when the response comes back.
Requests salt cell status/configuration from the connected unit (requires an IntelliChlor or compatible salt cell). Emits the `saltCellConfig` event when the response comes back. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getControllerConfig()
#### getControllerConfig(senderId)
Requests controller configuration from the connected unit. Emits the `controllerConfig` event when the response comes back.
Requests controller configuration from the connected unit. Emits the `controllerConfig` event when the response comes back. `senderId` isan optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setCircuitState(controllerId, circuitId, circuitState)
#### setCircuitState(controllerId, circuitId, circuitState, senderId)
Activates or deactivates a circuit. See [`SLSetCircuitStateMessage`](#slsetcircuitstatemessage) documentation for argument values. Emits the `circuitStateChanged` event when response is acknowledged.
Activates or deactivates a circuit. See [`SLSetCircuitStateMessage`](#slsetcircuitstatemessage) documentation for argument values. Emits the `circuitStateChanged` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setSetPoint(controllerId, bodyType, temperature)
#### setSetPoint(controllerId, bodyType, temperature, senderId)
Sets the heating setpoint for any body. See [`SLSetHeatSetPointMessage`](#slsetheatsetpointmessage) documentation for argument values. Emits the `setPointChanged` event when response is acknowledged.
Sets the heating setpoint for any body. See [`SLSetHeatSetPointMessage`](#slsetheatsetpointmessage) documentation for argument values. Emits the `setPointChanged` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setHeatMode(controllerId, bodyType, heatMode)
#### setHeatMode(controllerId, bodyType, heatMode, senderId)
Sets the preferred heat mode. See [`SLSetHeatModeMessage`](#slsetheatmodemessage) documentation for argument values. Emits the `heatModeChanged` event when response is acknowledged.
Sets the preferred heat mode. See [`SLSetHeatModeMessage`](#slsetheatmodemessage) documentation for argument values. Emits the `heatModeChanged` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### sendLightCommand(controllerId, command)
#### sendLightCommand(controllerId, command, senderId)
Sends a lighting command. See [`SLLightControlMessage`](#sllightcontrolmessage) documentation for argument values. Emits the `sentLightCommand` event when response is acknowledged.
Sends a lighting command. See [`SLLightControlMessage`](#sllightcontrolmessage) documentation for argument values. Emits the `sentLightCommand` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
Note that better/more complete handling of lighting is desired, but I have yet to find all the commands I need to implement to make that happen. This currently sends each command to all lights and there is no ability to send to an individual light. Pull requests adding more functionality here would be most welcome.
#### setSaltCellOutput(controllerId, poolOutput, spaOutput)
#### setSaltCellOutput(controllerId, poolOutput, spaOutput, senderId)
Sets the salt cell's output levels. See [`SLSetSaltCellConfigMessage`](#slsetsaltcellconfigmessage) documentation for argument values. Emits the `setSaltCellConfig` event when response is acknowledged.
Sets the salt cell's output levels. See [`SLSetSaltCellConfigMessage`](#slsetsaltcellconfigmessage) documentation for argument values. Emits the `setSaltCellConfig` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getScheduleData(scheduleType)
#### getScheduleData(scheduleType, senderId)
Retrieves a list of schedule events of the specified type. See [`SLGetScheduleData`](#slgetscheduledata) documentation for argument values. Emits the `getScheduleData` event when response is acknowledged.
Retrieves a list of schedule events of the specified type. See [`SLGetScheduleData`](#slgetscheduledata) documentation for argument values. Emits the `getScheduleData` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### addNewScheduleEvent(scheduleType)
#### addNewScheduleEvent(scheduleType, senderId)
Adds a new event to the specified schedule type. See [`SLAddNewScheduleEvent`](#sladdnewscheduleevent) documentation for argument values. Emits the `addNewScheduleEvent` event when response is acknowledged.
Adds a new event to the specified schedule type. See [`SLAddNewScheduleEvent`](#sladdnewscheduleevent) documentation for argument values. Emits either the `addNewScheduleEvent` or `scheduleChanged` event when response is acknowledged (listen for both). `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### deleteScheduleEventById(scheduleId)
#### deleteScheduleEventById(scheduleId, senderId)
Deletes a scheduled event with specified id. See [`SLDeleteScheduleEventById`](#sldeletescheduleeventbyid) documentation for argument values. Emits the `deleteScheduleById` event when response is acknowledged.
Deletes a scheduled event with specified id. See [`SLDeleteScheduleEventById`](#sldeletescheduleeventbyid) documentation for argument values. Emits the `deleteScheduleById` or `scheduleChanged` event when response is acknowledged (listen for both). `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setScheduleEventById(scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint)
#### setScheduleEventById(scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint, senderId)
Configures a schedule event. See [`SLSetScheduleEventById`](#slsetscheduleeventbyid) documentation for argument values. Emits the `setScheduleEventById` event when response is acknowledged.
Configures a schedule event. See [`SLSetScheduleEventById`](#slsetscheduleeventbyid) documentation for argument values. Emits the `setScheduleEventById` or `scheduleChanged` event when response is acknowledged (listen for both). `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setCircuitRuntimebyId(circuitId, runTime)
#### setCircuitRuntimebyId(circuitId, runTime, senderId)
Configures default run-time of a circuit, usually referred to as the 'egg timer'. This also applies to 'run-once' programs as this will set the length of the program. See [`SLSetCircuitRuntimeById`](#slsetcircuitruntimebyid) documentation for argument values. Emits the `setCircuitRuntimeById` event when response is acknowledged.
Configures default run-time of a circuit, usually referred to as the 'egg timer'. This also applies to 'run-once' programs as this will set the length of the program. See [`SLSetCircuitRuntimeById`](#slsetcircuitruntimebyid) documentation for argument values. Emits the `setCircuitRuntimeById` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getPumpStatus(pumpId)
#### getPumpStatus(pumpId, senderId)
Gets information about the specified pump. See [`SLGetPumpStatus`](#slgetpumpstatus) documentation for argument values. Emits the `getPumpStatus` event when response is acknowledged.
Gets information about the specified pump. See [`SLGetPumpStatus`](#slgetpumpstatus) documentation for argument values. Emits the `getPumpStatus` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setPumpFlow(pumpId, circuitId, setPoint, isRPMs)
#### setPumpFlow(pumpId, circuitId, setPoint, isRPMs, senderId)
Sets flow setting for a pump/circuit combination. See [`SLSetPumpFlow`](#slsetpumpflow) documentation for argument values. Emits the `setPumpFlow` event when response is acknowledged.
Sets flow setting for a pump/circuit combination. See [`SLSetPumpFlow`](#slsetpumpflow) documentation for argument values. Emits the `setPumpFlow` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### cancelDelay()
#### cancelDelay(senderId)
Cancels any delays on the system. See [`SLCancelDelay`](#slcanceldelay) documentation. Emits the `cancelDelay` event when response is acknowledged.
Cancels any delays on the system. See [`SLCancelDelay`](#slcanceldelay) documentation. Emits the `cancelDelay` event when response is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### addClient(senderId)
#### addClient(clientId, senderId)
Registers to receive updates from controller when something changes. Takes a random number `senderId` to identify the client. Emits the `poolStatus` event when something changes on the controller.
Registers to receive updates from controller when something changes. Takes a random number `clientId` to identify the client. Emits the `poolStatus` event when something changes on the controller, and the `addClient` event when the request to add a client is acknowledged. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### removeClient(senderId)
#### removeClient(clientId, senderId)
No longer receive `poolStatus` messages from controller. Takes a random number `senderId` that should match a previously registered client with `addClient`.
No longer receive `poolStatus` messages from controller. Emits the `removeClient` event when the request to remove a client is acknowledged. Takes a random number `clientId` that should match a previously registered client with `addClient`. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### getSystemTime(senderId)
Retrieves the current time the system is set to. Emits the `getSystemTime` event when response is received. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
#### setSystemTime(date, adjustForDST, senderId)
Sets the current date and time of the ScreenLogic system. Emits the `setSystemTime` event when request is acknowledged. `date` must be a `Date` instance holding the date/time to set, and `adjustForDST` must be a boolean indicating whether the system should adjust for daylight saving time or not. `senderId` is an optional 16-bit integer and will be present as the `senderId` field on the returned message.
### Events
@ -277,10 +317,15 @@ No longer receive `poolStatus` messages from controller. Takes a random number `
* `addNewScheduleEvent` - Indicates that a response to `addNewScheduleEvent()` has been received which contains the created `scheduleId` to be used later for setting up the properties. Event handler receives a [`SLAddNewScheduleEvent`](#sladdnewscheduleevent) object.
* `deleteScheduleById` - Indicates that a response to `deleteScheduleById()` has been received. Event handler receives a [`SLDeleteScheduleEventById`](#sldeletescheduleeventbyid) object.
* `setScheduleEventById` - Indicates that a response to `setScheduleEventById()` has been received. Event handler receives a [`SLSetScheduleEventById`](#slsetscheduleeventbyid) object.
* `scheduleChanged` - Indicates that a response to adding, deleting, or setting a schedule has been received. Event handler receives nothing. This seems to be arbitrarily returned sometimes instead of a normal ack by the system.
* `setCircuitRuntimeById` - Indicates that a response to `setCircuitRuntimeById()` has been received. Event handler receives a [`SLSetCircuitRuntimeById`](#slsetcircuitruntimebyid) object.
* `getPumpStatus` - Indicates that a response to `getPumpStatus()` has been received. Event handler receives a [`SLGetPumpStatus`](#slgetpumpstatus) object.
* `setPumpFlow` - Indicates that a response to `setPumpFlow()` has been received. Event handler receives a [`SLSetPumpFlow`](#slsetpumpflow) object.
* `cancelDelay` - Indicates that a response to `cancelDelay()` has been received. Event handler receives a [`SLCancelDelay`](#slcanceldelay) object.
* `addClient` - Indicates that a response to `addClient()` has been received. Event handler receives a [`SLAddClient`](#sladdclient) object.
* `removeClient` - Indicates that a response to `removeClient()` has been received. Event handler receives a [`SLRemoveClient`](#slremoveclient) object.
* `getSystemTime` - Indicates that a response to `getSystemTime()` has been received. Event handler receives a [`SLGetSystemTime`](#slgetsystemtime) object.
* `setSystemTime` - Indicates that a response to `setSystemTime()` has been received. Event handler receives a [`SLSetSystemTime`](#slsetsystemtime) object if the request was valid, or `null` if the request was invalid (input parameters were not of the required types).
* `loginFailed` - Indicates that a remote login attempt via supplying a system address and password to `UnitConnection` has failed likely due to the incorrect password being used.
* `badParameter` - Indicates that a bad parameter has been supplied to a function. This can be triggered, for example, by sending the wrong controller ID to a `set` function.
* `error` - Indicates that an unhandled error was caught (such as the connection timing out)
@ -295,6 +340,49 @@ No longer receive `poolStatus` messages from controller. Takes a random number `
* `gatewaySubtype` - byte
* `gatewayName` - string representing the server's name. Will be in the format Pentair: xx-xx-xx
### All messages
Information about features common to all the below SL Message types.
#### decodeTime(time)
Interprets a time integer recorded as minutes past midnight and returns the ScreenLogic string representation of it in 24-hour time.
#### encodeTime(time)
Interprets the string representing 24-hour time and returns an integer of minutes past midnight.
#### decodeDayMask(mask)
Converts a day mask from, for example, `SLGetScheduleData`'s events[idx].days property into a `DAY_VALUES` array for ease of use.
#### encodeDayMask(days)
Converts an array of DAY_VALUES into a mask used by, for example, `SLGetScheduleData`'s events[idx].days property.
#### getDayValue(dayName)
Returns the value of a given `DAY_VALUES` day name.
`DAY_VALUES` is defined as the following array for simplicity of checking whether a specific day is set in a mask:
```js
const DAY_VALUES = [
['Mon', 0x1 ],
['Tue', 0x2 ],
['Wed', 0x4 ],
['Thu', 0x8 ],
['Fri', 0x10 ],
['Sat', 0x20 ],
['Sun', 0x40 ],
];
```
#### Properties
* `senderId` - an integer matching whatever was passed as the `senderId` argument when making the initial request (default 0)
* `messageId` - an integer indicating the ScreenLogic ID for this message
### SLVersionMessage
Passed as an argument to the emitted `version` event handler.
@ -339,7 +427,7 @@ Returns a bool indicating whether the pool is currently active or not.
* `currentTemp` - array of size 0-2 indicating current temperature of each body as an integer (pool: 0, spa: 1) (check controller config to see if it's in celsius or fahrenheit)
* `heatStatus` - array of size 0-2 indicating whether heat is active or not for each body as an integer (pool: 0, spa: 1)
* `setPoint` - array of size 0-2 holding the heating set point for each body as an integer (pool: 0, spa: 1) (check controller config to see if it's in celsius or fahrenheit)
* `coolSetPoint` - array of size 0-2 holding the cooling set point for each body as an integer (pool: 0, spa: 1) (check controller config to see if it's in celsius or fahrenheit)
* `coolSetPoint` - array of size 0-2 holding the cooling set point for each body as an integer (pool: 0, spa: 1; the spa seems to always track air temperature for this, however) (check controller config to see if it's in celsius or fahrenheit)
* `heatMode` - array of size 0-2 indicating whether heating is enabled or not for each body as an integer (pool: 0, spa: 1)
* `circuitArray` - array holding all circuits in the system
* `id` - integer representing the circuit's ID (spa is 500, pool is 505)
@ -395,7 +483,7 @@ Passed as an argument to the emitted `saltCellConfig` event handler.
### SLSetSaltCellConfigMessage
Passed as an argument to the emitted `setSaltCellConfig` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command.
Passed as an argument to the emitted `setSaltCellConfig` event.
#### Properties
@ -484,7 +572,7 @@ Returns the `bodyArray` entry for the circuit matching the given device id. This
### SLSetCircuitStateMessage
Passed as an argument to the emitted `circuitStateChanged` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command.
Passed as an argument to the emitted `circuitStateChanged` event.
#### Properties
@ -496,7 +584,7 @@ Passed as an argument to the emitted `circuitStateChanged` event. The passed ver
### SLSetHeatSetPointMessage
Passed as an argument to the emitted `setPointChanged` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command.
Passed as an argument to the emitted `setPointChanged` event.
#### Properties
@ -507,7 +595,7 @@ Passed as an argument to the emitted `setPointChanged` event. The passed version
### SLSetHeatModeMessage
Passed as an argument to the emitted `heatModeChanged` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command.
Passed as an argument to the emitted `heatModeChanged` event.
#### Properties
@ -523,7 +611,7 @@ Passed as an argument to the emitted `heatModeChanged` event. The passed version
### SLLightControlMessage
Passed as an argument to the emitted `sentLightCommand` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the light command.
Passed as an argument to the emitted `sentLightCommand` event.
#### Properties
@ -584,7 +672,24 @@ Passed as an argument to the emitted `getScheduleData` event. Retrieves a list o
#### Properties
* `scheduleType` - 0 indicates regular scheduled events, 1 indicates a run-once event
* `eventCount` - the number of `events` returned
* `events` - array containing:
* `scheduleId` - the associated scheduleId
* `circuitId` - the circuit this schedule affects
* `startTime` - the start time of the event, specified as a string in 24-hour time, so, for example, 6:00AM would be '0600' (see [conversion functions](#decodetimetime))
* `stopTime` - the stop time of the event, specified as a string in 24-hour time, so, for example, 6:00AM would be '0600' (see [conversion functions](#decodetimetime))
* `dayMask` - 7-bit mask that determines which days the schedule is active for, MSB is always 0, valid numbers 1-127 (see [conversion functions](#decodedaymaskmask))
* `flags`
* bit 0 is the schedule type, if 0 then regular event, if 1 its a run-once
* bit 1 indicates whether heat setPoint should be changed
* `heatCmd` - integer indicating the desired heater mode. Valid values are:
* ScreenLogic.HEAT_MODE_OFF
* ScreenLogic.HEAT_MODE_SOLAR
* ScreenLogic.HEAT_MODE_SOLARPREFERRED
* ScreenLogic.HEAT_MODE_HEATPUMP
* ScreenLogic.HEAT_MODE_DONTCHANGE
* `heatSetPoint` - the temperature set point if heat is to be changed (ignored if bit 1 of flags is 0)
* `days` - which days this schedule is active for; this is just the `dayMask` property run through [`decodeDayMask()`](#decodedaymaskmask) for convenience
### SLSetScheduleEventById
@ -594,10 +699,10 @@ Passed as an argument to the emitted `setScheduleEventById` event. Configures an
* `scheduleId` - id of a schedule previously created, see [`SLAddNewScheduleEvent`](#sladdnewscheduleevent)
* `circuitId` - id of the circuit to which this event applies
* `startTime` - the start time of the event, specified as minutes since midnight
* `startTime` - the start time of the event, specified as minutes since midnight (see [conversion functions](#encodetimetime))
* example: 6:00am would be 360
* example: 6:15am would be 375
* `stopTime` - the stop time of the event, specified as minutes since midnight
* `stopTime` - the stop time of the event, specified as minutes since midnight (see [conversion functions](#encodetimetime))
* `dayMask`
* 7-bit mask that determines which days the schedule is active for, MSB is always 0, valid numbers 1-127
* `flags`
@ -613,7 +718,7 @@ Passed as an argument to the emitted `setScheduleEventById` event. Configures an
### SLSetCircuitRuntimeById
Passed as an argument to the emitted `setCircuitRuntimebyId` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command. Configures default run-time of a circuit, usually referred to as the 'egg timer'. This also applies to 'run-once' programs as this will set the length of the program.
Passed as an argument to the emitted `setCircuitRuntimebyId` event. Configures default run-time of a circuit, usually referred to as the 'egg timer'. This also applies to 'run-once' programs as this will set the length of the program.
#### Properties
@ -647,7 +752,7 @@ Passed as an argument to the emitted `getPumpStatus` event. Gets information abo
### SLSetPumpFlow
Passed as an argument to the emitted `setPumpFlow` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command. Sets flow setting for a pump/circuit combination.
Passed as an argument to the emitted `setPumpFlow` event. Sets flow setting for a pump/circuit combination.
#### Properties
@ -658,12 +763,33 @@ Passed as an argument to the emitted `setPumpFlow` event. The passed version is
### SLCancelDelay
Passed as an argument to the emitted `cancelDelay` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the set command.
Passed as an argument to the emitted `cancelDelay` event.
### SLAddClient
Passed as an argument to the emitted `addClient` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the command.
Passed as an argument to the emitted `addClient` event.
### SLRemoveClient
Passed as an argument to the emitted `removeClient` event. The passed version is empty, however, since the response is just an acknowledgement of receipt of the command.
Passed as an argument to the emitted `removeClient` event.
### SLGetSystemTime
Contains information about the system's current time and date. Passed as an argument to the emitted `getSystemTime` event.
#### Properties
* `year` - short representing current system year
* `month` - short representing current system month (where 1 is January, 2 is February, etc.)
* `day` - short representing current system day of the month
* `dayOfWeek` - short representing current system day of the week (where 0 is Monday and 6 is Sunday)
* `hour` - short representing current system hour (24-hour time where 0 is midnight, 13 is 1PM, etc.)
* `minute` - short representing current system minute
* `second` - short representing current system second
* `millisecond` - short representing current system millisecond
* `adjustForDST` - bool indicating whether the system should adjust for daylight saving time or not
* `date` - `Date` instance representing the current system datetime (convenience, constructed from the above properties)
### SLSetSystemTime
Passed as an argument to the emitted `setSystemTime` event.

180
index.js
View File

@ -191,110 +191,132 @@ class UnitConnection extends EventEmitter {
this.client.write(new messages.SLLoginMessage(password).toBuffer());
}
getPoolStatus() {
debugUnit('sending pool status query...');
this.client.write(new messages.SLPoolStatusMessage().toBuffer());
getPoolStatus(senderId) {
debugUnit('[%d] sending pool status query...', senderId || 0);
this.client.write(new messages.SLPoolStatusMessage(null, senderId).toBuffer());
}
getControllerConfig() {
debugUnit('sending controller config query...');
this.client.write(new messages.SLControllerConfigMessage().toBuffer());
getControllerConfig(senderId) {
debugUnit('[%d] sending controller config query...', senderId || 0);
this.client.write(new messages.SLControllerConfigMessage(null, senderId).toBuffer());
}
getChemicalData() {
debugUnit('sending chemical data query...');
this.client.write(new messages.SLChemDataMessage().toBuffer());
getChemicalData(senderId) {
debugUnit('[%d] sending chemical data query...', senderId || 0);
this.client.write(new messages.SLChemDataMessage(null, senderId).toBuffer());
}
getSaltCellConfig() {
debugUnit('sending salt cell config query...');
this.client.write(new messages.SLSaltCellConfigMessage().toBuffer());
getSaltCellConfig(senderId) {
debugUnit('[%d] sending salt cell config query...', senderId || 0);
this.client.write(new messages.SLSaltCellConfigMessage(null, senderId).toBuffer());
}
getVersion() {
debugUnit('sending version query...');
this.client.write(new messages.SLVersionMessage().toBuffer());
getVersion(senderId) {
debugUnit('[%d] sending version query...', senderId || 0);
this.client.write(new messages.SLVersionMessage(null, senderId).toBuffer());
}
getEquipmentConfiguration() {
debugUnit('sending equipment configuration query...');
this.client.write(new messages.SLEquipmentConfigurationMessage().toBuffer());
getEquipmentConfiguration(senderId) {
debugUnit('[%d] sending equipment configuration query...', senderId || 0);
this.client.write(new messages.SLEquipmentConfigurationMessage(null, senderId).toBuffer());
}
setCircuitState(controllerId, circuitId, circuitState) {
debugUnit('sending set circuit state command: controllerId: %d, circuitId: %d, circuitState: %d...', controllerId, circuitId, circuitState);
this.client.write(new messages.SLSetCircuitStateMessage(controllerId, circuitId, circuitState).toBuffer());
setCircuitState(controllerId, circuitId, circuitState, senderId) {
debugUnit('[%d] sending set circuit state command: controllerId: %d, circuitId: %d, circuitState: %d...', senderId || 0, controllerId, circuitId, circuitState);
this.client.write(new messages.SLSetCircuitStateMessage(controllerId, circuitId, circuitState, senderId).toBuffer());
}
setSetPoint(controllerId, bodyType, temperature) {
debugUnit('sending set setpoint command: controllerId: %d, bodyType: %d, temperature: %d...', controllerId, bodyType, temperature);
this.client.write(new messages.SLSetHeatSetPointMessage(controllerId, bodyType, temperature).toBuffer());
setSetPoint(controllerId, bodyType, temperature, senderId) {
debugUnit('[%d] sending set setpoint command: controllerId: %d, bodyType: %d, temperature: %d...', senderId || 0, controllerId, bodyType, temperature);
this.client.write(new messages.SLSetHeatSetPointMessage(controllerId, bodyType, temperature, senderId).toBuffer());
}
setHeatMode(controllerId, bodyType, heatMode) {
debugUnit('sending set heatmode command: controllerId: %d, bodyType: %d, heatMode: %d...', controllerId, bodyType, heatMode);
this.client.write(new messages.SLSetHeatModeMessage(controllerId, bodyType, heatMode).toBuffer());
setHeatMode(controllerId, bodyType, heatMode, senderId) {
debugUnit('[%d] sending set heatmode command: controllerId: %d, bodyType: %d, heatMode: %d...', senderId || 0, controllerId, bodyType, heatMode);
this.client.write(new messages.SLSetHeatModeMessage(controllerId, bodyType, heatMode, senderId).toBuffer());
}
sendLightCommand(controllerId, command) {
debugUnit('sending light command: controllerId: %d, command: %d...', controllerId, command);
this.client.write(new messages.SLLightControlMessage(controllerId, command).toBuffer());
sendLightCommand(controllerId, command, senderId) {
debugUnit('[%d] sending light command: controllerId: %d, command: %d...', senderId || 0, controllerId, command);
this.client.write(new messages.SLLightControlMessage(controllerId, command, senderId).toBuffer());
}
setSaltCellOutput(controllerId, poolOutput, spaOutput) {
debugUnit('sending set saltcell output command: controllerId: %d, poolOutput: %d, spaOutput: %d...', controllerId, poolOutput, spaOutput);
this.client.write(new messages.SLSetSaltCellConfigMessage(controllerId, poolOutput, spaOutput).toBuffer());
setSaltCellOutput(controllerId, poolOutput, spaOutput, senderId) {
debugUnit('[%d] sending set saltcell output command: controllerId: %d, poolOutput: %d, spaOutput: %d...', senderId || 0, controllerId, poolOutput, spaOutput);
this.client.write(new messages.SLSetSaltCellConfigMessage(controllerId, poolOutput, spaOutput, senderId).toBuffer());
}
getScheduleData(scheduleType) {
debugUnit('sending set schedule data query for scheduleType: %d...', scheduleType);
this.client.write(new messages.SLGetScheduleData(null, scheduleType).toBuffer());
getScheduleData(scheduleType, senderId) {
debugUnit('[%d] sending set schedule data query for scheduleType: %d...', senderId || 0, scheduleType);
this.client.write(new messages.SLGetScheduleData(null, scheduleType, senderId).toBuffer());
}
addNewScheduleEvent(scheduleType) {
debugUnit('sending add new schedule event command for scheduleType: %d...', scheduleType);
this.client.write(new messages.SLAddNewScheduleEvent(null, scheduleType).toBuffer());
addNewScheduleEvent(scheduleType, senderId) {
debugUnit('[%d] sending add new schedule event command for scheduleType: %d...', senderId || 0, scheduleType);
this.client.write(new messages.SLAddNewScheduleEvent(null, scheduleType, senderId).toBuffer());
}
deleteScheduleEventById(scheduleId) {
debugUnit('sending delete schedule event command for scheduleId: %d...', scheduleId);
this.client.write(new messages.SLDeleteScheduleEventById(scheduleId).toBuffer());
deleteScheduleEventById(scheduleId, senderId) {
debugUnit('[%d] sending delete schedule event command for scheduleId: %d...', senderId || 0, scheduleId);
this.client.write(new messages.SLDeleteScheduleEventById(scheduleId, senderId).toBuffer());
}
// todo: should this just accept a SLSetScheduleEventById message instead of all these args?
setScheduleEventById(scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint) {
debugUnit('sending set schedule event command for scheduleId: %d, circuitId: %d, startTime: %d, stopTime: %d, dayMask: %d, flags: %d, heatCmd: %d, heatSetPoint: %d...', scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint);
this.client.write(new messages.SLSetScheduleEventById(null, scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint).toBuffer());
setScheduleEventById(scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint, senderId) {
debugUnit('[%d] sending set schedule event command for scheduleId: %d, circuitId: %d, startTime: %d, stopTime: %d, dayMask: %d, flags: %d, heatCmd: %d, heatSetPoint: %d...', senderId || 0, scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint);
this.client.write(new messages.SLSetScheduleEventById(null, scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint, senderId).toBuffer());
}
setCircuitRuntimebyId(circuitId, runTime) {
debugUnit('sending set circuit runtime command for circuitId: %d, runTime: %d...', circuitId, runTime);
this.client.write(new messages.SLSetCircuitRuntimeById(circuitId, runTime).toBuffer());
setCircuitRuntimebyId(circuitId, runTime, senderId) {
debugUnit('[%d] sending set circuit runtime command for circuitId: %d, runTime: %d...', senderId || 0, circuitId, runTime);
this.client.write(new messages.SLSetCircuitRuntimeById(circuitId, runTime, senderId).toBuffer());
}
getPumpStatus(pumpId) {
debugUnit('sending get pump status command for pumpId: %d...', pumpId);
this.client.write(new messages.SLGetPumpStatus(null, pumpId).toBuffer());
getPumpStatus(pumpId, senderId) {
debugUnit('[%d] sending get pump status command for pumpId: %d...', senderId || 0, pumpId);
this.client.write(new messages.SLGetPumpStatus(null, pumpId, senderId).toBuffer());
}
setPumpFlow(pumpId, circuitId, setPoint, isRPMs) {
debugUnit('sending set pump flow command for pumpId: %d, circuitId: %d, setPoint: %d, isRPMs: %d...', pumpId, circuitId, setPoint, isRPMs);
this.client.write(new messages.SLSetPumpFlow(pumpId, circuitId, setPoint, isRPMs).toBuffer());
setPumpFlow(pumpId, circuitId, setPoint, isRPMs, senderId) {
debugUnit('[%d] sending set pump flow command for pumpId: %d, circuitId: %d, setPoint: %d, isRPMs: %d...', senderId || 0, pumpId, circuitId, setPoint, isRPMs);
this.client.write(new messages.SLSetPumpFlow(pumpId, circuitId, setPoint, isRPMs, senderId).toBuffer());
}
cancelDelay() {
debugUnit('sending cancel delay command...');
this.client.write(new messages.SLCancelDelay().toBuffer());
cancelDelay(senderId) {
debugUnit('[%d] sending cancel delay command...', senderId || 0);
this.client.write(new messages.SLCancelDelay(senderId).toBuffer());
}
addClient(senderId) {
debugUnit('sending add client command...');
this.client.write(new messages.SLAddClient(senderId).toBuffer());
addClient(clientId, senderId) {
debugUnit('[%d] sending add client command, clientId %d...', senderId || 0, clientId);
this.client.write(new messages.SLAddClient(clientId, senderId).toBuffer());
}
removeClient(senderId) {
debugUnit('sending remove client command...');
this.client.write(new messages.SLRemoveClient(senderId).toBuffer());
removeClient(clientId, senderId) {
debugUnit('[%d] sending remove client command, clientId %d...', senderId || 0, clientId);
this.client.write(new messages.SLRemoveClient(clientId, senderId).toBuffer());
}
getSystemTime(senderId) {
debugUnit('[%d] sending get system time query...', senderId || 0);
this.client.write(new messages.SLGetSystemTime(null, senderId).toBuffer());
}
setSystemTime(date, shouldAdjustForDST, senderId) {
if (!(date instanceof Date)) {
debugUnit('setSystemTime() must receive valid Date object for the date argument');
this.emit('setSystemTime', null);
return;
}
if (typeof shouldAdjustForDST !== 'boolean') {
debugUnit('setSystemTime() must receive a boolean for the shouldAdjustForDST argument');
this.emit('setSystemTime', null);
return;
}
debugUnit('[%d] sending set system time command...', senderId || 0);
this.client.write(new messages.SLSetSystemTime(null, date, shouldAdjustForDST, senderId).toBuffer());
}
onClientMessage(msg) {
@ -336,23 +358,23 @@ class UnitConnection extends EventEmitter {
break;
case messages.SLSetCircuitStateMessage.getResponseId():
debugUnit(" it's circuit toggle ack");
this.emit('circuitStateChanged', new messages.SLSetCircuitStateMessage());
this.emit('circuitStateChanged', new messages.SLSetCircuitStateMessage(msg));
break;
case messages.SLSetHeatSetPointMessage.getResponseId():
debugUnit(" it's a setpoint ack");
this.emit('setPointChanged', new messages.SLSetHeatSetPointMessage());
this.emit('setPointChanged', new messages.SLSetHeatSetPointMessage(msg));
break;
case messages.SLSetHeatModeMessage.getResponseId():
debugUnit(" it's a heater mode ack");
this.emit('heatModeChanged', new messages.SLSetHeatModeMessage());
this.emit('heatModeChanged', new messages.SLSetHeatModeMessage(msg));
break;
case messages.SLLightControlMessage.getResponseId():
debugUnit(" it's a light control ack");
this.emit('sentLightCommand', new messages.SLLightControlMessage());
this.emit('sentLightCommand', new messages.SLLightControlMessage(msg));
break;
case messages.SLSetSaltCellConfigMessage.getResponseId():
debugUnit(" it's a set salt cell config ack");
this.emit('setSaltCellConfig', new messages.SLSetSaltCellConfigMessage());
this.emit('setSaltCellConfig', new messages.SLSetSaltCellConfigMessage(msg));
break;
case messages.SLEquipmentConfigurationMessage.getResponseId():
debugUnit(" it's equipment configuration");
@ -376,7 +398,7 @@ class UnitConnection extends EventEmitter {
break;
case messages.SLSetCircuitRuntimeById.getResponseId():
debugUnit(" it's a set circuit runtime ack");
this.emit('setCircuitRuntimebyId', new messages.SLSetCircuitRuntimeById());
this.emit('setCircuitRuntimebyId', new messages.SLSetCircuitRuntimeById(msg));
break;
case messages.SLGetPumpStatus.getResponseId():
debugUnit(" it's pump status");
@ -384,24 +406,36 @@ class UnitConnection extends EventEmitter {
break;
case messages.SLSetPumpFlow.getResponseId():
debugUnit(" it's a set pump flow ack");
this.emit('setPumpFlow', new messages.SLSetPumpFlow());
this.emit('setPumpFlow', new messages.SLSetPumpFlow(msg));
break;
case messages.SLCancelDelay.getResponseId():
debugUnit(" it's a cancel delay ack");
this.emit('cancelDelay', new messages.SLCancelDelay());
this.emit('cancelDelay', new messages.SLCancelDelay(msg));
break;
case messages.SLAddClient.getResponseId():
debugUnit(" it's an add client ack");
this.emit('addClient', new messages.SLCancelDelay());
this.emit('addClient', new messages.SLAddClient(msg));
break;
case messages.SLRemoveClient.getResponseId():
debugUnit(" it's a remove client ack");
this.emit('removeClient', new messages.SLCancelDelay());
this.emit('removeClient', new messages.SLRemoveClient(msg));
break;
case messages.SLPoolStatusMessage.getAsyncResponseId():
debugUnit(" it's async pool status");
this.emit('poolStatus', new messages.SLPoolStatusMessage(msg));
break;
case messages.SLGetSystemTime.getResponseId():
debugUnit(" it's system time");
this.emit('getSystemTime', new messages.SLGetSystemTime(msg));
break;
case messages.SLSetSystemTime.getResponseId():
debugUnit(" it's a set system time ack");
this.emit('setSystemTime', new messages.SLSetSystemTime(msg));
break;
case 12501:
debugUnit(" it's a schedule changed notification");
this.emit('scheduleChanged');
break;
case 13:
debugUnit(" it's a login failure.");
this.emit('loginFailed');

View File

@ -5,15 +5,20 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12522;
exports.SLAddClient = class SLAddClient extends SLMessage {
constructor(senderId) {
super(0, MSG_ID);
constructor(clientId, senderId) {
if (typeof clientId === 'object') {
var size = clientId.readInt32LE(4) + 8;
super(clientId, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.senderId = senderId;
this.clientId = clientId;
}
}
encode() {
this.writeInt32LE(0);
this.writeInt32LE(this.senderId);
this.writeInt32LE(this.clientId);
super.encode();
}

View File

@ -6,23 +6,15 @@ const MSG_ID = 12544;
exports.SLAddNewScheduleEvent = class SLAddNewScheduleEvent extends SLMessage {
constructor(buf, scheduleType) {
var size;
constructor(buf, scheduleType, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
if (!buf) {
// console.log('Requested Schedule type = ', scheduleType);
this.writeInt32LE(0);
this.writeInt32LE(scheduleType);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
this.decode();
}
}

View File

@ -5,9 +5,8 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12580;
exports.SLCancelDelay = class SLCancelDelay extends SLMessage {
constructor() {
super(0, MSG_ID);
constructor(senderId) {
super(senderId, MSG_ID);
}
encode() {

View File

@ -5,20 +5,14 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12592;
exports.SLChemDataMessage = class SLChemDataMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (!buf) {
this.writeInt32LE(0); // controller index
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
super(senderId, MSG_ID);
this.decode();
this.writeInt32LE(0); // controller index
}
}

View File

@ -13,21 +13,15 @@ const CIRCUIT_NAME_VALUE_MAP = [
];
exports.SLControllerConfigMessage = class SLControllerConfigMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (!buf) {
this.writeInt32LE(0);
this.writeInt32LE(0);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
super(senderId, MSG_ID);
this.decode();
this.writeInt32LE(0);
this.writeInt32LE(0);
}
}

View File

@ -5,8 +5,8 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12546;
exports.SLDeleteScheduleEventById = class SLDeleteScheduleEventById extends SLMessage {
constructor(scheduleId) {
super(0, MSG_ID);
constructor(scheduleId, senderId) {
super(senderId, MSG_ID);
this.writeInt32LE(0);
this.writeInt32LE(scheduleId);

View File

@ -5,21 +5,15 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12566;
exports.SLEquipmentConfigurationMessage = class SLEquipmentConfigurationMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (!buf) {
this.writeInt32LE(0);
this.writeInt32LE(0);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
super(senderId, MSG_ID);
this.decode();
this.writeInt32LE(0);
this.writeInt32LE(0);
}
}

View File

@ -5,21 +5,15 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12584;
exports.SLGetPumpStatus = class SLGetPumpStatus extends SLMessage {
constructor(buf, pumpId) {
var size;
constructor(buf, pumpId, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
if (!buf) {
this.writeInt32LE(0);
this.writeInt32LE(pumpId);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
this.decode();
}
}

View File

@ -5,22 +5,15 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12542;
exports.SLGetScheduleData = class SLGetScheduleData extends SLMessage {
constructor(buf, scheduleType) {
var size;
constructor(buf, scheduleType, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
if (!buf) {
this.writeInt32LE(0);
this.writeInt32LE(scheduleType);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
this.decode();
}
}

View File

@ -0,0 +1,37 @@
'use strict';
const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 8110;
exports.SLGetSystemTime = class SLGetSystemTime extends SLMessage {
constructor(buf, senderId) {
if (buf) {
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
}
}
decode() {
super.decode();
this.year = this.readUInt16LE();
this.month = this.readUInt16LE();
this.dayOfWeek = this.readUInt16LE();
this.day = this.readUInt16LE();
this.hour = this.readUInt16LE();
this.minute = this.readUInt16LE();
this.second = this.readUInt16LE();
this.millisecond = this.readUInt16LE();
var adjustForDST = this.readInt32LE();
this.adjustForDST = adjustForDST === 1;
this.date = new Date(this.year, this.month - 1, this.day, this.hour, this.minute, this.second);
}
static getResponseId() {
return MSG_ID + 1;
}
};

View File

@ -5,11 +5,16 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12556;
exports.SLLightControl = class SLLightControl extends SLMessage {
constructor(controllerIndex, command) {
super(0, MSG_ID);
constructor(controllerIndex, command, senderId) {
if (typeof controllerIndex === 'object') {
var size = controllerIndex.readInt32LE(4) + 8;
super(controllerIndex, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.controllerIndex = controllerIndex;
this.command = command;
this.controllerIndex = controllerIndex;
this.command = command;
}
}
encode() {

View File

@ -27,7 +27,7 @@ exports.SLMessage = class SLMessage extends SmartBuffer {
this.writeUInt16LE(messageId || 0);
this._wroteSize = false;
} else if (senderId) {
} else if (typeof senderId === 'object') {
this._wroteSize = true;
var buffer = senderId;
this.writeBuffer(buffer, 0);
@ -150,6 +150,21 @@ exports.SLMessage = class SLMessage extends SmartBuffer {
return 0;
}
writeSLDateTime(date) {
this.writeInt16LE(date.getFullYear());
this.writeInt16LE(date.getMonth() + 1);
var dayOfWeek = date.getDay() - 1;
if (dayOfWeek < 0) {
dayOfWeek = 6;
}
this.writeInt16LE(dayOfWeek);
this.writeInt16LE(date.getDate());
this.writeInt16LE(date.getHours());
this.writeInt16LE(date.getMinutes());
this.writeInt16LE(date.getSeconds());
this.writeInt16LE(date.getMilliseconds());
}
static slackForAlignment(val) {
return (4 - val % 4) % 4;
}

View File

@ -9,20 +9,14 @@ const SPA_CIRCUIT_ID = 500;
const POOL_CIRCUIT_ID = 505;
exports.SLPoolStatusMessage = class SLPoolStatusMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (!buf) {
this.writeInt32LE(0);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
super(senderId, MSG_ID);
this.decode();
this.writeInt32LE(0);
}
}

View File

@ -5,15 +5,20 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12524;
exports.SLRemoveClient = class SLRemoveClient extends SLMessage {
constructor(senderId) {
super(0, MSG_ID);
constructor(clientId, senderId) {
if (typeof clientId === 'object') {
var size = clientId.readInt32LE(4) + 8;
super(clientId, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.senderId = senderId;
this.clientId = clientId;
}
}
encode() {
this.writeInt32LE(0);
this.writeInt32LE(this.senderId);
this.writeInt32LE(this.clientId);
super.encode();
}

View File

@ -5,20 +5,14 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12572;
exports.SLSaltCellConfigMessage = class SLSaltCellConfigMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (!buf) {
this.writeInt32LE(0); // controller index
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
super(senderId, MSG_ID);
this.decode();
this.writeInt32LE(0); // controller index
}
}

View File

@ -6,11 +6,16 @@ const MSG_ID = 12550;
exports.SLSetCircuitRuntimeById = class SLSetCircuitRuntimeById extends SLMessage {
constructor(circuitId, runTime) {
super(0, MSG_ID);
constructor(circuitId, runTime, senderId) {
if (typeof circuitId === 'object') {
var size = circuitId.readInt32LE(4) + 8;
super(circuitId, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.circuitId = circuitId;
this.runTime = runTime;
this.circuitId = circuitId;
this.runTime = runTime;
}
}
encode() {

View File

@ -5,12 +5,17 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12530;
exports.SLSetCircuitStateMessage = class SLSetCircuitStateMessage extends SLMessage {
constructor(controllerId, circuitId, circuitState) {
super(0, MSG_ID);
constructor(controllerId, circuitId, circuitState, senderId) {
if (typeof controllerId === 'object') {
var size = controllerId.readInt32LE(4) + 8;
super(controllerId, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.controllerId = controllerId;
this.circuitId = circuitId;
this.circuitState = circuitState;
this.controllerId = controllerId;
this.circuitId = circuitId;
this.circuitState = circuitState;
}
}
encode() {

View File

@ -5,14 +5,17 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12538;
exports.SLSetHeatMode = class SLSetHeatMode extends SLMessage {
constructor(controllerIndex, bodyType, heatMode) {
super(0, MSG_ID);
constructor(controllerIndex, bodyType, heatMode, senderId) {
if (typeof controllerIndex === 'object') {
var size = controllerIndex.readInt32LE(4) + 8;
super(controllerIndex, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.controllerIndex = controllerIndex;
this.bodyType = bodyType;
this.heatMode = heatMode;
// heatmodes:
// 0: "Off", 1: "Solar", 2 : "Solar Preferred", 3 : "Heat Pump", 4: "Don't Change"
this.controllerIndex = controllerIndex;
this.bodyType = bodyType;
this.heatMode = heatMode;
}
}
encode() {

View File

@ -5,12 +5,17 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12528;
exports.SLSetHeatSetPoint = class SLSetHeatSetPoint extends SLMessage {
constructor(controllerIndex, bodyType, temperature) {
super(0, MSG_ID);
constructor(controllerIndex, bodyType, temperature, senderId) {
if (typeof controllerIndex === 'object') {
var size = controllerIndex.readInt32LE(4) + 8;
super(controllerIndex, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.controllerIndex = controllerIndex;
this.bodyType = bodyType;
this.temperature = temperature;
this.controllerIndex = controllerIndex;
this.bodyType = bodyType;
this.temperature = temperature;
}
}
encode() {

View File

@ -5,16 +5,22 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12586;
exports.SLSetPumpFlow = class SLSetPumpFlow extends SLMessage {
constructor(pumpId, circuitId, setPoint, isRPMs) {
super(0, MSG_ID);
this.pumpId = pumpId;
this.circuitId = circuitId;
this.setPoint = setPoint;
if (isRPMs === true) {
this.isRPMs = 1;
constructor(pumpId, circuitId, setPoint, isRPMs, senderId) {
if (typeof pumpId === 'object') {
var size = pumpId.readInt32LE(4) + 8;
super(pumpId, MSG_ID, size);
} else {
this.isRPMs = 0;
super(senderId, MSG_ID);
this.pumpId = pumpId;
this.circuitId = circuitId;
this.setPoint = setPoint;
if (isRPMs === true) {
this.isRPMs = 1;
} else {
this.isRPMs = 0;
}
}
}

View File

@ -5,12 +5,17 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 12576;
exports.SLSetSaltCellConfigMessage = class SLSetSaltCellConfigMessage extends SLMessage {
constructor(controllerIndex, poolOutput, spaOutput) {
super(0, MSG_ID);
constructor(controllerIndex, poolOutput, spaOutput, senderId) {
if (typeof controllerIndex === 'object') {
var size = controllerIndex.readInt32LE(4) + 8;
super(controllerIndex, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.controllerIndex = controllerIndex;
this.poolOutput = poolOutput;
this.spaOutput = spaOutput;
this.controllerIndex = controllerIndex;
this.poolOutput = poolOutput;
this.spaOutput = spaOutput;
}
}
encode() {

View File

@ -6,15 +6,13 @@ const MSG_ID = 12548;
exports.SLSetScheduleEventById = class SLSetScheduleEventById extends SLMessage {
constructor(buf, scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint) {
var size;
constructor(buf, scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
if (!buf) {
this.writeInt32LE(0);
this.writeInt32LE(scheduleId);
this.writeInt32LE(circuitId);
@ -24,11 +22,6 @@ exports.SLSetScheduleEventById = class SLSetScheduleEventById extends SLMessage
this.writeInt32LE(flags);
this.writeInt32LE(heatCmd);
this.writeInt32LE(heatSetPoint);
} else {
this._wroteSize = true;
this.writeBuffer(buf, 0);
this.decode();
}
}

View File

@ -0,0 +1,28 @@
'use strict';
const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 8112;
exports.SLSetSystemTime = class SLSetSystemTime extends SLMessage {
constructor(buf, date, shouldAdjustForDST, senderId) {
if (buf) {
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
this.date = date;
this.shouldAdjustForDST = shouldAdjustForDST;
}
}
encode() {
this.writeSLDateTime(this.date);
this.writeInt32LE(this.shouldAdjustForDST ? 1 : 0);
}
static getResponseId() {
return MSG_ID + 1;
}
};

View File

@ -5,18 +5,12 @@ const SLMessage = require('./SLMessage.js').SLMessage;
const MSG_ID = 8120;
exports.SLVersionMessage = class SLVersionMessage extends SLMessage {
constructor(buf) {
var size;
constructor(buf, senderId) {
if (buf) {
size = buf.readInt32LE(4) + 8;
}
super(0, MSG_ID, size);
if (buf) {
this._wroteSize = true;
this.writeBuffer(buf, 0);
this.decode();
var size = buf.readInt32LE(4) + 8;
super(buf, MSG_ID, size);
} else {
super(senderId, MSG_ID);
}
}

View File

@ -25,3 +25,5 @@ exports.SLSetPumpFlow = require('./SLSetPumpFlow.js').SLSetPumpFlow;
exports.SLCancelDelay = require('./SLCancelDelay.js').SLCancelDelay;
exports.SLAddClient = require('./SLAddClient.js').SLAddClient;
exports.SLRemoveClient = require('./SLRemoveClient.js').SLRemoveClient;
exports.SLGetSystemTime = require('./SLGetSystemTime.js').SLGetSystemTime;
exports.SLSetSystemTime = require('./SLSetSystemTime.js').SLSetSystemTime;

1472
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,28 +1,28 @@
{
"name": "node-screenlogic",
"description": "Tool for connecting to Pentair ScreenLogic systems on the local network",
"version": "1.6.0",
"main": "index.js",
"license": "MIT",
"repository": "https://github.com/parnic/node-screenlogic.git",
"keywords": [
"pentair",
"pool",
"screenlogic",
"swimmingpool"
],
"dependencies": {
"debug": "^4.1.1",
"smart-buffer": "~4.1.0"
},
"devDependencies": {
"eslint": "^7.4.0",
"eslint-config-strongloop": "^2.1.0",
"mocha": "^8.0.0"
},
"scripts": {
"test": "mocha test/*.spec.js",
"pretest": "eslint --ignore-path .gitignore .",
"test-slmessage": "mocha test/slmessage.spec.js"
}
"name": "node-screenlogic",
"description": "Tool for connecting to Pentair ScreenLogic systems on the local network",
"version": "1.7.0",
"main": "index.js",
"license": "MIT",
"repository": "https://github.com/parnic/node-screenlogic.git",
"keywords": [
"pentair",
"pool",
"screenlogic",
"swimmingpool"
],
"dependencies": {
"debug": "^4.3.2",
"smart-buffer": "^4.2.0"
},
"devDependencies": {
"eslint": "^8.0.0",
"eslint-config-strongloop": "^2.1.0",
"mocha": "^9.1.2"
},
"scripts": {
"test": "mocha test/*.spec.js",
"pretest": "eslint --ignore-path .gitignore .",
"test-slmessage": "mocha test/slmessage.spec.js"
}
}

View File

@ -3,8 +3,8 @@
const ScreenLogic = require('../index');
// you'll need a ScreenLogic-enabled device on your network for this to succeed
describe('Finder', () => {
it('finds a server', done => {
describe('Finder', function() {
it('finds a server', function(done) {
let finder = new ScreenLogic.FindUnits();
finder.on('serverFound', server => {
finder.close();

View File

@ -9,7 +9,7 @@ function slMessageLen(str) {
return 4 + str.length + SLMessage.slackForAlignment(str.length);
}
describe('SLMessage utilities', () => {
describe('SLMessage utilities', function() {
// message header = senderId, messageId, bodyLen.
// senderId and messageId are int16's, so 2b each. bodyLen is an int32, so 4b. total 8b.
let msgHeaderLen = 8;
@ -172,4 +172,21 @@ describe('SLMessage utilities', () => {
assert.strictEqual(decodedMsg.dataLength, decodedMsg.readOffset - 8);
}
});
it('encodes Date as SLTime', function() {
let msg = new SLMessage();
let date = new Date(2021, 8, 6, 22, 8, 5);
msg.writeSLDateTime(date);
let decodedMsg = new SLMessage(msg.toBuffer());
assert.equal(decodedMsg.readUInt16LE(), 2021);
// javascript Date() month is 0-based, ScreenLogic month matches the calendar
assert.equal(decodedMsg.readUInt16LE(), 9);
// ScreenLogic day-of-week starts with Monday as 0
assert.equal(decodedMsg.readUInt16LE(), 0);
assert.equal(decodedMsg.readUInt16LE(), 6);
assert.equal(decodedMsg.readUInt16LE(), 22);
assert.equal(decodedMsg.readUInt16LE(), 8);
assert.equal(decodedMsg.readUInt16LE(), 5);
assert.equal(decodedMsg.readUInt16LE(), 0);
});
});

View File

@ -1,11 +1,12 @@
'use strict';
const ScreenLogic = require('../index');
var assert = require('assert');
// you'll need a ScreenLogic-enabled device on your network for this to succeed
describe('Unit', () => {
describe('Unit', function() {
let unit;
before(done => {
before(function(done) {
let finder = new ScreenLogic.FindUnits();
finder.on('serverFound', server => {
finder.close();
@ -21,50 +22,57 @@ describe('Unit', () => {
finder.search();
});
after(() => {
after(function() {
unit.close();
});
// let circuit;
it('gets pool status', done => {
it('gets pool status', function(done) {
unit.on('poolStatus', status => {
/* circuit = */status.circuitArray[0];
assert.equal(status.senderId, 0);
done();
});
unit.getPoolStatus();
});
it('gets controller config', done => {
it('gets controller config', function(done) {
unit.on('controllerConfig', config => {
assert.equal(config.senderId, 42);
done();
});
unit.getControllerConfig();
unit.getControllerConfig(42);
});
it('gets chemical data', done => {
unit.on('chemicalData', () => {
it('gets chemical data', function(done) {
unit.on('chemicalData', chemData => {
assert.equal(chemData.senderId, 123);
done();
});
unit.getChemicalData();
unit.getChemicalData(123);
});
it('gets salt cell config', done => {
unit.on('saltCellConfig', () => {
it('gets salt cell config', function(done) {
unit.on('saltCellConfig', saltConfig => {
assert.equal(saltConfig.senderId, 0);
done();
});
unit.getSaltCellConfig();
});
it('gets version', done => {
unit.on('version', () => {
it('gets version', function(done) {
unit.on('version', version => {
assert.equal(version.senderId, 41239);
done();
});
unit.getVersion();
unit.getVersion(41239);
});
/* uncomment this and the `circuit` stuff above to test setting state
it('sets circuit state', done => {
it('sets circuit state', function(done) {
unit.on('circuitStateChanged', () => {
done();
});