com.pi4j.io.i2c.I2CConfig 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.i2c;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  I2CConfig.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.IOConfig;

/**
 * I2CConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface I2CConfig extends IOConfig {

    /** Constant BUS_KEY="bus" */
    String BUS_KEY = "bus";
    /** Constant DEVICE_KEY="device" */
    String DEVICE_KEY = "device";

    /**
     * bus.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer bus();
    /**
     * getBus.
     *
     * @return a {@link java.lang.Integer} object.
     */
    default Integer getBus() {
        return bus();
    }

    /**
     * device.
     *
     * @return a {@link java.lang.Integer} object.
     */
    Integer device();
    /**
     * getDevice.
     *
     * @return a {@link java.lang.Integer} object.
     */
    default Integer getDevice() {
        return device();
    }

    /**
     * newBuilder.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.i2c.I2CConfigBuilder} object.
     */
    static I2CConfigBuilder newBuilder(Context context)  {
        return I2CConfigBuilder.newInstance(context);
    }
}