001package com.pi4j.io.gpio;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  BpiPin.java
009 *
010 * This file is part of the Pi4J project. More information about
011 * this project can be found here:  https://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2019 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 *
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 *
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032
033import java.util.EnumSet;
034
035/**
036 * Sinovoip BPI (BananaPi) pin definitions for (default) WiringPi pin numbering scheme.
037 *
038 * @author Robert Savage (<a
039 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
040 */
041public class BpiPin extends PinProvider {
042
043    public static final Pin GPIO_00 = createDigitalPin(0, "GPIO 0");
044    public static final Pin GPIO_01 = createDigitalAndPwmPinNoEdge(1, "GPIO 1"); // supports PWM
045    public static final Pin GPIO_02 = createDigitalPin(2, "GPIO 2");
046    public static final Pin GPIO_03 = createDigitalPin(3, "GPIO 3");
047    public static final Pin GPIO_04 = createDigitalPin(4, "GPIO 4");
048    public static final Pin GPIO_05 = createDigitalPin(5, "GPIO 5");
049    public static final Pin GPIO_06 = createDigitalPin(6, "GPIO 6");
050    public static final Pin GPIO_07 = createDigitalPin(7, "GPIO 7");
051    public static final Pin GPIO_08 = createDigitalPinNoEdge(8, "GPIO 8",
052            EnumSet.of(PinPullResistance.OFF, PinPullResistance.PULL_UP)); // this pin is permanently pulled up
053    public static final Pin GPIO_09 = createDigitalPinNoEdge(9, "GPIO 9",
054            EnumSet.of(PinPullResistance.OFF, PinPullResistance.PULL_UP)); // this pin is permanently pulled up
055    public static final Pin GPIO_10 = createDigitalPin(10, "GPIO 10");
056    public static final Pin GPIO_11 = createDigitalPin(11, "GPIO 11");
057    public static final Pin GPIO_12 = createDigitalPin(12, "GPIO 12");
058    public static final Pin GPIO_13 = createDigitalPin(13, "GPIO 13");
059    public static final Pin GPIO_14 = createDigitalPin(14, "GPIO 14");
060    public static final Pin GPIO_15 = createDigitalPin(15, "GPIO 15");
061    public static final Pin GPIO_16 = createDigitalPin(16, "GPIO 16");
062
063    public static final Pin GPIO_21 = createDigitalPinNoEdge(21, "GPIO 21");
064    public static final Pin GPIO_22 = createDigitalPinNoEdge(22, "GPIO 22");
065    public static final Pin GPIO_23 = createDigitalPinNoEdge(23, "GPIO 23");
066    public static final Pin GPIO_24 = createDigitalPinNoEdge(24, "GPIO 24");
067    public static final Pin GPIO_25 = createDigitalPinNoEdge(25, "GPIO 25");
068    public static final Pin GPIO_26 = createDigitalPinNoEdge(26, "GPIO 26");
069    public static final Pin GPIO_27 = createDigitalPinNoEdge(27, "GPIO 27");
070    public static final Pin GPIO_28 = createDigitalPinNoEdge(28, "GPIO 28");
071    public static final Pin GPIO_29 = createDigitalPinNoEdge(29, "GPIO 29");
072    //public static final Pin GPIO_30 = createDigitalPinNoEdge(30, "GPIO 30"); << This is SoC GPIO-00 which cannot be exported.
073    public static final Pin GPIO_31 = createDigitalPinNoEdge(31, "GPIO 31",
074            EnumSet.noneOf(PinPullResistance.class));  // this pin is permanently pulled up; pin pull settings do not work
075
076    protected static Pin createDigitalPin(int address, String name) {
077        return createDigitalPin(BpiGpioProvider.NAME, address, name);
078    }
079
080    protected static Pin createDigitalPinNoEdge(int address, String name, EnumSet<PinPullResistance> resistance) {
081        return createDigitalPin(BpiGpioProvider.NAME, address, name, resistance, EnumSet.noneOf(PinEdge.class));
082    }
083
084    protected static Pin createDigitalPinNoEdge(int address, String name) {
085        return createDigitalPin(BpiGpioProvider.NAME, address, name, EnumSet.noneOf(PinEdge.class));
086    }
087
088    protected static Pin createDigitalAndPwmPin(int address, String name) {
089        return createDigitalAndPwmPin(BpiGpioProvider.NAME, address, name);
090    }
091
092    protected static Pin createDigitalAndPwmPinNoEdge(int address, String name) {
093        return createDigitalAndPwmPin(BpiGpioProvider.NAME, address, name, EnumSet.noneOf(PinEdge.class));
094    }
095
096    // *override* static method from subclass
097    // (overriding a static method is not supported in Java
098    //  so this method definition will hide the subclass static method)
099    public static Pin getPinByName(String name) {
100        return PinProvider.getPinByName(name);
101    }
102
103    // *override* static method from subclass
104    // (overriding a static method is not supported in Java
105    //  so this method definition will hide the subclass static method)
106    public static Pin getPinByAddress(int address) {
107        return PinProvider.getPinByAddress(address);
108    }
109
110    // *override* static method from subclass
111    // (overriding a static method is not supported in Java
112    //  so this method definition will hide the subclass static method)
113    public static Pin[] allPins() { return PinProvider.allPins(); }
114
115    // *override* static method from subclass
116    // (overriding a static method is not supported in Java
117    //  so this method definition will hide the subclass static method)
118    public static Pin[] allPins(PinMode ... mode) { return PinProvider.allPins(mode); }
119}