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

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

import java.util.Map;

/**
 * DefaultSpiConfig class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class DefaultSpiConfig
        extends IOAddressConfigBase
        implements SpiConfig {

    // private configuration properties
    protected final Integer baud;
    protected final SpiMode mode;
    protected boolean modeUserProvided = false;  // indicate user supplied the value
    protected final SpiBus bus;
    protected boolean busUserProvided = false;  // indicate user supplied the value
    protected final Long flags;

    /**
     * PRIVATE CONSTRUCTOR
     *
     * @param properties a {@link java.util.Map} object.
     */
    protected DefaultSpiConfig(Map properties){
        super(properties);

        // load optional BAUD RATE from properties
        if(properties.containsKey(BAUD_KEY)){
            this.baud = StringUtil.parseInteger(properties.get(BAUD_KEY), Spi.DEFAULT_BAUD);
        } else {
            this.baud = Spi.DEFAULT_BAUD;
        }

        // load optional BUS from properties
        if(properties.containsKey(BUS_KEY)){
            this.bus = SpiBus.parse(properties.get(BUS_KEY));
            this.busUserProvided = true;
        } else {
            this.bus = Spi.DEFAULT_BUS;
            this.busUserProvided = false;
        }

        // load optional MODE from properties
        if(properties.containsKey(MODE_KEY)){
            this.mode = SpiMode.parse(properties.get(MODE_KEY));
            this.modeUserProvided = true;
        } else {
            this.mode = Spi.DEFAULT_MODE;
            this.modeUserProvided = false;
        }

        // load optional FLAGS BITS from properties
        if(properties.containsKey(FLAGS_KEY)){
            this.flags = StringUtil.parseLong(properties.get(FLAGS_KEY), null);
        } else {
            this.flags = 0L; // default flags (0)
        }

        // define default property values if any are missing (based on the required address value)
        this.id = StringUtil.setIfNullOrEmpty(this.id, "SPI-" + this.address(), true);
        this.name = StringUtil.setIfNullOrEmpty(this.name, "SPI-" + this.address(), true);
        this.description = StringUtil.setIfNullOrEmpty(this.description, "SPI-" + this.address(), true);
    }

    /** {@inheritDoc} */
    @Override
    public Integer baud() {
        return this.baud;
    }

    /** {@inheritDoc} */
    @Override
    public boolean busUserProvided() {
        return this.busUserProvided;
    }



    /** {@inheritDoc} */
    @Override
    public boolean modeUserProvided()
    {
        return this.modeUserProvided;
    }

    /** {@inheritDoc} */
    @Override
    public SpiBus bus() {
        return this.bus;
    }

    /** {@inheritDoc} */
    @Override
    public SpiMode mode() {
        return this.mode;
    }

    /** {@inheritDoc} */
    @Override
    public Long flags() { return this.flags; }

    /** {@inheritDoc} */
    @Override
    public Integer channel() {
        return this.address();
    }

    /** {@inheritDoc} */
    @Override
    public SpiChipSelect chipSelect() {
        return SpiChipSelect.getByNumber(this.address());
    }
}