com.pi4j.io.gpio.analog.AnalogOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.io.gpio.analog;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  AnalogOutput.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.pi4j.context.Context;
import com.pi4j.io.Output;
import com.pi4j.io.exception.IOBoundsException;
import com.pi4j.io.exception.IOIllegalValueException;

/**
 * AnalogOutput interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface AnalogOutput extends Analog, Output {

    /**
     * newConfigBuilder.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutputConfigBuilder} object.
     */
    static AnalogOutputConfigBuilder newConfigBuilder(Context context){
        return AnalogOutputConfigBuilder.newInstance(context);
    }

    /**
     * value.
     *
     * @param value a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutput} object.
     * @throws com.pi4j.io.exception.IOIllegalValueException if any.
     * @throws com.pi4j.io.exception.IOBoundsException if any.
     */
    AnalogOutput value(Integer value) throws IOIllegalValueException, IOBoundsException;
    /**
     * stepUp.
     *
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutput} object.
     */
    AnalogOutput stepUp();
    /**
     * stepDown.
     *
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutput} object.
     */
    AnalogOutput stepDown();
    /**
     * step.
     *
     * @param value a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutput} object.
     * @throws com.pi4j.io.exception.IOIllegalValueException if any.
     * @throws com.pi4j.io.exception.IOBoundsException if any.
     */
    AnalogOutput step(Integer value) throws IOIllegalValueException, IOBoundsException;
    /**
     * setValue.
     *
     * @param value a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.gpio.analog.AnalogOutput} object.
     * @throws com.pi4j.io.exception.IOIllegalValueException if any.
     * @throws com.pi4j.io.exception.IOBoundsException if any.
     */
    default AnalogOutput setValue(Integer value) throws IOIllegalValueException, IOBoundsException { return value(value); };
}