mqtt-flex.html

<script type="text/javascript">
    RED.nodes.registerType('mqtt-flex-connect',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:1,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-connect";
        }
    });

    RED.nodes.registerType('mqtt-flex-disconnect',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:0,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-disconnect";
        }
    });

    RED.nodes.registerType('mqtt-flex-subscribe',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:1,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-subscribe";
        }
    });

    RED.nodes.registerType('mqtt-flex-publish',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:1,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-publish";
        }
    });

    RED.nodes.registerType('mqtt-flex-unsubscribe',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:0,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-unsubscribe";
        }
    });

    RED.nodes.registerType('mqtt-flex-status',{
        category: 'network',
        color: "#e8bfd8",
        defaults: {
            name: {value:""}
        },
        inputs:1,
        outputs:1,
        icon: "bridge.svg",
        label: function() {
            return this.name||"mqtt-flex-status";
        }
    });

</script>

<script type="text/html" data-template-name="mqtt-flex-unsubscribe">
    <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>
</script>

<script type="text/html" data-help-name="mqtt-flex-subscribe">
    <p> Subscribes to a topic using an established client connection.<br/>
        Emitts received messages.</p>
    
    <h3>Inputs</h3>
        <dl class="message-properties">
            <dt>client_id
                <span class="property-type">string</span>
            </dt>
            <dd> The client id to be used for the Subscription.</dd>
            <dt>topic
                <span class="property-type">string</span>
            </dt>
            <dd> The topic to be subscribed.</dd>
        </dl>
    
     <h3>Outputs</h3>
        The node will emitt messages on every message that was received on subscribed topics.
        <dl class="message-properties">
            <dt>payload <span class="property-type">any</span></dt>
            <dd>The message payload as received.</dd>
            <dt>client_id<span class="property-type">string</span></dt>
            <dd>Id of the client the subscription belonged to.</dd>
            <dt>topic<span class="property-type">string</span></dt>
            <dd>topic at which the message was received.</dd>
        </dl>
    
    <h3>References</h3>
        <ul>
            <li><a href="https://github.com/promd/node-red-contrib-mqtt-flex">GitHub</a> - the nodes github repository</li>
        </ul>
</script>

<script type="text/html" data-template-name="mqtt-flex-subscribe">
    <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>
</script>

<script type="text/html" data-help-name="mqtt-flex-connect">
    <p>Connects to a MQTT broker and keeps track of the status.</p>
    
    <h3>Inputs</h3>
        <dl class="message-properties">
            <dt>payload <span class="property-type">object</span></dt>
            <dd> Contains settings required for the MQTT connection to be created.<br/>
                 The Module will automatically switch between mqtt:// and mqtts://, depending on the configured attributes.

                <dl class="message-properties">
                    <dt>client_id
                        <span class="property-type">string</span>
                    </dt>
                    <dd> The client id to be used for the MQTT connection.<br/>
                         This is also used as a unique identification of open clients.<br/>
                         Each distict Connection should have a separate client_id. </dd>
                    <dt>host
                        <span class="property-type">string</span>
                    </dt>
                    <dd> The hostname / ip of the MQTT broker.<br/>
                         Should include the port number if needed (= deviating from default)</dd>
                    <dt class="optional">key
                        <span class="property-type">string</span>
                    </dt>
                    <dd> [TLS] Path to the priate key that shall be used to authenticate.<br/>
                         Only files are supported currently, no strings that contain the key!</dd>
                    <dt class="optional">cert
                        <span class="property-type">string</span>
                    </dt>
                    <dd> [TLS] Path to the certificate that shall be used to authenticate.<br/>
                            Only files are supported currently, no strings that contain the certificate!</dd>
                    <dt class="optional">ca
                        <span class="property-type">string</span>
                    </dt>
                    <dd> [TLS] Path to the root certificate that shall be used.<br/>
                            Only files are supported currently, no strings that contain the ca!</dd>
                    <dt class="optional">reconnect
                        <span class="property-type">integer</span>
                    </dt>
                    <dd> If specified, this enables the automatic re-connects of the mqtt library.<br/>
                         Defaults to "0" (= off). Note: No testing has been done with reconnects turned on!</dd>
                </dl>
            </dd>
        </dl>
    
     <h3>Outputs</h3>
        The node will emitt messages on every status change that any of the managed clients had.
         <ol class="node-ports">
             <li>Standard output
                 <dl class="message-properties">
                     <dt>payload <span class="property-type">string</span></dt>
                     <dd>The New status of the MQTT connection.</dd>
                     <dt>client_id <span class="property-type">string</span></dt>
                     <dd>Id of the client of which the status changed.</dd>
                 </dl>
             </li>
         </ol>
    
    <h3>Details</h3>
        <p>On input, <code>msg.payload</code> is used to specify the parameters that should be used for connecting.</p>
        <p>By default, the connections will not be automatically re-connected.</p>
    <h3>References</h3>
        <ul>
            <li><a href="https://github.com/promd/node-red-contrib-mqtt-flex">GitHub</a> - the nodes github repository</li>
        </ul>
</script>

<script type="text/html" data-template-name="mqtt-flex-connect">
    <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>
</script>

<script type="text/html" data-help-name="mqtt-flex-disconnect">
    <p>Ends connection to a  MQTT broker that has previously been established.</p>
    
    <h3>Inputs</h3>
        <dl class="message-properties">
            <dt>client_id
                <span class="property-type">string</span>
            </dt>
            <dd> The client id identifying the MQTT connection.</dd>
        </dl>
    <h3>References</h3>
        <ul>
            <li><a href="https://github.com/promd/node-red-contrib-mqtt-flex">GitHub</a> - the nodes github repository</li>
        </ul>
</script>

<script type="text/html" data-template-name="mqtt-flex-disconnect">
    <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>
</script>

<script type="text/html" data-template-name="mqtt-flex-publish">
    <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>
</script>

<script type="text/html" data-template-name="mqtt-flex-status">
    <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>
</script>