node-red-contrib-uhppoted/nodes/locales/en-US/uhppoted-get-card-by-index.html

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-get-card-by-index">
    <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-card-by-index">
    <p>Retrieves a card record from an access controller.</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 record index for 'get-card-by-index'</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">
        Card record:
        <dt>payload<span class="property-type">object</span></dt>
        <dd>JSON object with the card record</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
    record index for the card to be retrieved.</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>index<span class="property-type">uint32</span></dt>
        <dd>card record number</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896
    "index": 13728
  }</pre>
    <pre>
  {
    "controller": {
        "controller": 405419896,
        "address": "192.168.1.100",
        "protocol": "tcp"
    },
    "index": 13728
  }</pre>

    <p>The output <code>msg.payload</code> is a JSON object containing the card status and card record retrieved 
    from the access controller.</p>
    <dl class="message-properties">
        <dt>deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>index<span class="property-type">uint32</span></dt>
        <dd>record index</dd>
        <dt>status.code<span class="property-type">uint32</span></dt>
        <dd><ul><li>0: ok</li><li>1: card not found</li><li>2: card deleted</li></dd>
        <dt>status.message<span class="property-type">string</span></dt>
        <dd>Internationalized message corresponding to the error code</dd>
        <dt>card.number<span class="property-type">uint32</span></dt>
        <dd>card number</d>
        <dt>card.valid.from<span class="property-type">date</span></dt>
        <dd>start date (inclusive) from which card is valid</d>
        <dt>card.valid.to<span class="property-type">date</span></dt>
        <dd>end date (incusive) until which card is valid</d>
        <dt>card.doors.1<span class="property-type">boolean</span></dt>
        <dd>true if the card number has access to door 1</d>
        <dt>card.doors.2<span class="property-type">boolean</span></dt>
        <dd>true if the card number has access to door 2</d>
        <dt>card.doors.3<span class="property-type">boolean</span></dt>
        <dd>true if the card number has access to door 3</d>
        <dt>card.doors.4<span class="property-type">boolean</span></dt>
        <dd>true if the card number has access to door 4</d>
        <dt>card.PIN<span class="property-type">uint32</span></dt>
        <dd>card keypad PIN (in the range [0..999999]</d>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "index": 13728,
    "status": {
        "code": 0,
        "message": "card ok"
    }    
    "card": {
        "number": 61532836,
        "valid": {
            "from": "2020-01-01",
            "to": "2020-12-31",
        },
        "doors": {
            1: true,
            2: false,
            3: false,
            4: true
        },
        PIN: 7531
    }
  }</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>