All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Fixed equipment.getCircuitNamesAsync timing out due to not listening to the correct event internally.
- Fixed bodies.setHeatModeAsync incorrectly subtracting one from the given body index. This is a breaking change if you were correcting for the offset already.
This major version number increase comes with many changes under the hood, including a rename of most every method in the library. This adds Promises and Typescript support. See the Migration guide and Breaking changes wiki pages for detailed information.
- Added simple "ping" message as a lightweight way to keep the connection alive for a user using the addClient() api.
- Fixed Date parsing from ScreenLogic packets returning the wrong date under specific conditions (such as the last day of the month or during specific hours when javascript month/day assignment order can change other parts of the date).
- Improved FindUnits.search() to support being called multiple times. This function issues one UDP broadcast per call, so consumer applications may need to run it in a delayed loop if no units are found on the first request (e.g. when the device running the search or the pool equipment is temporarily disconnected from the network). This is a stateless UDP query, so client applications cannot rely on the error or close events to issue retries.
- Added capturing of weather forecast events so that we're not treating it as an unknown message. This also includes full handling for getting weather forecasts from the equipment, but in my experience it's either outdated or not as thorough/reliable as we could get from pretty much any other source, so it remains undocumented for now.
- Added handling of asynchronous chemicalData messages. These are received periodically through the addClient() data push feature.
- Fixed an ugly problem where the library could hang and fail to hand off any more messages if multiple messages were received at the same time (which I've seen happen on lower powered hardware like a Raspberry Pi). This would also cause the internal data buffer to grow unbounded as long as the UnitConnection stayed alive.
- Added
closeevent to FindUnits, RemoteLogin, and UnitConnection for when the connection to the endpoint has closed.
- Added support for getting system chemical history data. This includes pH and ORP readings over time as well as pH and ORP feed on/off times.
- Added support for reading ScreenLogic time packets.
- Added support for getting system history data. This includes temperature readings over time as well as circuit on/off changes over time.
- Updated dependencies to safer versions of some packages.
- Fixed day-of-week conversion from Javascript Date objects to ScreenLogic times (SLTimes are 1-based starting on Sunday).
- Alphabetized the readme.
- Added handling/documentation for the scheduleChanged event (#44).
- Added support for getting and setting the system date/time.
- Documentation updates for
SLGetScheduleData, more linkage for easy navigation,addClient/removeClientmethods, clarifiedcoolSetPointfor spas.
- Every call now can optionally specify an ID that will be returned with the result, allowing tracking of simultaneous commands.
- Fleshed out the still-undocumented
SLEquipmentConfigurationMessagewith a few more helper methods for interpreting the data inside. - Helper method for getting a circuit from its device ID on an
SLControllerConfigMessage. - Support for getting the status of pumps and setting flow speeds per-pump-per-circuit.
- Constants for interpreting heat command/mode properties on various messages:
- ScreenLogic.HEAT_MODE_OFF
- ScreenLogic.HEAT_MODE_SOLAR
- ScreenLogic.HEAT_MODE_SOLARPREFERRED
- ScreenLogic.HEAT_MODE_HEATPUMP
- ScreenLogic.HEAT_MODE_DONTCHANGE
- Debug logs using the "debug" NPM package. You'll need to run an
npm installafter 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()andremoveClient()functions on theUnitConnectiondocs. Thanks @bshep
- Added support for adding, deleting, listing, and updating scheduled events - thanks @bshep
- Added egg timer support - thanks @bshep
- Support for controlling the salt cell generator's output levels.
- Helper methods for interpreting
controllerType. - Experimental support for an Equipment Configuration message (not documented as of yet -
SLEquipmentConfigurationMessage/getEquipmentConfiguration()). This message returns arrays of various information about the equipment, but I don't know how to interpret the information in those arrays yet. Any assistance with decoding this information would be hugely helpful. errorhandler on all objects for reacting to unhandled node errors - thanks @schemers
- VSCode "Example" configuration can now be launched on non-Windows platforms.
- Minor memory/performance optimizations.
- Running tests no longer changes any state of any pool equipment.
- Several methods added to SLControllerConfigMessage for interpreting the equipFlags value.
- server.gatewayName no longer cuts off the last character of the name. #14 - thanks @mikemucc
- Ability to set heat setpoint.
- Ability to set heat mode.
- Event for supplying incorrect parameters to
setfunctions. - Ability to send limited selection of light commands.
- Messages larger than 1024 bytes are now handled properly.
- Remote connection through Pentair servers
- Connecting to password-protected systems (this is only enforced by the ScreenLogic system on remote connections)
- Ability to set circuit state.
- FindUnits.sendServerBroadcast() was failing in certain environments.
- Direct connection support.
- Initial release