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

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-set-ip">
    <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-set-ip">
    <p>Sets the IP address, subnet mask and gateway address for 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 IPv4 configuration for 'set-ip'</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>Empty JSON object - the command does not return any useful information</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 IPv4 configuration information.</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>

    <p>The input <code>msg.payload</code> is a JSON object containing the serial number
    for the controller for which information should be retrieved</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>address<span class="property-type">IPv4 address</span></dt>
        <dd>IP address for controller</dd>
        <dt>netmask<span class="property-type">IPv4 netmask</span></dt>
        <dd>Subnet mask for controller</dd>
        <dt>gateway<span class="property-type">IPv4 address</span></dt>
        <dd>IP address for network gateway</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "address": "192.168.1.100",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1"
  }</pre>
    <pre>
  {
    "controller": {
        "controller": 405419896,
        "address": "192.168.1.100",
        "protocol": "tcp"
    },
    "address": "192.168.1.100",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1"
  }</pre>

    <p>The output <code>msg.payload</code> is an empty JSON object - the command does not return
    any information</p>
    <dl class="message-properties">
    </dl>
    <h4>Example:</h4>
    <pre>
  {
  }</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>