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

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-config">
    <div class="form-row">
        <label for="node-config-input-name"><i class="fa fa-tag"></i>Name</label>
        <input type="text" id="node-config-input-name" placeholder="Name" />
    </div>
    <div class="form-row">
        <label for="node-config-input-timeout"><i class="fa fa-tag"></i>Timeout</label>
        <input type="text" id="node-config-input-timeout" placeholder="5000" />
    </div>
    <div class="form-row">
        <label for="node-config-input-bind"><i class="fa fa-tag"></i>Bind address</label>
        <input type="text" id="node-config-input-bind" placeholder="0.0.0.0" />
    </div>
    <div class="form-row">
        <label for="node-config-input-broadcast"><i class="fa fa-tag"></i>Broadcast address</label>
        <input type="text" id="node-config-input-broadcast" placeholder="255.255.255.255" />
    </div>
    <div class="form-row">
        <label for="node-config-input-listen"><i class="fa fa-tag"></i>Listen address</label>
        <input type="text" id="node-config-input-listen" placeholder="0.0.0.0:60000" />
    </div>
    <div class="form-row">
        <label for="node-config-input-debug"><i class="fa fa-tag"></i>Debug</label>
        <input type="checkbox" id="node-config-input-debug" placeholder="false" />
    </div>
    <div class="form-row">
        <label for="node-config-input-controllers-editor"><i class="fa fa-tag"></i>Controllers</label>
        <table id="node-config-input-controllers-editor" style="margin-left:16px; border:none; border-collapse:collapse;">
            <thead>
                <tr style="border:none;">
                    <th style="font-weight: normal; font-style:italic; border:1px solid grey;">controller</th>
                    <th style="font-weight: normal; font-style:italic; border:1px solid grey;">address:port</th>
                    <th style="font-weight: normal; font-style:italic; border:1px solid grey; padding-left:8px; padding-right:8px;">broadcast</th>
                    <th style="border:none"><i id="add" class="fa fa-plus fa-1x" style="padding:2px 4px 2px 4px;"></i></th>
                </tr>
            </thead>
            <tbody />
            <tfoot>
              <tr>
                <td colspan="4">
                  <br/>
                  <b>NOTE:</b><br/>
                  <em>As of version 1.1.8, the controller list is the config is being deprecated in favour of passing a 
                      controller object to the uhppoted function. The controllers list will continue to be supported 
                      until at least the next major release, but please consider updating to using controller objects.</em>
                </td>
              </tr>
            </tfoot>
        </table>
    </div>
</script>

<script type="text/html" data-help-name="uhppoted-config">
    <p>Configuration node for shared node properties.</p>

    <h3>Properties</h3>
    <dl class="message-properties">
        <dt>name<span class="property-type">string</span></dt>
        <dd>Configuration name</dd>
        <dt>timeout<span class="property-type">uint32</span></dt>
        <dd>Maximum time (in milliseconds) to wait for a reply. Defaults to 5000ms</dd>
        <dt>bind<span class="property-type">IPv4 address</span></dt>
        <dd>IPv4 address to which to bind on systems which have multiple interfaces. Defaults to 0.0.0.0</dd>
        <dt>broadcast<span class="property-type">IPv4 address</span></dt>
        <dd>IPv4 address to which to broadcast UDP messages. Defaults to 255.255.255.255</dd>
        <dt>listen<span class="property-type">address:port</span></dt>
        <dd>IPv4 address and port on which to listen for controller events. Defaults to 0.0.0.0:60000</dd>
        <dt>controllers<span class="property-type">array</span></dt>
        <dd>List of access controllers with specific IP addresses</dd>
        <dt>debug<span class="property-type">boolean</span></dt>
        <dd>Enables logging controller requests/responses to the console</dd>
    </dl>

    <h3>Details</h3>
    <p><code>bind</code> and <code>broadcast</code> configuration values are not generally required
    for operation on the local LAN, unless the host has multiple interfaces and it is desirable to 
    restrict UDP broadcasts to a single interface. Access controllers that are not on the local LAN
    will not receive UDP broadcasts and it is necessary to specify the actual IP address of the
    controller for requests.</p>

    <p>Checking the <code>broadcast</code> flag for a controller forces the nodes to use UDP broadcast 
    messages to that controller IP address. In general this should not be checked as the nodes should 
    be able differentiate normal IP addresses from broadcast addresses, but is provided to support 
    non-standard network configurations</p>

    <p>The <code>listen</code> <code>address:port</code> configuration values should match the 
    configuration used by the access controllers (as configured with <code>set-listen-address</code>).

    <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>