|
|
@@ -1,4 +1,9 @@
|
|
|
-### ramp-thermostat
|
|
|
+# ramp-thermostat
|
|
|
+
|
|
|
+[![NPM version][npm-image]][npm-url]
|
|
|
+[npm-image]: http://img.shields.io/npm/v/node-red-contrib-ramp-thermostat.svg
|
|
|
+[npm-url]: https://npmjs.org/package/node-red-contrib-ramp-thermostat
|
|
|
+
|
|
|
A Node-RED contrib-node that emulates a thermostat.
|
|
|
|
|
|
The ramp-thermostat controls an actuator depending on the current input temperature and the target temperature (setpoint).
|
|
|
@@ -9,7 +14,7 @@ Run the following command in your Node-RED user directory - typically `~/.node-r
|
|
|
|
|
|
$ npm install node-red-contrib-ramp-thermostat
|
|
|
|
|
|
-### Configuration
|
|
|
+## Configuration
|
|
|
|
|
|
The target temperature is defined by a profile that provides the value depending on the current time `00:00-24:00`. The profile consists of several points whose connections build a sequence of lines. The switching moment can be optimized by defining a gradient line like a `ramp`.
|
|
|
|
|
|
@@ -17,7 +22,7 @@ A profile has at least 2 points and should typically start at 00:00 and end at 2
|
|
|
|
|
|
The hysteresis is used to prevent osciliation. The `[+]` value is added to the target and the `[-]` (absolute) value is subtracted from the target. Within this neutral zone no action accurs.
|
|
|
|
|
|
-### Usage
|
|
|
+## Usage
|
|
|
|
|
|
This node expects a numeric msg.payload containing the current temperature (number). The msg.topic should be `empty` or set to `setCurrent`. It will calculate the target temperature depending on msg.payload at the current time and output 3 values:
|
|
|
|
|
|
@@ -27,9 +32,9 @@ This node expects a numeric msg.payload containing the current temperature (numb
|
|
|
|
|
|
The state (true/false) is used to control an actuator. The current and target temperature outputs can be wired e.g. into an ui_chart node.
|
|
|
|
|
|
-### Runtime settings
|
|
|
+## Runtime settings
|
|
|
|
|
|
-**setTarget**
|
|
|
+### setTarget
|
|
|
|
|
|
```sh
|
|
|
msg.topic: setTarget
|
|
|
@@ -38,7 +43,7 @@ msg.payload: nn.n (number)
|
|
|
|
|
|
The target will be valid until a new target or a profile is set again or until node-red is restarted.
|
|
|
|
|
|
-**setProfile**
|
|
|
+### setProfile
|
|
|
|
|
|
```sh
|
|
|
msg.topic: setProfile
|
|
|
@@ -54,7 +59,7 @@ msg.topic: setProfile
|
|
|
msg.payload: {"name":"myGreatProfile","points":{"00:00":16.0,"08:00":20.0,"20:00":20.0,"24:00":16.0}}
|
|
|
```
|
|
|
|
|
|
-### Examples
|
|
|
+# Examples
|
|
|
|
|
|
|
|
|
|
Luigi Cisana