001package com.pi4j.io.gpio;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  PiFacePin.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 - 2021 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 com.pi4j.io.gpio.impl.PinImpl;
034
035import java.util.EnumSet;
036
037/**
038 * Raspberry Pi pin definitions.
039 *
040 * @author Robert Savage (<a
041 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
042 */
043@SuppressWarnings("unused")
044public class PiFacePin  {
045
046    public static final Pin GPIO_00 = createDigitalPin(0, "GPIO 0");
047    public static final Pin GPIO_01 = createDigitalAndPwmPin(1, "GPIO 1"); // PIN 1 supports PWM output
048    public static final Pin GPIO_02 = createDigitalPin(2, "GPIO 2");
049    public static final Pin GPIO_03 = createDigitalPin(3, "GPIO 3");
050    public static final Pin GPIO_04 = createDigitalPin(4, "GPIO 4");
051    public static final Pin GPIO_05 = createDigitalPin(5, "GPIO 5");
052    public static final Pin GPIO_06 = createDigitalPin(6, "GPIO 6");
053    public static final Pin GPIO_07 = createDigitalPin(7, "GPIO 7");
054    public static final Pin GPIO_08 = createDigitalPin(8, "GPIO 8");
055    public static final Pin GPIO_09 = createDigitalPin(9, "GPIO 9");
056    public static final Pin GPIO_10 = createDigitalPin(10, "GPIO 10");
057    public static final Pin GPIO_11 = createDigitalPin(11, "GPIO 11");
058    public static final Pin GPIO_12 = createDigitalPin(12, "GPIO 12");
059    public static final Pin GPIO_13 = createDigitalPin(13, "GPIO 13");
060    public static final Pin GPIO_14 = createDigitalPin(14, "GPIO 14");
061    public static final Pin GPIO_15 = createDigitalPin(15, "GPIO 15");
062    public static final Pin GPIO_16 = createDigitalPin(16, "GPIO 16");
063    public static final Pin GPIO_17 = createDigitalPin(17, "GPIO 17");
064    public static final Pin GPIO_18 = createDigitalPin(18, "GPIO 18");
065    public static final Pin GPIO_19 = createDigitalPin(19, "GPIO 19");
066    public static final Pin GPIO_20 = createDigitalPin(20, "GPIO 20");
067
068    private static Pin createDigitalPin(int address, String name) {
069        return new PinImpl(RaspiGpioProvider.NAME, address, name,
070                    EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT),
071                    PinPullResistance.all());
072    }
073
074    private static Pin createDigitalAndPwmPin(int address, String name) {
075        return new PinImpl(RaspiGpioProvider.NAME, address, name,
076                           EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT, PinMode.PWM_OUTPUT),
077                           PinPullResistance.all());
078    }
079}