001package com.pi4j.io.gpio;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  GpioPinPwmOutput.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/**
033 * Gpio output pwm pin interface.This interface adds operation to set output pwm value.
034 *
035 * @author Robert Savage (<a
036 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
037 */
038@SuppressWarnings("unused")
039public interface GpioPinPwmOutput extends GpioPinPwm, GpioPinOutput {
040
041    /**
042     * Set the PWM value/rate to toggle the GPIO pin.
043     * If this is a hardware PWM pin, the value should be between a range of 0 to 1024.
044     * If this is a software emulated PWM pin, the value should be between a range of 0 to 100.
045     *
046     * @param value
047     */
048    void setPwm(int value);
049
050    /**
051     * This sets the range register in the PWM generator.
052     * The default is 1024 for hardware PWM.
053     * The default is 100 for software emulated PWM.
054     *
055     * @param range
056     */
057    void setPwmRange(int range);
058}