com.pi4j.io.gpio.analog.AnalogConfig 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      :  AnalogConfig.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.config.Config;
import com.pi4j.io.gpio.GpioConfig;

/**
 * AnalogConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface AnalogConfig extends GpioConfig {
    /** Constant RANGE_MIN_KEY="min" */
    String RANGE_MIN_KEY = "min";
    /** Constant RANGE_MAX_KEY="max" */
    static String RANGE_MAX_KEY = "max";

    /**
     * range.
     *
     * @return a {@link com.pi4j.io.gpio.analog.AnalogRange} object.
     */
    AnalogRange range();
    /**
     * getRange.
     *
     * @return a {@link com.pi4j.io.gpio.analog.AnalogRange} object.
     */
    default AnalogRange getRange() { return this.range(); }
}