com.pi4j.io.spi.SpiConfigBuilder 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.spi;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  SpiConfigBuilder.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.IOAddressConfigBuilder;
import com.pi4j.io.spi.impl.DefaultSpiConfigBuilder;

/**
 * SpiConfigBuilder interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface SpiConfigBuilder extends
        IOAddressConfigBuilder {
    /**
     * newInstance.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    static SpiConfigBuilder newInstance(Context context)  {
        return DefaultSpiConfigBuilder.newInstance(context);
    }

    /**
     * baud.
     *
     * @param rate a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder baud(Integer rate);

    /**
     * bus.
     * If the Bus value is configured, that SpiBus
     * value will be set in the flags {@link #flags(Long)}   bit 'A' 8
     * 
     * @param bus a {@link com.pi4j.io.spi.SpiBus} object.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder bus(SpiBus bus);

    /**
     * bus.
     *
     * @param bus a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    default SpiConfigBuilder bus(Integer bus){ return bus(SpiBus.getByNumber(bus)); }

    /**
     * mode.
     *If the Mode value is configured, that SpiMode
     * value will be set in the flags  {@link #flags(Long)}  bit 'm m' 1:0
     * 
     *
     * @param mode a {@link com.pi4j.io.spi.SpiMode} object.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder mode(SpiMode mode);

    /**
     * mode.
     *
     * @param mode a {@link java.lang.Integer} object.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    default SpiConfigBuilder mode(Integer mode){ return mode(SpiMode.getByNumber(mode)); }

    /**
     * flags.
     *
     * @param flags a {@link java.lang.Long} value.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder flags(Long flags);

    /**
     * channel. (ALIAS for 'address')
     *
     * @param channel a {@link java.lang.Integer} value.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder channel(Integer channel);

    /**
     * chipSelect. (ALIAS for 'address')
     *
     * @param chipSelect a {@link com.pi4j.io.spi.SpiChipSelect} value.
     * @return a {@link com.pi4j.io.spi.SpiConfigBuilder} object.
     */
    SpiConfigBuilder chipSelect(SpiChipSelect chipSelect);
}