-example.1.4.source-code.DebounceGpioExample Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-example Show documentation
Pi4J Java Examples using the Pi4J Library
The newest version!
// START SNIPPET: listen-gpio-snippet


/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: Java Examples
 * FILENAME      :  DebounceGpioExample.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 * %%
 * Copyright (C) 2012 - 2021 Pi4J
 * %%
 * 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.
 * #L%
 */

import com.pi4j.io.gpio.*;
import com.pi4j.io.gpio.event.GpioPinDigitalStateChangeEvent;
import com.pi4j.io.gpio.event.GpioPinListenerDigital;

import java.util.Date;

/**
 * This example code demonstrates how to setup a listener
 * for GPIO pin state changes on the Raspberry Pi.
 *
 * @author Robert Savage
 */
public class DebounceGpioExample {

    public static void main(String args[]) throws InterruptedException {
        System.out.println("<--Pi4J--> GPIO Debounce Example ... started.");

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

        // provision gpio pin #02 as an input pin with its internal pull down resistor enabled
        final GpioPinDigitalInput myButton = gpio.provisionDigitalInputPin(RaspiPin.GPIO_02, PinPullResistance.PULL_DOWN);

        //
        // ----- DEBOUNCE -----
        //
        // Bouncing is the tendency of any two metal contacts in an electronic device to generate multiple signals as
        // the contacts close or open; debouncing is any kind of hardware device or software that ensures that only a
        // single signal will be acted upon for a single opening or closing of a contact.
        //
        // Pi4J supports a debounce feature to suppress state change event notifications on GPIO input pins.
        // This feature allows the consumer to set a debounce delay time in milliseconds.  When a pin state change
        // occurs, the initial event will be raised and the debounce delay timer will be started.  Any subsequent
        // pin state changes will be suppressed until after the debounce delay timer has expired.  When the debounce
        // delay timer expires and if the pin state is different than the start when the debounce timer started, a
        // pin event will be raised to notify the consumer of the pin state change.   (You can optionally set a
        // different debounce delay for each pin state or use the example below to set the same delay time for all
        // pin states)
        //
        // Please note that if you make a call to 'getState()', 'isHigh()' or 'isLow()' the actual current state
        // will be returned, the debounce feature only suppresses event notifications, is does not attempt to
        // mask the actual pin state.
        myButton.setDebounce(1000);

        // create and register gpio pin listener
        myButton.addListener(new GpioPinListenerDigital() {
            @Override
            public void handleGpioPinDigitalStateChangeEvent(GpioPinDigitalStateChangeEvent event) {
                // display pin state on console
                System.out.println("[" + new Date() +
                        "] --> GPIO PIN STATE CHANGE: " +
                        event.getPin() + " = " + event.getState());
            }

        });

        System.out.println(" ... complete the GPIO #02 circuit and see the listener feedback here in the console.");

        // keep program running until user aborts (CTRL-C)
        while(true) {
            Thread.sleep(500);
        }

        // 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();   <--- implement this method call if you wish to terminate the Pi4J GPIO controller
    }
}

// END SNIPPET: listen-gpio-snippet