com.pi4j.io.spi.SpiFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of osgi.enroute.iot.pi.provider Show documentation
Show all versions of osgi.enroute.iot.pi.provider Show documentation
This bundle wraps Pi4j (http://pi4j.com) that wraps the native code Wiring Pi (http://wiringpi.com). It wraps these libraries to make them OSGi friendly and allow them to work together with the OSGi enRoute IoT circuit library (osgi.enroute.iot.circuit). The bundle will first use Pi4J to detect on what hardware it runs. If it runs on an appropriate type, it will register a component that can be configured with Metatype. The Metatype defines a full blown configuration template for all the Pi's functions. The GPIO's are registered as components for the circuit. Regardless of the success of the configuration, this bundle will also register a GpioController service, which is the main Pi4J class.
The newest version!
package com.pi4j.io.spi;
/*
* #%L
* **********************************************************************
* ORGANIZATION : Pi4J
* PROJECT : Pi4J :: Java Library (Core)
* FILENAME : SpiFactory.java
*
* This file is part of the Pi4J project. More information about
* this project can be found here: http://www.pi4j.com/
* **********************************************************************
* %%
* Copyright (C) 2012 - 2015 Pi4J
* %%
* 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.io.spi.impl.SpiDeviceImpl;
import java.io.IOException;
/**
* SPI factory - it returns instances of {@link com.pi4j.io.spi.SpiDevice} interface.
*
* @author Robert Savage (http://www.savagehomeautomation.com)
*/
public class SpiFactory {
// private constructor
private SpiFactory() {
// forbid object construction
}
/**
* Create new SpiDevice instance with a default SPI speed of 1 MHz.
*
* @param channel
* spi channel to use
*
* @return Return a new SpiDevice impl instance.
*
* @throws java.io.IOException
*/
public static SpiDevice getInstance(SpiChannel channel) throws IOException {
return new SpiDeviceImpl(channel);
}
/**
* Create new SpiDevice instance
*
* @param channel
* spi channel to use
* @param mode
* spi mode (see http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Mode_numbers)
*
* @return Return a new SpiDevice impl instance.
*
* @throws java.io.IOException
*/
public static SpiDevice getInstance(SpiChannel channel, SpiMode mode) throws IOException {
return new SpiDeviceImpl(channel, mode);
}
/**
* Create new SpiDevice instance
*
* @param channel
* spi channel to use
* @param speed
* spi speed/rate (in Hertz) for channel to communicate at
* (range is 500kHz - 32MHz)
*
* @return Return a new SpiDevice impl instance.
*
* @throws java.io.IOException
*/
public static SpiDevice getInstance(SpiChannel channel, int speed) throws IOException {
return new SpiDeviceImpl(channel, speed);
}
/**
* Create new SpiDevice instance
*
* @param channel
* spi channel to use
* @param speed
* spi speed/rate (in Hertz) for channel to communicate at
* (range is 500kHz - 32MHz)
* @param mode
* spi mode (see http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Mode_numbers)
*
* @return Return a new SpiDevice impl instance.
*
* @throws java.io.IOException
*/
public static SpiDevice getInstance(SpiChannel channel, int speed, SpiMode mode) throws IOException {
return new SpiDeviceImpl(channel, speed, mode);
}
}