com.diozero.internal.provider.builtin.SysFsDigitalInputDevice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diozero-core Show documentation
The newest version!
package com.diozero.internal.provider.builtin;

/*
 * #%L
 * Organisation: diozero
 * Project:      diozero - Core
 * Filename:     SysFsDigitalInputDevice.java
 * 
 * This file is part of the diozero project. More information about this project
 * can be found at https://www.diozero.com/.
 * %%
 * Copyright (C) 2016 - 2024 diozero
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */

import java.io.FileWriter;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.nio.file.Path;

import org.tinylog.Logger;

import com.diozero.api.DeviceMode;
import com.diozero.api.DigitalInputEvent;
import com.diozero.api.GpioEventTrigger;
import com.diozero.api.PinInfo;
import com.diozero.api.RuntimeIOException;
import com.diozero.internal.provider.builtin.gpio.SysFsGpioUtil;
import com.diozero.internal.spi.AbstractInputDevice;
import com.diozero.internal.spi.GpioDigitalInputDeviceInterface;
import com.diozero.util.PollEventListener;

/**
 * Pure Java implementation using
 * the sysfs
 * (/sys/class/gpio) kernel module.
 */
public class SysFsDigitalInputDevice extends AbstractInputDevice
		implements GpioDigitalInputDeviceInterface, PollEventListener {
	private static final String EDGE_FILE = "edge";
	private static final String VALUE_FILE = "value";
	// private static final byte LOW_VALUE = '0';
	private static final byte HIGH_VALUE = '1';

	// Note java.nio.file.WatchService doesn't work with /sys, /proc and network
	// file-systems
	// http://stackoverflow.com/questions/30190730/nio-watchservice-for-unix-sys-classes-gpio-files

	private DefaultDeviceFactory deviceFactory;
	protected int gpio;
	private Path valuePath;
	private RandomAccessFile valueFile;

	public SysFsDigitalInputDevice(DefaultDeviceFactory deviceFactory, String key, PinInfo pinInfo,
			GpioEventTrigger trigger) {
		super(key, deviceFactory);

		this.deviceFactory = deviceFactory;
		this.gpio = pinInfo.getSysFsNumber();

		SysFsGpioUtil.export(pinInfo.getSysFsNumber(), DeviceMode.DIGITAL_INPUT);

		Path gpio_dir = SysFsGpioUtil.getGpioDirectoryPath(gpio);
		try (FileWriter writer = new FileWriter(gpio_dir.resolve(EDGE_FILE).toFile())) {
			writer.write(trigger.name().toLowerCase());
		} catch (IOException e) {
			Logger.warn(e, "Error writing to edge file for GPIO {}: {}", Integer.valueOf(gpio), e);
		}

		// Note: Not possible to set pull-up/down resistor configuration via
		// /sys/class/gpio

		valuePath = gpio_dir.resolve(VALUE_FILE);
		try {
			valueFile = new RandomAccessFile(valuePath.toFile(), "r");
		} catch (IOException e) {
			throw new RuntimeIOException("Error opening value file for GPIO " + gpio, e);
		}
	}

	@Override
	public int getGpio() {
		return gpio;
	}

	@Override
	public boolean getValue() throws RuntimeIOException {
		try {
			// Note seek(0) is required
			valueFile.seek(0);
			return valueFile.readByte() == HIGH_VALUE;
		} catch (IOException e) {
			throw new RuntimeIOException("Error reading value", e);
		}
	}

	@Override
	public void setDebounceTimeMillis(int debounceTime) {
		Logger.warn("Debounce not supported");
	}

	@Override
	protected void enableListener() {
		deviceFactory.getEpoll().register(valuePath.toString(), this);
	}

	@Override
	protected void disableListener() {
		deviceFactory.getEpoll().deregister(valuePath.toString());
	}

	@Override
	protected void closeDevice() throws RuntimeIOException {
		Logger.trace("closeDevice() {}", getKey());
		disableListener();
		try {
			valueFile.close();
		} catch (IOException e) {
			throw new RuntimeIOException(e);
		}
		SysFsGpioUtil.unexport(gpio);
	}

	@Override
	public void notify(long epochTime, long nanoTime, char value) {
		accept(new DigitalInputEvent(gpio, epochTime, nanoTime, value == HIGH_VALUE));
	}
}