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