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

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

The newest version!

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

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: PLUGIN   :: LinuxFS I/O Providers
 * FILENAME      :  LinuxFsDigitalInputProviderImpl.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.boardinfo.util.BoardInfoHelper;
import com.pi4j.io.gpio.digital.DigitalInput;
import com.pi4j.io.gpio.digital.DigitalInputConfig;
import com.pi4j.io.gpio.digital.DigitalInputProviderBase;
import com.pi4j.plugin.linuxfs.internal.LinuxGpio;

/**
 * LinuxFsDigitalInputProviderImpl class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class LinuxFsDigitalInputProviderImpl extends DigitalInputProviderBase implements LinuxFsDigitalInputProvider {

    final String gpioFileSystemPath;

    /**
     * Constructor for LinuxFsDigitalInputProviderImpl.
     */
    public LinuxFsDigitalInputProviderImpl(String gpioFileSystemPath) {
        this.id = ID;
        this.name = NAME;
        this.gpioFileSystemPath = gpioFileSystemPath;
    }

    @Override
    public int getPriority() {
        // the linux FS Digital driver should be higher priority on RP1 chip
        return BoardInfoHelper.usesRP1() ? 100 : 50;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DigitalInput create(DigitalInputConfig config) {
        // create filesystem based GPIO instance using instance address (GPIO NUMBER)
        LinuxGpio gpio = new LinuxGpio(this.gpioFileSystemPath, config.address());
        LinuxFsDigitalInput digitalInput = new LinuxFsDigitalInput(gpio, this, config);
        this.context.registry().add(digitalInput);
        return digitalInput;
    }
}