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

A set of nodes for the UHPPOTE Wiegand Access Controller

<script type="text/html" data-template-name="uhppoted-set-time-profile">
    <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-time-profile">
    <p>Creates or updates a time profile on a UHPPOTE 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 profile for 'set-time-profile'</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 profile definition for the time profile to be created or updated</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>profile.id<span class="property-type">uint8</span></dt>
        <dd>Time profile ID (2-254)</dd>
        <dt>profile.valid.from<span class="property-type">date</span></dt>
        <dd>start date (inclusive) from which profile is enabled</d>
        <dt>profile.valid.to<span class="property-type">date</span></dt>
        <dd>end date (incusive) after which profile is no longer enabled</d>
        <dt>profile.weekdays<span class="property-type">array of string</span></dt>
        <dd>List of weekdays on which the profile is active</d>
        <dt>profile.segments<span class="property-type">array of segment</span></dt>
        <dd>List of up to 3 time segments for which the profile is active</d>
        <dt>profile.linkedTo<span class="property-type">uint8</span></dt>
        <dd>Linked time profile (optional)</d>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "profile": {
        "id": 29, 
        "from": "2021-01-01",
        "to": "2021-12-31",
        "weekdays": "Monday,Wednesday,Friday",
        "segments": [
            { "start": "08:30", end: "11:45" },
            { "start": "13:15", end: "18:00" },
        ],
        "linkedTo": 3
    }
  }</pre>
    <pre>
  {
    "controller": {
        "controller": 405419896,
        "address": "192.168.1.100",
        "protocol": "tcp"
    },
    "profile": {
        "id": 29, 
        "from": "2021-01-01",
        "to": "2021-12-31",
        "weekdays": "Monday,Wednesday,Friday",
        "segments": [
            { "start": "08:30", end: "11:45" },
            { "start": "13:15", end: "18:00" },
        ],
        "linkedTo": 3
    }
  }</pre>

    <p>The output is a JSON object containing the result of creating/updating the time profile.</p>
    <dl class="message-properties">
        <dt>deviceId<span class="property-type">uint32</span></dt>
        <dd>controller serial number</dd>
        <dt>profileID<span class="property-type">uint8</span></dt>
        <dd>profile ID [2..254]</dd>
        <dt>updated<span class="property-type">boolean</span></dt>
        <dd>true if the profile was updated successfully</dd>
    </dl>
    <h4>Example:</h4>
    <pre>
  {
    "deviceId": 405419896,
    "profileId": 29,
    "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/node-red-contrib-uhppoted">node-red-contrib-uhppoted</a>: GitHub project</li>
    </ul>
</script>