node-red-contrib-3dm-space 0.0.8 → 1.0.2

package/3dm-config-store.html

@@ -0,0 +1,236 @@
+<script type="text/javascript">
+    RED.nodes.registerType("3dm-config-store", {
+        category: "3DM.space",
+        color: "#6D6D6D",
+        defaults: {
+            name: { value: "" },
+            configName: { value: "" },
+            tickSeconds: {
+                value: 20,
+                validate: function (v) {
+                    var n = Number(v);
+                    return !isNaN(n) && n >= 1 && n <= 60;
+                }
+            },
+            outputMode: { value: "change" },
+            configOutput: { value: 0 },
+            emitConfigOnUpdate: { value: false }
+        },
+        inputs: 1,
+        outputs: 24,
+        icon: "font-awesome/fa-database",
+        label: function () {
+            return this.name || "3DM config store";
+        },
+        paletteLabel: "3DM config store",
+        outputLabels: function (index) {
+            return "Output " + (index + 1);
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="3dm-config-store">
+    <div class="form-row">
+        <label for="node-input-name">
+            <i class="fa fa-tag"></i> Node Name
+        </label>
+        <input type="text" id="node-input-name" placeholder="Optional, e.g. Pump Config Store">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-configName">
+            <i class="fa fa-folder-open"></i> Config Name
+        </label>
+        <input type="text" id="node-input-configName" placeholder="Optional, e.g. mainScheduler">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-tickSeconds">
+            <i class="fa fa-clock-o"></i> Check Every
+        </label>
+        <input type="number" id="node-input-tickSeconds" min="1" max="60" placeholder="20" style="width:100px;">
+        <span> seconds</span>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-outputMode">
+            <i class="fa fa-sign-out"></i> Output Mode
+        </label>
+        <select id="node-input-outputMode" style="width:70%;">
+            <option value="change">Only when output changes</option>
+            <option value="always">Every check</option>
+        </select>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-configOutput">
+            <i class="fa fa-share-square-o"></i> Config Output
+        </label>
+        <select id="node-input-configOutput" style="width:70%;">
+            <option value="0">Disabled</option>
+            <option value="1">Output 1</option>
+            <option value="2">Output 2</option>
+            <option value="3">Output 3</option>
+            <option value="4">Output 4</option>
+            <option value="5">Output 5</option>
+            <option value="6">Output 6</option>
+            <option value="7">Output 7</option>
+            <option value="8">Output 8</option>
+            <option value="9">Output 9</option>
+            <option value="10">Output 10</option>
+            <option value="11">Output 11</option>
+            <option value="12">Output 12</option>
+            <option value="13">Output 13</option>
+            <option value="14">Output 14</option>
+            <option value="15">Output 15</option>
+            <option value="16">Output 16</option>
+            <option value="17">Output 17</option>
+            <option value="18">Output 18</option>
+            <option value="19">Output 19</option>
+            <option value="20">Output 20</option>
+            <option value="21">Output 21</option>
+            <option value="22">Output 22</option>
+            <option value="23">Output 23</option>
+            <option value="24">Output 24</option>
+        </select>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-emitConfigOnUpdate">
+            <i class="fa fa-refresh"></i> Send Config
+        </label>
+        <input type="checkbox" id="node-input-emitConfigOnUpdate" style="display:inline-block; width:auto; vertical-align:top;">
+        <span> send stored config when updated</span>
+    </div>
+
+    <div class="form-tips">
+        <b>Tip:</b> Leave Config Name blank to allow this node to store and use all config blocks sent under <code>configStore</code>.
+    </div>
+</script>
+
+<script type="text/html" data-help-name="3dm-config-store">
+    <p>
+        Stores configuration sent from 3DM.space and runs local schedule/control logic.
+    </p>
+
+    <p>
+        This node is normally placed after a <b>3DM In</b> node.
+    </p>
+
+    <pre>3DM In → 3DM Config Store → 24 outputs</pre>
+
+    <h3>Config Store Format</h3>
+
+    <p>
+        Incoming messages should contain a main <code>configStore</code> object.
+        Each config block inside it should have its own name.
+    </p>
+
+    <pre>{
+  "configStore": {
+    "mainScheduler": {
+      "type": "scheduler",
+      "data": []
+    },
+    "pumpSetpoints": {
+      "type": "setpoints",
+      "data": {
+        "startLevel": 30,
+        "stopLevel": 80
+      }
+    }
+  }
+}</pre>
+
+    <h3>Scheduler Config</h3>
+
+    <p>
+        Scheduler blocks use <code>type: "scheduler"</code>.
+    </p>
+
+    <pre>{
+  "configStore": {
+    "mainScheduler": {
+      "type": "scheduler",
+      "data": [
+        {
+          "name": "Pump 1 Morning Run",
+          "output": "output1",
+          "controlType": "schedule",
+          "mode": "Auto Schedule",
+          "days": ["mon", "tue", "wed", "thu", "fri"],
+          "startHour": 6,
+          "startMinute": 0,
+          "runHour": 1,
+          "runMinute": 30
+        }
+      ]
+    }
+  }
+}</pre>
+
+    <h3>Control Config</h3>
+
+    <p>
+        Control entries can use live input values and stored setpoints.
+    </p>
+
+    <pre>{
+  "name": "Tank Level Control",
+  "output": "output1",
+  "controlType": "control",
+  "mode": "AUTO",
+  "variable": "tank_level",
+  "lowSetpointKey": "pumpSetpoints.data.startLevel",
+  "highSetpointKey": "pumpSetpoints.data.stopLevel",
+  "direction": "in"
+}</pre>
+
+    <h3>Config Name</h3>
+
+    <p>
+        Leave <b>Config Name</b> blank to allow all config blocks.
+    </p>
+
+    <p>
+        Enter a name such as <code>mainScheduler</code> if this node should only use one config block.
+    </p>
+
+    <h3>Outputs</h3>
+
+    <p>
+        The node has 24 outputs.
+    </p>
+
+    <p>
+        Scheduler and control items use output names such as:
+    </p>
+
+    <pre>output1
+output2
+output3</pre>
+
+    <p>
+        If multiple schedule/control entries use the same output, they are combined using OR logic.
+        If any entry wants the output ON, the final output is ON.
+    </p>
+
+    <h3>Local Storage</h3>
+
+    <p>
+        Config is saved locally on the gateway. If Node-RED restarts, the last saved config is loaded again.
+    </p>
+
+    <h3>Output Mode</h3>
+
+    <ul>
+        <li><b>Only when output changes</b>: sends an output only when the final state changes.</li>
+        <li><b>Every check</b>: sends outputs every check cycle.</li>
+    </ul>
+
+    <h3>Config Output</h3>
+
+    <p>
+        Optional. Select an output if you want the full stored config sent out as a message.
+    </p>
+</script>