001package com.pi4j.io.gpio.event;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  PinDigitalStateChangeEvent.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.Pin;
034import com.pi4j.io.gpio.PinEdge;
035import com.pi4j.io.gpio.PinState;
036
037
038/**
039 * GPIO digital pin state change event.
040 *
041 * @author Robert Savage (<a
042 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
043 */
044public class PinDigitalStateChangeEvent extends PinEvent {
045
046    private static final long serialVersionUID = -7643355305429082626L;
047    private final PinState state;
048    private final PinEdge edge;
049
050    /**
051     * Default event constructor
052     *
053     * @param obj Ignore this parameter
054     * @param pin GPIO pin number (not header pin number; not wiringPi pin number)
055     * @param state New GPIO pin state.
056     */
057    public PinDigitalStateChangeEvent(Object obj, Pin pin, PinState state) {
058        super(obj, pin, PinEventType.DIGITAL_STATE_CHANGE);
059        this.state = state;
060
061        // set pin edge caused by the state change
062        this.edge = (state == PinState.HIGH) ? PinEdge.RISING : PinEdge.FALLING;
063    }
064
065    /**
066     * Get the new pin state raised in this event.
067     *
068     * @return GPIO pin state (HIGH, LOW)
069     */
070    public PinState getState() {
071        return state;
072    }
073
074
075    /**
076     * Get the pin edge for the state change caused by this event.
077     *
078     * @return
079     */
080    public PinEdge getEdge() {
081        return this.edge;
082    }
083}