iot-command-send.html

<!--
Copyright 2020 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<script type="text/x-red" data-template-name="google-cloud-iot command-send">
    <div class="form-row">
        <label for="node-input-account"><i class="fa fa-user"></i> Credentials</label>
        <input type="text" id="node-input-account">
    </div>
    <div class="form-row">
        <label for="node-input-keyFilename"><i class="fa fa-user"></i> Key File</label>
        <input type="text" id="node-input-keyFilename">
    </div>
    <div class="form-row">
        <label for="node-input-projectId"><i class="fa fa-cloud"></i> Project ID</label>
        <input type="text" id="node-input-projectId">
    </div>
    <div class="form-row">
        <label for="node-input-region"><i class="fa fa-globe"></i> Region</label>
        <input type="text" id="node-input-region">
    </div>
    <div class="form-row">
        <label for="node-input-registryId"><i class="fa fa-book"></i> Registry ID</label>
        <input type="text" id="node-input-registryId">
    </div>
    <div class="form-row">
        <label for="node-input-deviceId"><i class="fa fa-microchip"></i> Device ID</label>
        <input type="text" id="node-input-deviceId">
    </div> 
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name">
    </div>
</script>

<script type="text/x-red" data-help-name="google-cloud-iot command-send">
    <p>Send a command message to an IoT device.</p>
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>msg.gcp.projectId
            <span class="property-type">string</span>
        </dt>
        <dd>The project id hosting the registry of devices.</dd>

        <dt>msg.gcp.region
            <span class="property-type">string</span>
        </dt>
        <dd>The region in which the registry is defined..</dd>
        
        <dt>msg.gcp.registryId
            <span class="property-type">string</span>
        </dt>
        <dd>The identity of the registry.</dd>

        <dt>msg.gcp.deviceId
            <span class="property-type">string</span>
        </dt>
        <dd>The identity of the device.</dd>
    </dl>

    <h3>Details</h3>
    
    <p>
        The GCP IoT Core allows one to send a command to a connected IoT device.  The IoT - Send Command node encapsulates this function.
        In order to send a command to an IoT device, we need to identify that device.  The properties to identify it are the combination of:
        <ul>
            <li>project id - The project hosting the registry.</li>
            <li>region - The region in which the registry is defined.</li>
            <li>registry id - The identity of the registry.</li>
            <li>device id - The identity of the device.</li>
        </ul>
    </p>
    <p>
        With those defined, we can then send a payload.  To use this node, each of these must be supplied.
        We can supply values statically through the node's specific configuration or dynamically in the incoming message.
        For a dynamic invocation, we supply:
        <ul>
            <li>msg.gcp.projectId</li>
            <li>msg.gcp.region</li>
            <li>msg.gcp.registryId</li>
            <li>msg.gcp.deviceId</li>
        </ul>
    </p>
    <p>
        For the projectId and region, if one or both of those are not found, then we test to see if Node-RED is itself running on GCP and use
        the values retrieved from the compute engine metadata.
        The content of the send command that is sent to the device will be retrieved from msg.payload.
    </p>
</script>

<script type="text/javascript">
RED.nodes.registerType("google-cloud-iot command-send", {
    category: "GCP",
    defaults: {
        account: { type: "google-cloud-credentials", required: false },
        keyFilename: {value: "", required: false },
        projectId: { required: false },
        region: { required: false },
        registryId: { required: false },
        deviceId: { required: false },
        name: { value: "", required: false }
    },
    inputs: 1,
    outputs: 1,
    icon: "iot.png",
    align: "left",
    color: "#3FADB5",
    label: function () {
        return this.name || this.topic || "iot command-send";
    },
    paletteLabel: "iot command send"
});
</script>