Example #1
0
  /**
   * [ARGUMENT/OPTION "--pin (#)" | "-p (#)" ] This example program accepts an optional argument for
   * specifying the GPIO pin (by number) to use with this GPIO listener example. If no argument is
   * provided, then GPIO #1 will be used. -- EXAMPLE: "--pin 4" or "-p 0".
   *
   * <p>[ARGUMENT/OPTION "--pull (up|down|off)" | "-l (up|down|off)" | "--up" | "--down" ] This
   * example program accepts an optional argument for specifying pin pull resistance. Supported
   * values: "up|down" (or simply "1|0"). If no value is specified in the command argument, then the
   * pin pull resistance will be set to PULL_UP by default. -- EXAMPLES: "--pull up", "-pull down",
   * "--pull off", "--up", "--down", "-pull 0", "--pull 1", "-l up", "-l down".
   *
   * @param args
   * @throws InterruptedException
   * @throws PlatformAlreadyAssignedException
   */
  public static void main(String[] args)
      throws InterruptedException, PlatformAlreadyAssignedException {

    // ####################################################################
    //
    // since we are not using the default Raspberry Pi platform, we should
    // explicitly assign the platform as the BananaPro platform.
    //
    // ####################################################################
    PlatformManager.setPlatform(Platform.BANANAPRO);

    // create Pi4J console wrapper/helper
    // (This is a utility class to abstract some of the boilerplate code)
    final Console console = new Console();

    // print program title/header
    console.title("<-- The Pi4J Project -->", "GPIO Input Example");

    // allow for user to exit program using CTRL-C
    console.promptForExit();

    // create gpio controller
    final GpioController gpio = GpioFactory.getInstance();

    // ####################################################################
    //
    // When provisioning a pin, use the BananaProPin class.
    //
    // ####################################################################

    // by default we will use gpio pin #01; however, if an argument
    // has been provided, then lookup the pin by address
    Pin pin =
        CommandArgumentParser.getPin(
            BananaProPin.class, // pin provider class to obtain pin instance from
            BananaProPin.GPIO_01, // default pin if no pin argument found
            args); // argument array to search in

    // by default we will use gpio pin PULL-UP; however, if an argument
    // has been provided, then use the specified pull resistance
    PinPullResistance pull =
        CommandArgumentParser.getPinPullResistance(
            PinPullResistance.PULL_UP, // default pin pull resistance if no pull argument found
            args); // argument array to search in

    // provision gpio pin as an input pin
    final GpioPinDigitalInput input = gpio.provisionDigitalInputPin(pin, "MyInput", pull);

    // set shutdown state for this pin: unexport the pin
    input.setShutdownOptions(true);

    // prompt user that we are ready
    console.println("Successfully provisioned [" + pin + "] with PULL resistance = [" + pull + "]");
    console.emptyLine();
    console.box("The GPIO input pin states will be displayed below.");
    console.emptyLine();

    // display pin state
    console.emptyLine();
    console.println(
        " ["
            + input.toString()
            + "] digital state is: "
            + ConsoleColor.conditional(
                input.getState().isHigh(), // conditional expression
                ConsoleColor.GREEN, // positive conditional color
                ConsoleColor.RED, // negative conditional color
                input.getState()));
    console.emptyLine();

    // stop all GPIO activity/threads by shutting down the GPIO controller
    // (this method will forcefully shutdown all GPIO monitoring threads and scheduled tasks)
    gpio.shutdown();
  }
  /**
   * @param args --none-
   * @throws InterruptedException
   */
  public static void main(String[] args) throws InterruptedException {

    // create Pi4J console wrapper/helper
    // (This is a utility class to abstract some of the boilerplate code)
    final Console console = new Console();

    // print program title/header
    console.title("<-- The Pi4J Project -->", "IFTTT Maker Channel Trigger Example");

    // allow for user to exit program using CTRL-C
    console.promptForExit();

    // create gpio controller
    final GpioController gpio = GpioFactory.getInstance();

    // provision gpio pin as an input pin
    final GpioPinDigitalInput input =
        gpio.provisionDigitalInputPin(RaspiPin.GPIO_00, "MyInputPin", PinPullResistance.PULL_DOWN);

    // provide 500ms of pin debounce protection
    input.setDebounce(500);
    ;

    // -----------------------------------------
    // Add the IFTTT Maker Channel Trigger
    // (This is where the magic happens)
    // -----------------------------------------
    input.addTrigger(
        new IFTTTMakerChannelTrigger(
            IFTTT_MAKER_CHANNEL_API_KEY, // <<-- PROVIDE YOUR ACCOUNT SPECIFIC IFTTT MAKER CHANNEL
                                         // API KEY
            IFTTT_MAKER_CHANNEL_EVENT_NAME, // <<-- PROVIDE THE IFTTT MAKER CHANNEL EVENT NAME
                                            // (defined in your IFTTTT recipe)
            PinState.HIGH, // <<-- OPTIONALLY DEFINE A SPECIFIC STATE TO TRIGGER ON

            // OPTIONALLY REGISTER A TRIGGER CALLBACK LISTENER
            // (Note: this callback parameter is not required for basic functionality)
            new IFTTTMakerChannelTriggerListener() {
              @Override
              public boolean onTriggered(IFTTTMakerChannelTriggerEvent event) {

                // The IFTTT Maker Channel API accepts three value parameters (value1, value2, and
                // value3)
                // By default, Pi4J applies the following values to each:
                //
                // "value1" = {pin-name}
                // "value2" = {pin-state-value} (as an Integer; 0==LOW, 1==HIGH)
                // "value3" = {json-payload}  Example:
                // {
                //    "pin": {
                //        "name": "MyInputPin",
                //        "address": "0",
                //        "provider": "RaspberryPi GPIO Provider",
                //        "mode": "input",
                //        "direction": "IN",
                //        "pull": "down"
                //    },
                //    "state": {
                //        "name": "HIGH",
                //        "value": "1",
                //        "is-high": "true",
                //        "is-low": "false"
                //    },
                //    "timestamp": "2016-04-15T17:32:49.666-0400"
                // }
                //
                // However, you can override any of these defaults in your callback listener by
                // applying new string values via the 'setValueX()' methods on the event object.
                //
                // Example:
                if (event.getValue2().equals("1")) {
                  event.setValue2("ON");
                } else {
                  event.setValue2("OFF");
                }

                // display event trigger details on screen
                console.println(" --> IFTTT MAKER CHANNEL EVENT TRIGGER");
                console.println("     - GPIO PIN            : " + event.getPin());
                console.println("     - PIN STATE           : " + event.getState());
                console.println("     - IFTTT EVENT NAME    : " + event.getEventName());
                console.println("     - IFTTT EVENT VALUE 1 : " + event.getValue1());
                console.println("     - IFTTT EVENT VALUE 2 : " + event.getValue2());
                console.println("     - IFTTT EVENT VALUE 3 : " + event.getValue3());
                console.emptyLine();

                // MAKE SURE TO RETURN 'true' TO CONTINUE WITH THE IFTTT MAKER CHANNEL API CALL
                // (you can optionally return 'false' if you want to abort the IFTTT API call)
                return true;
              }
            }));

    // set shutdown state for this pin: unexport the pin
    input.setShutdownOptions(true);

    // prompt user that we are ready
    console.println(
        "Successfully provisioned ["
            + input
            + "] with PULL resistance = ["
            + input.getPullResistance()
            + "]");
    console.emptyLine();

    // wait for user to exit by pressing CTRL-C
    console.waitForExit();

    // stop all GPIO activity/threads by shutting down the GPIO controller
    // (this method will forcefully shutdown all GPIO monitoring threads and scheduled tasks)
    gpio.shutdown();
  }