node-red/nodes/core/hardware/36-rpi-gpio.html

<!--
  Copyright JS Foundation and other contributors, http://js.foundation

  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="rpi-gpio in">
    <div class="form-row">
        <label for="node-input-pin"><i class="fa fa-circle"></i> <span data-i18n="rpi-gpio.label.gpiopin"></span></label>
        <select type="text" id="node-input-pin" style="width: 250px;">
            <option value='' disabled selected style='display:none;'><span data-i18n="rpi-gpio.label.selectpin"></span></option>
            <!-- <option value="3">Pin 3 - SDA1 - BCM2</option> -->
            <!-- <option value="5">Pin 5 - SCL1 - BCM3</option> -->
            <option value="7">Pin 7 - GPIO4</option>
            <!-- <option value="8">Pin 8 - TxD - BCM14</option> -->
            <!-- <option value="10">Pin 10 - RxD - BCM15</option> -->
            <option value="11">Pin 11 - GPIO17</option>
            <option value="12">Pin 12 - GPIO18</option>
            <option value="13">Pin 13 - GPIO27</option>
            <option value="15">Pin 15 - GPIO22</option>
            <option value="16">Pin 16 - GPIO23</option>
            <option value="18">Pin 18 - GPIO24</option>
            <!-- <option value="19">Pin 19 - MOSI - BCM10</option> -->
            <!-- <option value="21">Pin 21 - MISO - BCM9</option> -->
            <option value="22">Pin 22 - GPIO25</option>
            <!-- <option value="23">Pin 23 - SCLK - BCM11</option> -->
            <!-- <option value="24">Pin 24 - CE0 - BCM8</option> -->
            <!-- <option value="26">Pin 26 - CE1 - BCM7</option> -->
         </select>
         &nbsp;<span id="pitype"></span>
    </div>
    <div class="form-row">
        <label for="node-input-intype"><i class="fa fa-level-up"></i> <span data-i18n="rpi-gpio.label.resistor"></span></label>
        <select type="text" id="node-input-intype" style="width:100px;">
        <option value="tri" data-i18n="rpi-gpio.resistor.none"></option>
        <option value="up" data-i18n="rpi-gpio.resistor.pullup"></option>
        <option value="down" data-i18n="rpi-gpio.resistor.pulldown"></option>
        </select>
        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span data-i18n="rpi-gpio.label.debounce"></span>
        <input type="text" id="node-input-debounce" style="width:47px; text-align:right"/>&nbsp;mS
    </div>
    <div class="form-row">
        <label>&nbsp;</label>
        <input type="checkbox" id="node-input-read" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-read" style="width:70%;"><span data-i18n="rpi-gpio.label.readinitial"></span></label>
    </div>
    <br/>
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
    </div>
    <div class="form-tips" id="pin-tip"><span data-i18n="[html]rpi-gpio.tip.pin"></span></div>
    <div class="form-tips"><span data-i18n="[html]rpi-gpio.tip.in"></span></div>
</script>

<script type="text/x-red" data-help-name="rpi-gpio in">
    <p>Raspberry Pi input node. Generates a <code>msg.payload</code> with either a
    0 or 1 depending on the state of the input pin.</p>
    <p>You may also enable the input pullup resistor or the pulldown resistor.</p>
    <p>The <code>msg.topic</code> is set to <i>pi/{the pin number}</i></p>
    <p>Requires the RPi.GPIO python library version 0.5.10 (or better) in order to work.</p>
    <p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p>
    </script>

<script type="text/javascript">
    var pinsInUse = {};
    RED.nodes.registerType('rpi-gpio in',{
        category: 'Raspberry Pi',
        color:"#c6dbef",
        defaults: {
            name: { value:"" },
            pin: { value:"tri",required:true,validate:RED.validators.number() },
            intype: { value:"in" },
            debounce: { value:"25" },
            read: { value:false }
        },
        inputs:0,
        outputs:1,
        icon: "rpi.png",
        info: function() {
            if ( Object.keys(pinsInUse).length !== 0 ) {
                return "**Pins in use** : "+Object.keys(pinsInUse);
            }
            else { return ""; }
        },
        label: function() {
            return this.name || "Pin: "+this.pin ;
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        },
        oneditprepare: function() {
            var pinnow = this.pin;
            var pintip = this._("rpi-gpio.tip.pin");
            var pinname = this._("rpi-gpio.pinname");
            var alreadyuse = this._("rpi-gpio.alreadyuse");
            var alreadyset = this._("rpi-gpio.alreadyset");
            $.getJSON('rpi-gpio/'+this.id,function(data) {
                $('#pitype').text(data.type);
                if ((data.type !== "Model B") && (data.type !== "Model A")) {
                    //$('#node-input-pin').append($("<option></option>").attr("value",27).text("Pin 27 - SDA0 - BCM0"));
                    //$('#node-input-pin').append($("<option></option>").attr("value",28).text("Pin 28 - SCL0 - BCM1"));
                    $('#node-input-pin').append($("<option></option>").attr("value",29).text("Pin 29 - GPIO5"));
                    $('#node-input-pin').append($("<option></option>").attr("value",31).text("Pin 31 - GPIO6"));
                    $('#node-input-pin').append($("<option></option>").attr("value",32).text("Pin 32 - GPIO12"));
                    $('#node-input-pin').append($("<option></option>").attr("value",33).text("Pin 33 - GPIO13"));
                    $('#node-input-pin').append($("<option></option>").attr("value",35).text("Pin 35 - GPIO19"));
                    $('#node-input-pin').append($("<option></option>").attr("value",36).text("Pin 36 - GPIO16"));
                    $('#node-input-pin').append($("<option></option>").attr("value",37).text("Pin 37 - GPIO26"));
                    $('#node-input-pin').append($("<option></option>").attr("value",38).text("Pin 38 - GPIO20"));
                    $('#node-input-pin').append($("<option></option>").attr("value",40).text("Pin 40 - GPIO21"));
                    $('#node-input-pin').val(pinnow);
                }
            });

            $.getJSON('rpi-pins/'+this.id,function(data) {
                pinsInUse = data || {};
                $('#pin-tip').html(pintip + Object.keys(data));
            });

            $("#node-input-pin").change(function() {
                var pinnew = $("#node-input-pin").val();
                if ((pinnew) && (pinnew !== pinnow)) {
                    if (pinsInUse.hasOwnProperty(pinnew)) {
                        RED.notify(pinname+" "+pinnew+" "+alreadyuse,"warn");
                    }
                    pinnow = pinnew;
                }
            });

            $("#node-input-intype").change(function() {
                var newtype = $("#node-input-intype").val();
                if ((pinsInUse.hasOwnProperty(pinnow)) && (pinsInUse[pinnow] !== newtype)) {
                    RED.notify(pinname+" "+pinnow+" "+alreadyset+" "+pinsInUse[pinnow],"error");
                }
            });
        }
    });
</script>

<script type="text/x-red" data-template-name="rpi-gpio out">
    <div class="form-row">
        <label for="node-input-pin"><i class="fa fa-circle"></i> <span data-i18n="rpi-gpio.label.gpiopin"></span></label>
        <select type="text" id="node-input-pin" style="width: 250px;">
            <option value='' disabled selected style='display:none;'><span data-i18n="rpi-gpio.label.selectpin"></span></option>
            <!-- <option value="3">Pin 3 - SDA1 - BCM2</option> -->
            <!-- <option value="5">Pin 5 - SCL1 - BCM3</option> -->
            <option value="7">Pin 7 - GPIO4</option>
            <!-- <option value="8">Pin 8 - TxD - BCM14</option> -->
            <!-- <option value="10">Pin 10 - RxD - BCM15</option> -->
            <option value="11">Pin 11 - GPIO17</option>
            <option value="12">Pin 12 - GPIO18</option>
            <option value="13">Pin 13 - GPIO27</option>
            <option value="15">Pin 15 - GPIO22</option>
            <option value="16">Pin 16 - GPIO23</option>
            <option value="18">Pin 18 - GPIO24</option>
            <!-- <option value="19">Pin 19 - MOSI - BCM10</option> -->
            <!-- <option value="21">Pin 21 - MISO - BCM9</option> -->
            <option value="22">Pin 22 - GPIO25</option>
            <!-- <option value="23">Pin 23 - SCLK - BCM11</option> -->
            <!-- <option value="24">Pin 24 - CE0 - BCM8</option> -->
            <!-- <option value="26">Pin 26 - CE1 - BCM7</option> -->
         </select>
         &nbsp;<span id="pitype"></span>
    </div>
    <div class="form-row" id="node-set-pwm">
        <label>&nbsp;&nbsp;&nbsp;&nbsp;<span data-i18n="rpi-gpio.label.type"></span></label>
        <select id="node-input-out" style="width: 250px;">
            <option value="out" data-i18n="rpi-gpio.digout"></option>
            <option value="pwm" data-i18n="rpi-gpio.pwmout"></option>
        </select>
    </div>
    <div class="form-row" id="node-set-tick">
        <label>&nbsp;</label>
        <input type="checkbox" id="node-input-set" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-set" style="width: 70%;"><span data-i18n="rpi-gpio.label.initpin"></span></label>
    </div>
    <div class="form-row" id="node-set-state">
        <label for="node-input-level">&nbsp;</label>
        <select id="node-input-level" style="width: 250px;">
            <option value="0" data-i18n="rpi-gpio.initpin0"></option>
            <option value="1" data-i18n="rpi-gpio.initpin1"></option>
        </select>
    </div>
    <br/>
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
    </div>
    <div class="form-tips" id="pin-tip"><span data-i18n="[html]rpi-gpio.tip.pin"></span></div>
    <div class="form-tips" id="dig-tip"><span data-i18n="[html]rpi-gpio.tip.dig"></span></div>
    <div class="form-tips" id="pwm-tip"><span data-i18n="[html]rpi-gpio.tip.pwm"></span></div>
</script>

<script type="text/x-red" data-help-name="rpi-gpio out">
    <p>Raspberry Pi output node. Can be used in Digital, PWM or Servo modes.
    <p>Digital mode expects a <code>msg.payload</code> with either a 0 or 1 (or true or false),
    and will set the selected physical pin high or low depending on the value passed in.</p>
    <p>The initial value of the pin at deploy time can also be set to 0 or 1.</p>
    <p>When using PWM mode - expects an input value of a number 0 - 100. It can be floating point.</p>
    <p>PWM mode can be used to drive a servo using input values between 10 and 20 only.
    The GPIO2 pin is best for this as it uses hardware to do the PWM.</p>
    <p>Requires the RPi.GPIO python library version 0.5.10 (or better) in order to work.</p>
    <p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p>
</script>

<script type="text/javascript">
    var pinsInUse = {};
    RED.nodes.registerType('rpi-gpio out',{
        category: 'Raspberry Pi',
        color:"#c6dbef",
        defaults: {
            name: { value:"" },
            pin: { value:"",required:true,validate:RED.validators.number() },
            set: { value:"" },
            level: { value:"0" },
            out: { value:"out" }
        },
        inputs:1,
        outputs:0,
        icon: "rpi.png",
        info: function() {
            if ( Object.keys(pinsInUse).length !== 0 ) {
                return "**Pins in use** : "+Object.keys(pinsInUse);
            }
            else { return ""; }
        },
        align: "right",
        label: function() {
            if (this.out === "pwm") { return this.name || "PWM: "+this.pin; }
            else { return this.name||"Pin: "+this.pin ; }
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        },
        oneditprepare: function() {
            var pinnow = this.pin;
            var pintip = this._("rpi-gpio.tip.pin");
            var pinname = this._("rpi-gpio.pinname");
            var alreadyuse = this._("rpi-gpio.alreadyuse");
            var alreadyset = this._("rpi-gpio.alreadyset");
            if (!$("#node-input-out").val()) { $("#node-input-out").val("out"); }
            $.getJSON('rpi-gpio/'+this.id,function(data) {
                $('#pitype').text(data.type);
                if ((data.type !== "Model B") && (data.type !== "Model A")) {
                    //$('#node-input-pin').append($("<option></option>").attr("value",27).text("Pin 27 - SDA0 - BCM0"));
                    //$('#node-input-pin').append($("<option></option>").attr("value",28).text("Pin 28 - SCL0 - BCM1"));
                    $('#node-input-pin').append($("<option></option>").attr("value",29).text("Pin 29 - GPIO5"));
                    $('#node-input-pin').append($("<option></option>").attr("value",31).text("Pin 31 - GPIO6"));
                    $('#node-input-pin').append($("<option></option>").attr("value",32).text("Pin 32 - GPIO12"));
                    $('#node-input-pin').append($("<option></option>").attr("value",33).text("Pin 33 - GPIO13"));
                    $('#node-input-pin').append($("<option></option>").attr("value",35).text("Pin 35 - GPIO19"));
                    $('#node-input-pin').append($("<option></option>").attr("value",36).text("Pin 36 - GPIO16"));
                    $('#node-input-pin').append($("<option></option>").attr("value",37).text("Pin 37 - GPIO26"));
                    $('#node-input-pin').append($("<option></option>").attr("value",38).text("Pin 38 - GPIO20"));
                    $('#node-input-pin').append($("<option></option>").attr("value",40).text("Pin 40 - GPIO21"));
                    $('#node-input-pin').val(pinnow);
                }
            });

            $.getJSON('rpi-pins/'+this.id,function(data) {
                pinsInUse = data || {};
                $('#pin-tip').html(pintip + Object.keys(data));
            });

            $("#node-input-pin").change(function() {
                var pinnew = $("#node-input-pin").val();
                if ((pinnew) && (pinnew !== pinnow)) {
                    if (pinsInUse.hasOwnProperty(pinnew)) {
                        RED.notify(pinname+" "+pinnew+" "+alreadyuse,"warn");
                    }
                    pinnow = pinnew;
                }
            });

            $("#node-input-out").change(function() {
                var newtype = $("#node-input-out").val();
                if ((pinsInUse.hasOwnProperty(pinnow)) && (pinsInUse[pinnow] !== newtype)) {
                    RED.notify(pinname+" "+pinnow+" "+alreadyset+" "+pinsInUse[pinnow],"error");
                }
            });

            var hidestate = function () {
                if ($("#node-input-out").val() === "pwm") {
                    $('#node-set-tick').hide();
                    $('#node-set-state').hide();
                    $('#node-input-set').prop('checked', false);
                    $("#dig-tip").hide();
                    $("#pwm-tip").show();
                }
                else {
                    $('#node-set-tick').show();
                    $("#dig-tip").show();
                    $("#pwm-tip").hide();
                }
            };
            $("#node-input-out").change(function () { hidestate(); });
            hidestate();

            var setstate = function () {
                if ($('#node-input-set').is(":checked")) {
                    $("#node-set-state").show();
                } else {
                    $("#node-set-state").hide();
                }
            };
            $("#node-input-set").change(function () { setstate(); });
            setstate();
        }
    });
</script>

<script type="text/x-red" data-template-name="rpi-mouse">
    <div class="form-row">
        <label for="node-input-butt"><i class="fa fa-circle"></i> <span data-i18n="rpi-gpio.label.button"></span></label>
        <select type="text" id="node-input-butt" style="width: 250px;">
            <option value="1" data-i18n="rpi-gpio.left"></option>
            <option value="2" data-i18n="rpi-gpio.right"></option>
            <option value="4" data-i18n="rpi-gpio.middle"></option>
            <option value="7" data-i18n="rpi-gpio.any"></option>
         </select>
    </div>
    <br/>
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
    </div>
</script>

<script type="text/x-red" data-help-name="rpi-mouse">
    <p>Raspberry Pi mouse button node. Requires a USB mouse.</p>
    <p>Generates a <code>msg.payload</code> with
    either a 1 or 0 when the selected mouse button is pressed and released</p>
    <p>Also sets <code>msg.button</code> to the code value
    <ul><li>1 = left</li><li>2 = right</li><li>4 = middle</li></ul>
    so you can work out which button or combination was pressed.</p>
    <p>And sets <code>msg.topic</code> to <i>pi/mouse</i>.</p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('rpi-mouse',{
        category: 'Raspberry Pi',
        color:"#c6dbef",
        defaults: {
            name: { value:"" },
            butt: { value:"1",required:true }
        },
        inputs:0,
        outputs:1,
        icon: "rpi.png",
        label: function() {
            var na = this._("rpi-gpio.label.pimouse");
            if (this.butt === "1") { na += " "+this._("rpi-gpio.label.left"); }
            if (this.butt === "2") { na += " "+this._("rpi-gpio.label.right"); }
            if (this.butt === "4") { na += " "+this._("rpi-gpio.label.middle"); }
            return this.name||na;
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        }
    });
</script>

<script type="text/x-red" data-template-name="rpi-keyboard">
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
    </div>
</script>

<script type="text/x-red" data-help-name="rpi-keyboard">
    <p>Raspberry Pi keyboard handling node. Requires a USB keyboard.</p>
    <p>Generates a <code>msg.payload</code> with a keycode, and <code>msg.action</code> set to
    <i>up, down</i> or <i>repeat</i> whenever a key is pressed or released.</p>
    <p>It also sets <code>msg.topic</code> to <i>pi/key</i>.</p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('rpi-keyboard',{
        category: 'Raspberry Pi',
        color:"#c6dbef",
        defaults: {
            name: { value:"" }
        },
        inputs:0,
        outputs:1,
        icon: "rpi.png",
        label: function() {
            return this.name || this._("rpi-gpio.label.pikeyboard");
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        }
    });
</script>