node-red-contrib-lorawan-bacnet-server 1.2.0

package/nodes/bacnet-point/bacnet-point.html

@@ -0,0 +1,403 @@
+<script type="text/javascript">
+  RED.nodes.registerType('bacnet-point', {
+    category: 'BACnet',
+    color: '#3FADB5',
+    icon: 'font-awesome/fa-dot-circle-o',
+    defaults: {
+      name: { value: '' },
+      server: { value: '', type: 'bacnet-server', required: true },
+      objectType: { value: 'analogValue', required: true },
+      instanceNumber: { value: 0, required: true, validate: RED.validators.number() },
+      objectName: { value: '', required: true },
+      initialValue: { value: 0 },
+      units: { value: '' },
+      description: { value: '' },
+      writable: { value: true },
+      usePriorityArray: { value: false },
+      relinquishDefault: { value: 0 },
+      covIncrement: { value: 0 },
+      numberOfStates: { value: 3 },
+      stateText: { value: '' },
+      outputOnRead: { value: false },
+      outputOnWrite: { value: true },
+      outputOnCov: { value: false }
+    },
+    inputs: 1,
+    outputs: 1,
+    label: function () {
+      if (this.name) return this.name;
+      var typeLabels = {
+        'analogInput': 'AI',
+        'analogOutput': 'AO',
+        'analogValue': 'AV',
+        'binaryInput': 'BI',
+        'binaryOutput': 'BO',
+        'binaryValue': 'BV',
+        'multiStateValue': 'MSV'
+      };
+      var typeLabel = typeLabels[this.objectType] || this.objectType;
+      return typeLabel + ':' + this.instanceNumber;
+    },
+    paletteLabel: 'bacnet point',
+    oneditprepare: function () {
+      var node = this;
+
+      // Toggle visibility based on object type
+      function updateVisibility() {
+        var objectType = $('#node-input-objectType').val();
+        var isAnalog = objectType.startsWith('analog');
+        var isBinary = objectType.startsWith('binary');
+        var isMsv = objectType === 'multiStateValue';
+        var isCommandable = ['analogOutput', 'analogValue', 'binaryOutput', 'binaryValue'].includes(objectType);
+
+        // Units field - only for analog types
+        if (isAnalog) {
+          $('#units-row').show();
+        } else {
+          $('#units-row').hide();
+        }
+
+        // Priority array - only for commandable types
+        if (isCommandable) {
+          $('#priority-array-row').show();
+          updatePriorityArrayOptions();
+        } else {
+          $('#priority-array-row').hide();
+          $('#relinquish-default-row').hide();
+        }
+
+        // MSV-specific options
+        if (isMsv) {
+          $('#msv-options').show();
+        } else {
+          $('#msv-options').hide();
+        }
+
+        // Initial value type hint
+        if (isBinary) {
+          $('#initial-value-hint').text('0 (inactive) or 1 (active)');
+        } else if (isMsv) {
+          $('#initial-value-hint').text('State number (1 to Number of States)');
+        } else {
+          $('#initial-value-hint').text('Numeric value');
+        }
+      }
+
+      function updatePriorityArrayOptions() {
+        var usePriorityArray = $('#node-input-usePriorityArray').prop('checked');
+        if (usePriorityArray) {
+          $('#relinquish-default-row').show();
+        } else {
+          $('#relinquish-default-row').hide();
+        }
+      }
+
+      // Auto-generate object name if empty
+      function generateObjectName() {
+        var objectType = $('#node-input-objectType').val();
+        var instanceNumber = $('#node-input-instanceNumber').val();
+        var currentName = $('#node-input-objectName').val();
+
+        if (!currentName || currentName === '' || currentName.match(/^[A-Za-z]+_\d+$/)) {
+          var typeName = objectType.replace(/([A-Z])/g, '_$1').replace(/^_/, '');
+          $('#node-input-objectName').val(typeName + '_' + instanceNumber);
+        }
+      }
+
+      // Event handlers
+      $('#node-input-objectType').on('change', function () {
+        updateVisibility();
+        generateObjectName();
+      });
+
+      $('#node-input-instanceNumber').on('change', function () {
+        generateObjectName();
+      });
+
+      $('#node-input-usePriorityArray').on('change', function () {
+        updatePriorityArrayOptions();
+      });
+
+      // Validate instance number
+      $('#node-input-instanceNumber').on('change', function () {
+        var val = parseInt($(this).val());
+        if (isNaN(val) || val < 0 || val > 4194302) {
+          RED.notify('Instance number must be between 0 and 4194302', 'error');
+          $(this).val(0);
+        }
+      });
+
+      // Initialize visibility
+      updateVisibility();
+
+      // Generate name if empty on load
+      if (!node.objectName) {
+        generateObjectName();
+      }
+    },
+    oneditsave: function () {
+      // Validate configuration
+      var objectType = $('#node-input-objectType').val();
+      var instanceNumber = parseInt($('#node-input-instanceNumber').val());
+
+      if (instanceNumber < 0 || instanceNumber > 4194302) {
+        RED.notify('Instance number must be between 0 and 4194302', 'error');
+        return false;
+      }
+    }
+  });
+</script>
+
+<script type="text/html" data-template-name="bacnet-point">
+  <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="Optional display name">
+  </div>
+
+  <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">
+    <h4><i class="fa fa-cube"></i> Object Configuration</h4>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-objectType"><i class="fa fa-puzzle-piece"></i> Object Type</label>
+    <select id="node-input-objectType" style="width: 200px;">
+      <option value="analogInput">Analog Input (AI)</option>
+      <option value="analogOutput">Analog Output (AO)</option>
+      <option value="analogValue">Analog Value (AV)</option>
+      <option value="binaryInput">Binary Input (BI)</option>
+      <option value="binaryOutput">Binary Output (BO)</option>
+      <option value="binaryValue">Binary Value (BV)</option>
+      <option value="multiStateValue">Multi-State Value (MSV)</option>
+    </select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-instanceNumber"><i class="fa fa-hashtag"></i> Instance</label>
+    <input type="number" id="node-input-instanceNumber" min="0" max="4194302" style="width: 100px;">
+    <span class="form-tips" style="margin-left: 10px;">Unique identifier (0-4194302)</span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-objectName"><i class="fa fa-bookmark"></i> Object Name</label>
+    <input type="text" id="node-input-objectName" placeholder="Auto-generated if empty">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-description"><i class="fa fa-align-left"></i> Description</label>
+    <input type="text" id="node-input-description" placeholder="Optional description">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-initialValue"><i class="fa fa-pencil"></i> Initial Value</label>
+    <input type="number" id="node-input-initialValue" step="any" style="width: 100px;">
+    <span id="initial-value-hint" class="form-tips" style="margin-left: 10px;">Numeric value</span>
+  </div>
+
+  <div class="form-row" id="units-row">
+    <label for="node-input-units"><i class="fa fa-balance-scale"></i> Units</label>
+    <select id="node-input-units" style="width: 200px;">
+      <option value="">No units</option>
+      <optgroup label="Temperature">
+        <option value="62">degrees-Celsius</option>
+        <option value="64">degrees-Fahrenheit</option>
+        <option value="63">degrees-Kelvin</option>
+      </optgroup>
+      <optgroup label="Pressure">
+        <option value="133">pascals</option>
+        <option value="56">bars</option>
+        <option value="57">pounds-per-square-inch</option>
+      </optgroup>
+      <optgroup label="Flow">
+        <option value="84">liters-per-second</option>
+        <option value="85">liters-per-minute</option>
+        <option value="142">cubic-meters-per-second</option>
+        <option value="86">cubic-meters-per-hour</option>
+      </optgroup>
+      <optgroup label="Energy/Power">
+        <option value="48">watts</option>
+        <option value="49">kilowatts</option>
+        <option value="45">kilojoules</option>
+        <option value="116">watt-hours</option>
+        <option value="53">kilowatt-hours</option>
+      </optgroup>
+      <optgroup label="Electrical">
+        <option value="5">amperes</option>
+        <option value="2">milliamperes</option>
+        <option value="122">volts</option>
+        <option value="123">kilovolts</option>
+        <option value="39">ohms</option>
+        <option value="121">power-factor</option>
+      </optgroup>
+      <optgroup label="Time">
+        <option value="73">seconds</option>
+        <option value="72">minutes</option>
+        <option value="71">hours</option>
+        <option value="70">days</option>
+      </optgroup>
+      <optgroup label="Humidity">
+        <option value="29">percent-relative-humidity</option>
+        <option value="28">percent</option>
+      </optgroup>
+      <optgroup label="Other">
+        <option value="95">no-units</option>
+        <option value="28">percent</option>
+        <option value="118">parts-per-million</option>
+        <option value="143">grams</option>
+        <option value="38">kilograms</option>
+        <option value="65">meters</option>
+        <option value="66">centimeters</option>
+        <option value="67">millimeters</option>
+        <option value="88">feet</option>
+      </optgroup>
+    </select>
+  </div>
+
+  <div id="msv-options">
+    <div class="form-row">
+      <label for="node-input-numberOfStates"><i class="fa fa-list-ol"></i> Number of States</label>
+      <input type="number" id="node-input-numberOfStates" min="2" max="255" style="width: 80px;">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-stateText"><i class="fa fa-list"></i> State Text</label>
+      <input type="text" id="node-input-stateText" placeholder="State1, State2, State3">
+      <span class="form-tips" style="margin-left: 10px;">Comma-separated labels</span>
+    </div>
+  </div>
+
+  <div class="form-row">
+    <h4><i class="fa fa-cogs"></i> Behavior</h4>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-writable" style="width: auto; margin-right: 10px;">
+      <input type="checkbox" id="node-input-writable" style="width: auto; margin: 0;">
+      Writable
+    </label>
+    <span class="form-tips">Allow external BACnet clients to write to this point</span>
+  </div>
+
+  <div class="form-row" id="priority-array-row">
+    <label for="node-input-usePriorityArray" style="width: auto; margin-right: 10px;">
+      <input type="checkbox" id="node-input-usePriorityArray" style="width: auto; margin: 0;">
+      Use Priority Array
+    </label>
+    <span class="form-tips">Enable 16-level priority array (for commandable objects)</span>
+  </div>
+
+  <div class="form-row" id="relinquish-default-row" style="display: none;">
+    <label for="node-input-relinquishDefault"><i class="fa fa-undo"></i> Relinquish Default</label>
+    <input type="number" id="node-input-relinquishDefault" step="any" style="width: 100px;">
+    <span class="form-tips" style="margin-left: 10px;">Value when all priorities are null</span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-covIncrement"><i class="fa fa-exchange"></i> COV Increment</label>
+    <input type="number" id="node-input-covIncrement" step="any" min="0" style="width: 100px;">
+    <span class="form-tips" style="margin-left: 10px;">Threshold for COV notifications (0 = any change)</span>
+  </div>
+
+  <div class="form-row">
+    <h4><i class="fa fa-arrow-right"></i> Output Options</h4>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputOnRead" style="width: auto; margin-right: 10px;">
+      <input type="checkbox" id="node-input-outputOnRead" style="width: auto; margin: 0;">
+      Output on Read
+    </label>
+    <span class="form-tips">Emit message when external client reads this point</span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputOnWrite" style="width: auto; margin-right: 10px;">
+      <input type="checkbox" id="node-input-outputOnWrite" style="width: auto; margin: 0;">
+      Output on Write
+    </label>
+    <span class="form-tips">Emit message when external client writes to this point</span>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputOnCov" style="width: auto; margin-right: 10px;">
+      <input type="checkbox" id="node-input-outputOnCov" style="width: auto; margin: 0;">
+      Output on COV
+    </label>
+    <span class="form-tips">Emit message when value changes (internal use)</span>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="bacnet-point">
+  <p>Represents a BACnet object (point) that is exposed through the BACnet Server.</p>
+
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">number | object</span></dt>
+    <dd>The new value for the point. Can be:
+      <ul>
+        <li>A simple number/boolean for direct value update</li>
+        <li>An object with <code>value</code> and optional <code>priority</code> (1-16)</li>
+      </ul>
+    </dd>
+    <dt class="optional">bacnet.priority <span class="property-type">number</span></dt>
+    <dd>Priority level (1-16) for priority array updates. 1 = highest priority.</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">number</span></dt>
+    <dd>The current value of the point.</dd>
+    <dt>topic <span class="property-type">string</span></dt>
+    <dd>The object name.</dd>
+    <dt>bacnet <span class="property-type">object</span></dt>
+    <dd>BACnet metadata:
+      <ul>
+        <li><code>event</code>: 'read', 'write', or 'cov'</li>
+        <li><code>objectType</code>: Object type name</li>
+        <li><code>objectTypeId</code>: BACnet object type number</li>
+        <li><code>instanceNumber</code>: Object instance</li>
+        <li><code>priority</code>: Write priority (for write events)</li>
+        <li><code>source</code>: Source address (for write events)</li>
+      </ul>
+    </dd>
+  </dl>
+
+  <h3>Object Types</h3>
+  <table>
+    <tr><th>Type</th><th>Code</th><th>Use Case</th></tr>
+    <tr><td>Analog Input (AI)</td><td>0</td><td>Sensor readings (read-only)</td></tr>
+    <tr><td>Analog Output (AO)</td><td>1</td><td>Setpoints (commandable)</td></tr>
+    <tr><td>Analog Value (AV)</td><td>2</td><td>Calculated/stored values</td></tr>
+    <tr><td>Binary Input (BI)</td><td>3</td><td>Status/alarms (read-only)</td></tr>
+    <tr><td>Binary Output (BO)</td><td>4</td><td>On/Off control (commandable)</td></tr>
+    <tr><td>Binary Value (BV)</td><td>5</td><td>Boolean states</td></tr>
+    <tr><td>Multi-State Value (MSV)</td><td>19</td><td>Enumerated states</td></tr>
+  </table>
+
+  <h3>Priority Array</h3>
+  <p>Commandable objects (AO, AV, BO, BV) can use a 16-level priority array.
+  Higher priority commands (lower numbers) override lower priority commands.
+  When all slots are null, the <b>Relinquish Default</b> value is used.</p>
+
+  <p>To relinquish a priority, send a message with <code>payload: null</code>
+  and the desired <code>priority</code>.</p>
+
+  <h3>COV (Change of Value)</h3>
+  <p>External BACnet clients can subscribe to value changes. The <b>COV Increment</b>
+  defines the minimum change required to trigger a notification. For binary objects,
+  any change triggers a notification.</p>
+
+  <h3>Example - Update Value</h3>
+  <pre>msg.payload = 23.5;</pre>
+
+  <h3>Example - Update with Priority</h3>
+  <pre>msg.payload = { value: 23.5, priority: 8 };</pre>
+
+  <h3>Example - Relinquish Priority</h3>
+  <pre>msg.payload = null;
+msg.bacnet = { priority: 8 };</pre>
+</script>