org.rifidi.edge.sensors

Class AbstractGPIOService<T extends AbstractSensorSession>

java.lang.Object

org.rifidi.edge.sensors.AbstractGPIOService<T>

Direct Known Subclasses:

AlienGPIOService, AwidGPIOService, LLRPGPIOService

public abstract class AbstractGPIOService<T extends AbstractSensorSession>
extends java.lang.Object

This class is a service to be implemented by readers plugins which have GPIO capabilities. It should be exported to the osgi registry under this interface and should be exported with a service property called 'reader' which is the ID of the ReaderFactory it is used with. In addition spring should inject the ReaderDAO.

Author:

Kyle Neumeier

Constructor Summary

Constructors

Constructor and Description
AbstractGPIOService()

Method Summary

Methods

Modifier and Type	Method and Description
void	flashGPO(java.lang.String readerID, int flashTime, java.lang.Integer... ports) This method flashes External Output to high for a specified number of seconds.
abstract void	flashGPO(java.lang.String readerID, int flashTime, java.util.Set<java.lang.Integer> ports) This method flashes External Output to high for a specified number of seconds.
boolean	isReaderAvailable(java.lang.String readerID) Returns true if a reader with the given ID is available to this service.
abstract void	setGPO(java.lang.String readerID, java.util.Collection<java.lang.Integer> ports) This method sets the output ports on a reader
void	setGPO(java.lang.String readerID, java.lang.Integer... ports) This method sets the output ports on a reader
void	setReaderDAO(ReaderDAO readerDAO)
abstract boolean	testGPI(java.lang.String readerID, int port) Tests the current state of the port

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGPIOService

public AbstractGPIOService()

Method Detail

setGPO

public abstract void setGPO(java.lang.String readerID,
          java.util.Collection<java.lang.Integer> ports)
                     throws CannotExecuteException

This method sets the output ports on a reader

Parameters:

readerID - The readerID of the reader

ports - The ports to set high. All other ports will be set low. Port 0 is the lowest port.

Throws:

CannotExecuteException - If the ports cannot be set for some reason.

setGPO

public void setGPO(java.lang.String readerID,
          java.lang.Integer... ports)
            throws CannotExecuteException

This method sets the output ports on a reader

Parameters:

readerID - The readerID of the reader

ports - The ports to set high. All other ports will be set low. Port 0 is the lowest port.

Throws:

CannotExecuteException - If the ports cannot be set for some reason.

flashGPO

public abstract void flashGPO(java.lang.String readerID,
            int flashTime,
            java.util.Set<java.lang.Integer> ports)
                       throws CannotExecuteException

This method flashes External Output to high for a specified number of seconds.

Parameters:

readerID - The readerID of the reader

flashTime - The time in seconds to hold the ports high

ports - The ports to flash. Port 0 is the lowest port

Throws:

CannotExecuteException - If the ports cannot be flashed for some reason

flashGPO

public void flashGPO(java.lang.String readerID,
            int flashTime,
            java.lang.Integer... ports)
              throws CannotExecuteException

This method flashes External Output to high for a specified number of seconds.

Parameters:

readerID - The readerID of the reader

flashTime - The time in seconds to hold the ports high

ports - The ports to flash. Port 0 is the lowest port.

Throws:

CannotExecuteException - If the ports cannot be flashed for some reason

testGPI

public abstract boolean testGPI(java.lang.String readerID,
              int port)
                         throws CannotExecuteException

Tests the current state of the port

Parameters:

readerID - The readerID of the reader

port - The port to test. Port 0 represents the lowest port

Returns:

true if the port is high, false if it is low

Throws:

CannotExecuteException

setReaderDAO

public void setReaderDAO(ReaderDAO readerDAO)

Parameters:

readerDAO - the readerDAO to set

isReaderAvailable

public boolean isReaderAvailable(java.lang.String readerID)

Returns true if a reader with the given ID is available to this service.

Parameters:

readerID -

Returns: