You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
2
-
# nodejs-poolController - Version 4.0.0 alpha 8. Version 4.x-DEV
2
+
# nodejs-poolController - Version 4.0.0
3
3
4
4
5
-
[](https://gitter.im/nodejs-poolController/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[](https://travis-ci.org/tagyoureit/nodejs-poolController)[](https://coveralls.io/github/tagyoureit/nodejs-poolController?branch=4.x-DEV)[](https://snyk.io/test/github/tagyoureit/nodejs-poolcontroller)
5
+
[](https://gitter.im/nodejs-poolController/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[](https://travis-ci.org/tagyoureit/nodejs-poolController)[](https://coveralls.io/github/tagyoureit/nodejs-poolController?branch=master)[](https://snyk.io/test/github/tagyoureit/nodejs-poolcontroller)
6
6
7
7
# License
8
8
@@ -75,8 +75,9 @@ for discussions, designs, and clarifications, we recommend you join our [Gitter
75
75
76
76
## Useful URL's included with the boring, basic, functional interface
77
77
78
-
- Control standalone pumps: http://_your_machine_name_:3000/pump.html
79
-
- Listen for specific messages: `http://_your_machine_name_:3000/debug.html`
78
+
* Control standalone pumps: `http://_your_machine_name_:3000/pump.html`
79
+
* Listen for specific messages: `http://_your_machine_name_:3000/debug.html`
80
+
* Send a message on the serial bus: `http://<server>:3000/public/send_packet.html`
80
81
81
82
#### Technical notes:
82
83
@@ -99,6 +100,7 @@ for discussions, designs, and clarifications, we recommend you join our [Gitter
99
100
* Set pool heat setpoint: /poolheat/setpoint/#
100
101
* Set pool heat mode: /poolheat/mode/# (0=off, 1=heater, 2=solar pref, 3=solar only)
101
102
* Run pumps in stand-alone mode
103
+
* Cancel delay: /cancelDelay
102
104
103
105
### APIs
104
106
You can use Sockets.IO (see the "basic UI" example). Valid sockets:
@@ -116,7 +118,8 @@ for discussions, designs, and clarifications, we recommend you join our [Gitter
116
118
| To app | <code>setPumpCommand(action, pump, program, rpm, duration)</code> | action=off,run, save, saverun; pump=1 or 2, program = 1 to 4, rpm = 450-3450, duration in minutes (or null for indefinite); leave parameters as null for any values that are not relevant. For example, to run program 4 on pump 1, call setPumpCommand('run',1,4,null,null)
117
119
| To app | <code>setDateTime(hour, min, dow*, day, mon, yy, dst) | set the date/time on the controller. dow= day of week as expressed as [0=Sunday, 1=Monday, 2=Tuesday, 4=Wednesday, 8=Thursday, 16=Friday, 32=Saturday] and DST = 0(manually adjst for DST) or 1(automatically adjust DST)
118
120
| To app | <code>setSchedule(id, circuit, starthh, startmm, endhh, endmm, dow*) | set the schedule on the controller for the particular schedule ID. dow= day of week as expressed as [0=Sunday, 1=Monday, 2=Tuesday, 4=Wednesday, 8=Thursday, 16=Friday, 32=Saturday] or a combination thereof [3=Monday+Tuesday]. To set a schedule set a valid start and end time (hh:mm). To set an egg timer, set the start time to 25:00 and the endtime to the duration (hh:mm) you want the egg timer to run.
119
-
| To app | <code>updateVersionNotification(bool) | true = do not send the updateAvailable socket until the next version is available. false = send updateAvailable everytime.
121
+
| To app | <code>updateVersionNotification(bool)</code> | true = do not send the updateAvailable socket until the next version is available. false = send updateAvailable everytime.
122
+
| To app | <code>cancelDelay</code>| Cancel and current circuit (valves/heater cool down?) delay.
120
123
| To client | <code>searchResults</code> | outputs packets that match the <code>search</code> socket
121
124
| To client | <code>circuit</code> | outputs an object of circuits and their status
122
125
| To client | ~~<code>config</code>~~ | ~~outputs an object with the pool controller status~~ Deprecated.
@@ -723,6 +726,9 @@ Docker Instructions
723
726
* Added capture for Ctrl-C/SIGINT to have a clean exit
724
727
* Added InfluxDB database capabilities
725
728
* Added support for reading the data from up to 16 pumps. (You can still only control two.)
0 commit comments