com.pi4j.io.gpio.GpioPinPwm Maven / Gradle / Ivy
package com.pi4j.io.gpio;
/*
* #%L
* **********************************************************************
ORGANIZATION : Pi4J
PROJECT : Pi4J :: Java Library (Core)
FILENAME : GpioPinPwm.java
This file is part of the Pi4J project. More information about
this project can be found here: http://www.pi4j.com/
**********************************************************************
* %%
* Copyright (C) 2012 - 2018 Pi4J
* %%
* 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%
*/
/**
* Gpio input pin interface. This interface is extension of {@link GpioPin} interface
* with reading pwm values.
*
* @author Robert Savage (http://www.savagehomeautomation.com)
*/
@SuppressWarnings("unused")
public interface GpioPinPwm extends GpioPin {
/**
* If this is a hardware PWM pin, the value will be between a range of 0 to 1024.
* If this is a software emulated PWM pin, the value will be between a range of 0 to 100.
*
* @return the value currently set for the PWM output
*/
int getPwm();
}