node-red-contrib-uhppoted/nodes/locales/en-US/uhppoted-get-devices.html

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-get-devices">
    <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>
    <div class="form-row">
        <label for="node-input-topic"><i class="fa fa-tag"></i>Topic</label>
        <input type="text" id="node-input-topic" placeholder="Message topic" />
    </div>
    <div class="form-row">
        <label for="node-input-config"><i class="fa fa-tag"></i>Configuration</label>
        <input id="node-input-config" />
    </div>
</script>

<script type="text/html" data-help-name="uhppoted-get-devices">
    <p>Searches for UHPPOTE access controllers on the local LAN.</p>

    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>payload<span class="property-type">object</span></dt>
        <dd>empty JSON object (used to trigger the search)</dd>
        <dt class="optional">topic<span class="property-type">string</span></dt>
        <dd>identifying message topic for output</dd>
    </dl>

    <h3>Outputs</h3>
    <dl class="message-properties">
        <dt>payload<span class="property-type">object</span></dt>
        <dd>JSON object containing a list of the 'found' controllers</dd>
        <dt>topic<span class="property-type">string</span></dt>
        <dd>message topic copied from input</dd>
    </dl>

    <h3>Details</h3>
    <p>The input <code>message</code> is used only as a trigger for the search - the
    <code>payload</code> can be any valid JSON object (an empty <code>{}</code> is 
    sufficient).</p>
    <p>The output <code>msg.payload</code> is a JSON object containing the list of
    UHPPOTE controllers that responded to the 'search' query. The entry for
    each controller contains:</p>
    <dl class="message-properties">
        <dt>device.deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>device.address<span class="property-type">IPv4 address</span></dt>
        <dd>controller IPv4 address</d>
        <dt>device.netmask<span class="property-type">IPv4 netmask</span></dt>
        <dd>controller IPv4 subnet mask</dd>
        <dt>device.gateway<span class="property-type">IPv4 address</span></dt>
        <dd>controller IPv4 gateway</dd>
        <dt>device.MAC<span class="property-type">IPv4 MAC addresst</span></dt>
        <dd>controller MAC address</dd>
        <dt>device.version<span class="property-type">string</span></dt>
        <dd>controller firmware version</dd>
        <dt>device.date<span class="property-type">date</span></dt>
        <dd>current controller date, formatted as YYYY-mm-dd</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  [
    {
      "device": {
        "id": 303986753,
        "address": "192.168.1.100",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "MAC": "52:fd:fc:07:21:82",
        "version": "0892",
        "date": "2020-08-19"
      }
    },
    {
      "device": {
        "id": 405419896,
        "address": "192.168.1.100",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "MAC": "00:12:23:34:45:56",
        "version": "0892",
        "date": "2020-08-19"
      }
    }
  ]</pre>
    
    <h3>References</h3>
    <ul>
        <li><a href="https://github.com/uhppoted">uhppoted</a>: GitHub umbrella project</li>
        <li><a href="https://github.com/uhppoted/uhppoted-lib-node-red">uhppoted-lib-node-red</a>: GitHub project</li>
    </ul>
</script>