com.ociweb.iot.maker.Hardware Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of foglight Show documentation
FogLight is a lightweight runtime that enables makers of all ages and skill levels to create highly performant apps for embedded devices like Raspberry Pi's.
The newest version!
package com.ociweb.iot.maker;

import com.ociweb.gl.api.Builder;
import com.ociweb.iot.hardware.ADIODevice;
import com.ociweb.iot.hardware.I2CIODevice;
import com.ociweb.iot.hardware.IODevice;

import java.nio.file.Path;

/**
 * Base interface for an IoT device's hardware.
 * 
 * This interface is most commonly used in conjunction with a call
 * to IoTSetup declareConnections in order for
 * a maker's code to declare any hardware connections and resources
 * that it makes use of.
 *
 * @author Nathan Tippy
 */
public interface Hardware extends Builder {

    /**
     * Sets the frequency at which images are taken on this hardware.
     *
     * @param triggerRateMillis Number of milliseconds between image capture events.
     *
     * @return A reference to this hardware instance.
     */
    Hardware setImageTriggerRate(int triggerRateMillis);

    /**
     * Sets the size of images that are taken on this hardware.
     *
     * @param width Width in pixels of the images.
     * @param height Height in pixels of the images.
     *
     * @return A reference to this hardware instance.
     */
    Hardware setImageSize(int width, int height);

    /**
     * Sets the directory to load images from during testing.
     *
     * @param path A {@link Path} to load images from during testing.
     *
     * @return A reference to this hardware instance.
     *
     * @throws UnsupportedOperationException If {@link #isTestHardware()} is false.
     */
    Hardware setTestImageSource(Path path) throws UnsupportedOperationException;

    /**
     * Connects a new {@link IODevice} to this hardware on a given {@link Port}.
     *
     * @param device {@link IODevice} to connect.
     * @param port {@link Port} to connect the device to.
     * @param customRateMS Optional rate in milliseconds to update the device data. TODO: Correct?
     * @param customAvgWinMS Optional rate in milliseconds to sample device data. TODO: Correct?
     * @param everyValue Optional; if set to true, will cause the device to trigger events on every update. TODO: Correct?
     *
     * @return A reference to this hardware instance.
     */
    Hardware connect(ADIODevice device, Port port, int customRateMS, int customAvgWinMS, boolean everyValue);
    /**
     * 
     * @param device {@link IODevice} to connect.
     * @param port {@link Port} to connect the device to.
     * @param customRateMS Optional rate in milliseconds to update the device data.
     * @param customAvgWinMS Optional rate in milliseconds to sample device data.
     * @return  A reference to this hardware instance.
     */
    Hardware connect(ADIODevice device, Port port, int customRateMS, int customAvgWinMS);
    /**
     * 
     * @param device {@link IODevice} to connect.
     * @param port {@link Port} to connect the device to.
     * @param customRateMS Optional rate in milliseconds to update the device data.
     * @return A reference to this hardware instance.
     */
    Hardware connect(ADIODevice device, Port port, int customRateMS);
    /**
     * 
     * @param device {@link IODevice} to connect.
     * @param port {@link Port} to connect the device to.
     * @param customRateMS Optional rate in milliseconds to update the device data.
     * @param everyValue Optional; if set to true, will cause the device to trigger events on every update.
     * @return A reference to this hardware instance.
     */
    Hardware connect(ADIODevice device, Port port, int customRateMS, boolean everyValue);
    /**
     * 
     * @param device {@link IODevice} to connect.
     * @param port {@link Port} to connect the device to.
     * @return A reference to this hardware instance.
     */
    Hardware connect(ADIODevice device, Port port);

    /**
     * calls connectI2C to connect the I2C IODevice
     * @param device
     * @return A reference to this hardware instance
     */
    Hardware connect(I2CIODevice device);
    
    /**
     * calls connectI2C to connect the I2C IODevice
     * @param device
     * @param customRateMS
     * @return A reference to this hardware instance
     */
    
    Hardware connect(I2CIODevice device, int customRateMS);
  
 
    
    /**
     * Asks this hardware instance to enable I2C communications on the default I2C bus.
     *
     * @return A reference to this hardware instance.
     */
    Hardware useI2C();

    /**
     * Asks this hardware instance to enable I2C communications.
     *
     * @param bus I2C bus to use.
     *
     * @return A reference to this hardware instance.
     */
    Hardware useI2C(int bus);
    
    Hardware useSerial(Baud baud);
    
	/**
     *             
	 * @param baud
	 * @param device Name of the port. On UNIX systems this will typically
     *             be of the form /dev/ttyX, where X is a port number. On
     *             Windows systems this will typically of the form COMX,
     *             where X is again a port number.
	 */
    Hardware useSerial(Baud baud, String device);
   
    Hardware setLocationDataFilePath(String path); 
    
    boolean isTestHardware();
   
}