From a53909eaa227470a0ce71a1e7afebbdfedcb05ba Mon Sep 17 00:00:00 2001 From: Parnic Date: Sat, 22 Aug 2020 21:33:24 -0500 Subject: [PATCH] Add table of contents to readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 1cf384d..c32edbc 100755 --- a/README.md +++ b/README.md @@ -4,6 +4,36 @@ This is a Node.JS library for interfacing with Pentair ScreenLogic systems over 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) + ## Usage See example.js for an example of interfacing with the library. Broadly, import the library with