UNPKG

@gravypower/node-red-franklinwh

Version:

Node-RED node to control FranklinWH gateway

64 lines (57 loc) 2.12 kB
<script type="text/javascript"> RED.nodes.registerType('franklinwh-get-reserve',{ category: 'FranklinWH', color: '#3399ff', defaults: { server: {type:"franklinwh-config", required:true}, name: {value:""} }, inputs:1, outputs:1, icon: "font-awesome/fa-battery-half", label: function() { return this.name||"get reserve"; } }); </script> <script type="text/html" data-template-name="franklinwh-get-reserve"> <div class="form-row"> <label for="node-input-server"><i class="fa fa-server"></i> Server</label> <input type="text" id="node-input-server"> </div> <div class="form-row"> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <input type="text" id="node-input-name" placeholder="Name"> </div> </script> <script type="text/html" data-help-name="franklinwh-get-reserve"> <p>A node to get the FranklinWH battery reserve percentage.</p> <h3>Inputs</h3> <dl class="message-properties"> <dt>payload <span class="property-type">any</span> </dt> <dd>Any input will trigger the reserve percentage request.</dd> </dl> <h3>Outputs</h3> <dl class="message-properties"> <dt>payload <span class="property-type">object</span> </dt> <dd> An object containing: <ul> <li><code>reserve</code> - number (percentage of battery reserve, between 5 and 100)</li> </ul> </dd> </dl> <h3>Details</h3> <p>This node retrieves the current battery reserve setting from your FranklinWH system. The reserve setting determines how much battery capacity is kept in reserve for backup purposes.</p> <h3>Notes</h3> <ul> <li>The reserve value is a percentage between 5% and 100%</li> <li>A higher reserve means more battery capacity is saved for backup</li> <li>A lower reserve allows more battery capacity to be used for daily cycling</li> </ul> </script>