001package com.pi4j.io.gpio;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  RaspiPin.java  
009 * 
010 * This file is part of the Pi4J project. More information about 
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2015 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;
036import java.util.HashMap;
037import java.util.Map;
038
039/**
040 * Raspberry Pi pin definitions.
041 *
042 * @author Robert Savage (<a
043 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
044 */
045public class RaspiPin  {
046
047    private static Map<String, Pin> pins = new HashMap<String, Pin>();
048    
049    public static final Pin GPIO_00 = createDigitalPin(0, "GPIO 0"); 
050    public static final Pin GPIO_01 = createDigitalAndPwmPin(1, "GPIO 1"); // supports PWM0 [ALT5]
051    public static final Pin GPIO_02 = createDigitalPin(2, "GPIO 2"); 
052    public static final Pin GPIO_03 = createDigitalPin(3, "GPIO 3"); 
053    public static final Pin GPIO_04 = createDigitalPin(4, "GPIO 4"); 
054    public static final Pin GPIO_05 = createDigitalPin(5, "GPIO 5"); 
055    public static final Pin GPIO_06 = createDigitalPin(6, "GPIO 6"); 
056    public static final Pin GPIO_07 = createDigitalPin(7, "GPIO 7"); 
057    public static final Pin GPIO_08 = createDigitalPin(8, "GPIO 8"); 
058    public static final Pin GPIO_09 = createDigitalPin(9, "GPIO 9"); 
059    public static final Pin GPIO_10 = createDigitalPin(10, "GPIO 10"); 
060    public static final Pin GPIO_11 = createDigitalPin(11, "GPIO 11"); 
061    public static final Pin GPIO_12 = createDigitalPin(12, "GPIO 12"); 
062    public static final Pin GPIO_13 = createDigitalPin(13, "GPIO 13"); 
063    public static final Pin GPIO_14 = createDigitalPin(14, "GPIO 14"); 
064    public static final Pin GPIO_15 = createDigitalPin(15, "GPIO 15"); 
065    public static final Pin GPIO_16 = createDigitalPin(16, "GPIO 16");
066
067    // the following GPIO pins are only available on the Raspbery Pi Model A, B (revision 2.0), B+
068    public static final Pin GPIO_17 = createDigitalPin(17, "GPIO 17"); // requires B rev2 or newer model (P5 header)
069    public static final Pin GPIO_18 = createDigitalPin(18, "GPIO 18"); // requires B rev2 or newer model (P5 header)
070    public static final Pin GPIO_19 = createDigitalPin(19, "GPIO 19"); // requires B rev2 or newer model (P5 header)
071    public static final Pin GPIO_20 = createDigitalPin(20, "GPIO 20"); // requires B rev2 or newer model (P5 header)
072
073    // the following GPIO pins are only available on the Raspbery Pi Model B+
074    public static final Pin GPIO_21 = createDigitalPin(21, "GPIO 21"); // requires 2B, A+, B+ or newer model (40 pin header)
075    public static final Pin GPIO_22 = createDigitalPin(22, "GPIO 22"); // requires 2B, A+, B+ or newer model (40 pin header)
076    public static final Pin GPIO_23 = createDigitalAndPwmPin(23, "GPIO 23"); // requires 2B, A+, B+ or newer model (40 pin header) : supports PWM1 [ALT0]
077    public static final Pin GPIO_24 = createDigitalAndPwmPin(24, "GPIO 24"); // requires 2B, A+, B+ or newer model (40 pin header) : supports PWM1 [ALT5]
078    public static final Pin GPIO_25 = createDigitalPin(25, "GPIO 25"); // requires 2B, A+, B+ or newer model (40 pin header)
079    public static final Pin GPIO_26 = createDigitalAndPwmPin(26, "GPIO 26"); // requires 2B, A+, B+ or newer model (40 pin header) : supports PWM0 [ALT0]
080    public static final Pin GPIO_27 = createDigitalPin(27, "GPIO 27"); // requires 2B, A+, B+ or newer model (40 pin header)
081    public static final Pin GPIO_28 = createDigitalPin(28, "GPIO 28"); // requires 2B, A+, B+ or newer model (40 pin header)
082    public static final Pin GPIO_29 = createDigitalPin(29, "GPIO 29"); // requires 2B, A+, B+ or newer model (40 pin header)
083
084
085    private static Pin createDigitalPin(int address, String name) {
086        Pin pin = new PinImpl(RaspiGpioProvider.NAME, address, name, 
087                    EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT),
088                    PinPullResistance.all());
089        if (pins == null) { pins = new HashMap<String, Pin>(); }
090        pins.put(name, pin);
091        return pin;
092    }
093
094    private static Pin createDigitalAndPwmPin(int address, String name) {
095        Pin pin = new PinImpl(RaspiGpioProvider.NAME, address, name, 
096                           EnumSet.of(PinMode.DIGITAL_INPUT, PinMode.DIGITAL_OUTPUT, PinMode.PWM_OUTPUT),
097                           PinPullResistance.all());
098        if (pins == null) { pins = new HashMap<String, Pin>(); }
099        pins.put(name, pin);
100        return pin;
101    }
102    
103    public static Pin getPinByName(String name) {
104        return pins.get(name);
105    }
106}