com.diozero.internal.spi.AbstractDeviceFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diozero-core Show documentation
There is a newer version: 1.4.0
package com.diozero.internal.spi;

/*
 * #%L
 * Organisation: diozero
 * Project:      diozero - Core
 * Filename:     AbstractDeviceFactory.java
 * 
 * This file is part of the diozero project. More information about this project
 * can be found at https://www.diozero.com/.
 * %%
 * Copyright (C) 2016 - 2021 diozero
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */

import org.tinylog.Logger;

import com.diozero.api.PinInfo;
import com.diozero.internal.DeviceStates;
import com.diozero.sbc.DeviceFactoryHelper;

/**
 * Base class for all device factories, including custom board-specific provider
 * implementations (e.g. pigpio) as
 * well as expansion boards (e.g. the {@link com.diozero.devices.McpAdc MCP
 * 3xxx} family of analog-to-digital converters).
 */
public abstract class AbstractDeviceFactory implements DeviceFactoryInterface {
	private String deviceFactoryPrefix;
	protected DeviceStates deviceStates;
	protected boolean closed;

	public AbstractDeviceFactory(String deviceFactoryPrefix) {
		this.deviceFactoryPrefix = deviceFactoryPrefix;
		deviceStates = new DeviceStates();

		// Register all expansion boards so that they can be cleaned up on shutdown
		if (!(this instanceof BaseNativeDeviceFactory)) {
			DeviceFactoryHelper.getNativeDeviceFactory().registerDeviceFactory(this);
		}
	}

	@Override
	public void close() {
		if (!closed) {
			Logger.trace("close()");
			deviceStates.closeAll();
			closed = true;
		}
	}

	@Override
	public final boolean isClosed() {
		return closed;
	}

	@Override
	public void reopen() {
		Logger.trace("reopen()");
		start();
		closed = false;
	}

	@Override
	public final boolean isDeviceOpened(String key) {
		return deviceStates.isOpened(key);
	}

	@Override
	public final void deviceOpened(InternalDeviceInterface device) {
		Logger.trace("Device opened, key = {}", device.getKey());
		deviceStates.opened(device);
	}

	@Override
	public final void deviceClosed(InternalDeviceInterface device) {
		Logger.trace("Device closed, key = {}", device.getKey());
		deviceStates.closed(device);
	}

	/**
	 * Convenience method to get a device of the specified type and key. Consumers
	 * must ensure that the return type is correct to prevent class cast exceptions.
	 *
	 * @param key device key
	 * @return the device or null if not found
	 */
	@Override
	@SuppressWarnings("unchecked")
	public final  T getDevice(String key) {
		return (T) deviceStates.getDevice(key);
	}

	@Override
	public final String createPinKey(PinInfo pinInfo) {
		return deviceFactoryPrefix + "-" + pinInfo.getKeyPrefix() + "-" + pinInfo.getDeviceNumber();
	}

	@Override
	public final String createPwmPinKey(PinInfo pinInfo) {
		return deviceFactoryPrefix + "-" + pinInfo.getKeyPrefix() + "-" + pinInfo.getDeviceNumber();
	}

	@Override
	public final String createServoPinKey(PinInfo pinInfo) {
		return deviceFactoryPrefix + "-" + pinInfo.getKeyPrefix() + "-" + pinInfo.getDeviceNumber();
	}

	@Override
	public final String createI2CKey(int controller, int address) {
		return I2CDeviceFactoryInterface.createI2CKey(deviceFactoryPrefix, controller, address);
	}

	@Override
	public final String createSpiKey(int controller, int chipSelect) {
		return SpiDeviceFactoryInterface.createSpiKey(deviceFactoryPrefix, controller, chipSelect);
	}

	@Override
	public final String createSerialKey(String deviceFile) {
		return SerialDeviceFactoryInterface.createSerialKey(deviceFactoryPrefix, deviceFile);
	}
}