com.pi4j.plugin.pigpio.provider.pwm.PiGpioPwmProviderImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-plugin-pigpio Show documentation
Pi4J Plugin for the PIGPIO I/O Providers
The newest version!
package com.pi4j.plugin.pigpio.provider.pwm;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: PLUGIN   :: PIGPIO I/O Providers
 * FILENAME      :  PiGpioPwmProviderImpl.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import com.pi4j.boardinfo.util.BoardInfoHelper;
import com.pi4j.io.pwm.Pwm;
import com.pi4j.io.pwm.PwmConfig;
import com.pi4j.io.pwm.PwmProviderBase;
import com.pi4j.io.pwm.PwmType;
import com.pi4j.library.pigpio.PiGpio;

/**
 * PiGpioPwmProviderImpl class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class PiGpioPwmProviderImpl extends PwmProviderBase implements PiGpioPwmProvider {

    final PiGpio piGpio;

    /**
     * Constructor for PiGpioPwmProviderImpl.
     *
     * @param piGpio a {@link com.pi4j.library.pigpio.PiGpio} object.
     */
    public PiGpioPwmProviderImpl(PiGpio piGpio) {
        this.id = ID;
        this.name = NAME;
        this.piGpio = piGpio;
    }

    @Override
    public int getPriority() {
        // the Pigpio driver should be higher priority when NOT on RP1 chip.
        return BoardInfoHelper.usesRP1() ? 50 : 100;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Pwm create(PwmConfig config) {
        synchronized (this.piGpio) {
            // initialize the PIGPIO library
            if (!piGpio.isInitialized())
                piGpio.initialize();

            // create new I/O instance based on I/O config
            Pwm pwm;
            if (config.pwmType() == PwmType.HARDWARE) {
                pwm = new PiGpioPwmHardware(piGpio, this, config);
            } else {
                pwm = new PiGpioPwmSoftware(piGpio, this, config);
            }
            this.context.registry().add(pwm);
            return pwm;
        }
    }
}