com.pi4j.plugin.linuxfs.provider.gpio.digital.LinuxFsDigitalInputProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pi4j-plugin-linuxfs Show documentation

Pi4J Library Plugin for Linux File System I/O Providers

There is a newer version: 2.7.0

package com.pi4j.plugin.linuxfs.provider.gpio.digital;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: PLUGIN   :: LinuxFS I/O Providers
 * FILENAME      :  LinuxFsDigitalInputProvider.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import com.pi4j.io.gpio.digital.DigitalInputProvider;
import com.pi4j.plugin.linuxfs.LinuxFsPlugin;

/**
 * LinuxFsDigitalInputProvider interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface LinuxFsDigitalInputProvider extends DigitalInputProvider {
    /** Constant NAME="LinuxFs.DIGITAL_INPUT_PROVIDER_NAME" */
    String NAME = LinuxFsPlugin.DIGITAL_INPUT_PROVIDER_NAME;
    /** Constant ID="LinuxFs.DIGITAL_INPUT_PROVIDER_ID" */
    String ID = LinuxFsPlugin.DIGITAL_INPUT_PROVIDER_ID;

    /**
     * newInstance.
     *
     * @return a {@link com.pi4j.plugin.linuxfs.provider.gpio.digital.LinuxFsDigitalInputProvider} object.
     */
    static LinuxFsDigitalInputProvider newInstance(String gpioFileSystemPath) {
        return new LinuxFsDigitalInputProviderImpl(gpioFileSystemPath);
    }

    /**
     * newInstance.
     *
     * @return a {@link com.pi4j.plugin.linuxfs.provider.gpio.digital.LinuxFsDigitalInputProvider} object.
     */
    static LinuxFsDigitalInputProvider newInstance() {
        return new LinuxFsDigitalInputProviderImpl(LinuxFsPlugin.DEFAULT_GPIO_FILESYSTEM_PATH);
    }

}