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

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-get-antipassback">
    <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-antipassback">
    <p>Retrieves the controller anti-passback mode.</p>

    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>payload<span class="property-type">object</span></dt>
        <dd>JSON object with the controller ID for 'get-antipassback'</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 controller anti-passback code and mode.</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.</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>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896
  }</pre>
    <pre>
  {
    "controller": {
        "controller": 405419896,
        "address": "192.168.1.100",
        "protocol": "tcp"
    }
  }</pre>

    <p>The output <code>msg.payload</code> is a JSON object containing the anti-passback code and
    mode from the UHPPOTE controller with 
    serial number matching the request:</p>
    <dl class="message-properties">
        <dt>deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>antipassback.code<span class="property-type">uint8</span></dt>
        <dd>Numeric code for anti-passback mode (0: disabled, 1:(1:2);3:4), 2:(1,3):2,4), 3:1:(2,3),4:1:(2,3,4)</dd>
        <dt>antipassback.mode<span class="property-type">string</span></dt>
        <dd>Numeric code for door control state (normally open:1, normally closed:2, controlled:3)</dd>
        <dd>'disabled', '(1:2);(3:4)', '(1,3):(2,4)', '1:(2,3)', '1:(2,3,4)'' or 'unknown'</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "antipassback": {
        code: 2, 
        mode: "(1,3):(2,4)"
      }
    }
  }</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>