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

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DefaultI2CConfig.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.exception.ConfigMissingRequiredKeyException;
import com.pi4j.io.gpio.digital.PullResistance;
import com.pi4j.io.i2c.I2CConfig;
import com.pi4j.io.impl.IOConfigBase;
import com.pi4j.util.StringUtil;

import java.util.Map;

/**
 * DefaultI2CConfig class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class DefaultI2CConfig
        extends IOConfigBase
        implements I2CConfig {

    // private configuration properties
    protected Integer bus = null;
    protected Integer device = null;

    /**
     * PRIVATE CONSTRUCTOR
     */
    private DefaultI2CConfig(){
        super();
    }

    // private configuration properties
    protected PullResistance pullResistance = PullResistance.OFF;

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

        // load (required) BUS property
        if(properties.containsKey(BUS_KEY)){
            this.bus = Integer.parseInt(properties.get(BUS_KEY));
        } else {
            throw new ConfigMissingRequiredKeyException(BUS_KEY);
        }

        // load (required) DEVICE property
        if(properties.containsKey(DEVICE_KEY)){
            this.device = Integer.parseInt(properties.get(DEVICE_KEY));
        } else {
            throw new ConfigMissingRequiredKeyException(DEVICE_KEY);
        }

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

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

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