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

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-activate-keypads">
    <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-activate-keypads">
    <p>Activates or deactivates a controller reader access keypads.</p>

    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>payload<span class="property-type">object</span></dt>
        <dd>JSON object with the controller ID and activated keypads</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 with the succeeded/failed result</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>msg.payload</code> is a JSON object identifying the destination controller
       and the activated keypads.</p>
    <p>The controller is identified by specifying either the (legacy) 'deviceId' or the composite
       'controller' object which supports both UDP and TCP connections. Defaults to broadcast UDP if
       the address or protocol are not valid.</p>
    <dl class="message-properties">
        <dt>deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>controller.id<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>controller.address<span class="property-type">string</span></dt>
        <dd>controller IPv4 address</dd>
        <dt>controller.protocol<span class="property-type">string</span></dt>
        <dd>controller connection protocol ('udp' or 'tcp')</dd>
        <dt>keypads<span class="property-type">uint8</span></dt>
        <dd>Activated keypads</dd>
        <dt>keypads.1<span class="property-type">boolean</span></dt>
        <dd>Reader 1 keypad active</dd>
        <dt>keypads.2<span class="property-type">boolean</span></dt>
        <dd>Reader 2 keypad active</dd>
        <dt>keypads.3<span class="property-type">boolean</span></dt>
        <dd>Reader 3 keypad active</dd>
        <dt>keypads.4<span class="property-type">boolean</span></dt>
        <dd>Reader 4 keypad active</dd>
        </dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "keypads": {
        1: true,
        2: true,
        3: false,
        4: true
    }
  }</pre>
    <pre>
  {
    "controller": {
        "controller": 405419896,
        "address": "192.168.1.100",
        "protocol": "tcp"
    },
    "keypads": {
        1: true,
        2: true,
        3: false,
        4: true
    }
  }</pre>

    <p>The output is a JSON object containing the success/failure result for setting the controller
    door interlock mode.</p>
    <dl class="message-properties">
        <dt>deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>keypads<span class="property-type">uint8</span></dt>
        <dd>activated keypads, from input</dd>
        <dt>updated<span class="property-type">boolean</span></dt>
        <dd>true if the keypads were successfully activated/deactivated</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "keypads": {
        1: true,
        2: true,
        3: false,
        4: true
    },
    "updated": true
  }</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>