RifidiWiki - User contributions [en]

READERNAME ReaderModuleSuspendPowerState.java

2009-06-10T14:20:55Z

Stefan: /* resume */

[[category:developerDoc]][[category:emulatorDoc]]
This class needs to be implemented for each reader to handle the state transitions from off->on. It should extend AbstractSuspendedPowerState.

=resume=

This method should turn the reader and all of its components back on after having been suspended

<pre>resume(PowerControllable pcObject)</pre>

==Arguments==
#pcObject - The ReaderModule

==Reference Implementation==
This is the implementation of the resume() method in the symbol reader. It first resumes the communications and the controllers. Then it changes the power state to the OnPowerSate using the changePowerState method. If the reader that you are implementing has an autonomous mode, you will need to resume the autonomous mode as well. See the LLRP reader for an example of that.
<pre>
public void resume(PowerControllable pcObject) {
SymbolReaderModule rm = (SymbolReaderModule) pcObject;

rm.getByteComm().resume();
rm.getHttpComm().resume();

rm.getInteractiveBitController().resume();
rm.getInteractiveHttpController().resume();

SymbolReaderSharedResources ssr = rm.getSharedResources();

ssr.getTagMemory().resume();

rm.changePowerState(SymbolReaderModuleOnPowerState.getInstance());

String readername = rm.getSharedResources().getReaderName();
LogFactory.getLog("console." + readername).info(readername + " resumed");
}
</pre>

=turnOff=

See [[READERNAME_ReaderModuleOnPowerState.java#turnOff]]

Reader Guides

2009-06-09T09:26:39Z

Stefan: /* Virtual RFID Reader User's guides */

=Virtual RFID Reader User's guides=
The following pages contain information about how to use and develop with specific virtual readers.
*[[LLRP_Reader |LLRP Reader]]
*[[Alien 9800]]
*[[Symbol XR440]]
*[[Awid MPR ]]
*[[EPC Reader| EPC V1.1 ]]
*[[ThingMagic]]
*[[Sirit INfinity510|Sirit INfinity510 (work in progress)]]

Sirit Example Client

2009-05-27T14:01:55Z

Stefan:

This class shows how to create a program to talk to the Sirit INfinity 510 reader.

<pre>
/*
* SimpleSiritClient.java
*
* Created: 27.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
* Author: Stefan Fahrnbauer - stefan@pramari.com
*/
package sandbox;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;

/**
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/
public class SimpleSiritClient {

String ipAddress = "192.168.11.130";
Socket sock;
int port = 50007;
BufferedReader reader;
PrintWriter writer;

Future<String> future;

/**
* @param args
*/
public static void main(String[] args) {
SimpleSiritClient client = new SimpleSiritClient();
client.go();
}

/**
* executes the application
*/
public void go() {

setUpNetworking();

String command = "";

// Login to reader
command = "reader.login(login=admin,pwd=readeradmin)";
processCommand(command);

// let the reader scan for tags for 3 seconds
command = "tag.db.scan_tags(3000)";
processCommand(command);

tearDown();
}

/**
* initializes the connection
*/
public void setUpNetworking() {
try {
// connection for submitting commands
sock = new Socket(this.ipAddress, this.port);
reader = new BufferedReader(new InputStreamReader(sock
.getInputStream()));
writer = new PrintWriter(sock.getOutputStream());
} catch (IOException ex) {
ex.printStackTrace();
}
}

/**
* closes the connection
*/
public void tearDown() {
try {
sock.close();
} catch (IOException ex) {
ex.printStackTrace();
}
}

/**
* process command, get response and write to log
*/
public void processCommand(String command) {

// create callable to read response
ExecutorService pool = Executors.newFixedThreadPool(2);
// Callable for Commandchannel
Callable<String> callable = new IncomingCallable();
future = pool.submit(callable);

// send command to reader
sendCommand(command);

// write to log window
System.out.println(">>" + command + "\r\n");

// receive and write response
System.out.println(getLastResponse());
}

/**
* sends command to reader
*/
public void sendCommand(String command) {
// send command to reader
writer.print(command + "\r\n");
writer.flush();
}

/**
* waits for and returns the reader's response
*/
public String getLastResponse() {
String response = "";
try {
response = future.get();
} catch (Exception e) {
e.printStackTrace();
}
return response;
}

public class IncomingCallable implements Callable<String> {
PrintWriter writer;
String command;

public String call() {
// get response
String message = "";
String lastResponse = "";
try {
while (lastResponse.indexOf("\r\n\r\n") == -1) {
message = reader.readLine();
message = message.replace("\r", "").replace("\n", "")
+ "\r\n";
lastResponse = lastResponse.concat(message);
}
} catch (Exception ex) {
ex.printStackTrace();
}
return lastResponse;
}
}

}
</pre>

Sirit Example Client

2009-05-27T13:59:41Z

Stefan:

This class shows how to create a program to talk to the Sirit INfinity 510 reader.

<pre>
/*
* SimpleSiritClientNoGUI.java
*
* Created: 27.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
* Author: Stefan Fahrnbauer - stefan@pramari.com
*/
package sandbox;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;

/**
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/
public class SimpleSiritClientNoGUI {

String ipAddress = "192.168.11.130";
Socket sock;
int port = 50007;
BufferedReader reader;
PrintWriter writer;

Future<String> future;

/**
* @param args
*/
public static void main(String[] args) {
SimpleSiritClientNoGUI client = new SimpleSiritClientNoGUI();
client.go();
}

/**
* executes the application
*/
public void go() {

setUpNetworking();

String command = "";

// Login to reader
command = "reader.login(login=admin,pwd=readeradmin)";
processCommand(command);

// let the reader scan for tags for 3 seconds
command = "tag.db.scan_tags(3000)";
processCommand(command);

tearDown();
}

/**
* initializes the connection
*/
public void setUpNetworking() {
try {
// connection for submitting commands
sock = new Socket(this.ipAddress, this.port);
reader = new BufferedReader(new InputStreamReader(sock
.getInputStream()));
writer = new PrintWriter(sock.getOutputStream());
} catch (IOException ex) {
ex.printStackTrace();
}
}

/**
* closes the connection
*/
public void tearDown() {
try {
sock.close();
} catch (IOException ex) {
ex.printStackTrace();
}
}

/**
* process command, get response and write to log
*/
public void processCommand(String command) {

// create callable to read response
ExecutorService pool = Executors.newFixedThreadPool(2);
// Callable for Commandchannel
Callable<String> callable = new IncomingCallable();
future = pool.submit(callable);

// send command to reader
sendCommand(command);

// write to log window
System.out.println(">>" + command + "\r\n");

// receive and write response
System.out.println(getLastResponse());
}

/**
* sends command to reader
*/
public void sendCommand(String command) {
// send command to reader
writer.print(command + "\r\n");
writer.flush();
}

/**
* waits for the reader's response
*/
public String getLastResponse() {
String response = "";
try {
response = future.get();
} catch (Exception e) {
e.printStackTrace();
}
return response;
}

public class IncomingCallable implements Callable<String> {
PrintWriter writer;
String command;

public String call() {
// get response
String message = "";
String lastResponse = "";
try {
while (lastResponse.indexOf("\r\n\r\n") == -1) {
message = reader.readLine();
message = message.replace("\r", "").replace("\n", "")
+ "\r\n";
lastResponse = lastResponse.concat(message);
}
} catch (Exception ex) {
ex.printStackTrace();
}
return lastResponse;
}
}

}
</pre>

Sirit Example Client RAPID

2009-05-27T12:29:46Z

Stefan: New page: This class shows how to create a program to talk to the Sirit INfinity 510 reader with the use of Sirit's RAPID API. <pre> /* * SiritClientRAPID.java * * Created: 07.05.2009 * Proj...

This class shows how to create a program to talk to the Sirit INfinity 510 reader with the use of Sirit's RAPID API.

<pre>
/*
* SiritClientRAPID.java
*
* Created: 07.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
* Author: Stefan Fahrnbauer - stefan@pramari.com
*/
package sandbox;

/**
* This class shows how to create a program to talk to the Sirit INfinity 510 reader
* with the use of Sirit's RAPID API.
*
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/

import com.sirit.data.DataManager;
import com.sirit.driver.IEventListener;
import com.sirit.mapping.EventInfo;
import com.sirit.mapping.InfoManager;
import com.sirit.mapping.ReaderManager;
import com.sirit.mapping.SetupManager;
import com.sirit.mapping.TagManager;
import com.sirit.mapping.TagResponse;
import com.sirit.mapping.TagResponseList;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.Socket;

public class SiritClientRAPID implements IEventListener {

/*
* IP Address of the reader
*/
private String ipAddress = "192.168.11.130";

/**
* Constructor
*/
public SiritClientRAPID() {
}

/**
* Constructor - with IP Address
*
* @param ipAddr
* IP Address for the reader
*/
public SiritClientRAPID(String ipAddress) {
super();
this.ipAddress = ipAddress;
}

/**
* Executes the application
*/
public void run() {
try {
long startTime = System.currentTimeMillis();

// Open a connection to the reader
DataManager dataManager = new DataManager(
DataManager.ConnectionTypes.SOCKET, ipAddress, 0);
dataManager.open();
System.out.println("Connection Opened");

// Get the reader's name
InfoManager infoManager = new InfoManager(dataManager);
String v = infoManager.getName();
System.out.println("Name: " + v);
infoManager = null;

// Login as administrator
ReaderManager readerManager = new ReaderManager(dataManager);
if (!readerManager.login("admin", "readeradmin"))
throw new Exception("Login attempt failed: "
+ readerManager.getLastErrorMessage());
v = readerManager.whoAmI();
System.out.println("Login: " + v);

// Open an event channel and get it's ID
String id = dataManager.getEventChannel(this);
System.out.println("Event Channel ID: " + id);

// Register for event.tag.report
if (!readerManager.eventsRegister(id, "event.tag.report"))
throw new Exception("Failure to register for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Registered for event.tag.report");

// Set operating mode to active
SetupManager setupManager = new SetupManager(dataManager);
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.ACTIVE);
System.out.println("Operating Mode: Active for 5 seconds");

// Sleep while handling tag events
Thread.sleep(5000);

// Unregister for event.tag.report
if (!readerManager.eventsUnregister(id, "event.tag.report"))
throw new Exception("Failure to unregister for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Unregistered for event.tag.report");

// Set operating mode to standby
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.STANDBY);
System.out.println("Operating Mode: Standby");

// List the TagDB
System.out.println("Detected Tags:");
TagManager tagManager = new TagManager(dataManager);
TagResponseList tagList = tagManager.dbGet("", "");

TagResponse tagResponse;
for (int tagResponseID = 0; tagResponseID < tagList.getCount(); tagResponseID++) {
tagResponse = tagList.getTagResponse(tagResponseID);
System.out.println("TagID: " + tagResponse.getTagId());
System.out.println("\tAntenna: " + tagResponse.getAntenna());
System.out.println("\tCount: " + tagResponse.getRepeat());
System.out.println("\t1st Time: " + tagResponse.getFirst());
System.out.println("\tLast Time: " + tagResponse.getLast());

}

// Close the connection
setupManager = null;
readerManager = null;
dataManager.close();
System.out.println("Connection Closed");

// Output the time to execute application
long endTime = System.currentTimeMillis();
long t = endTime - startTime - 500;
System.out.println("Estimated Time: " + t + "(ms)");
} catch (Exception e) {
System.out.println("Error: " + e.getMessage());
}
}

/**
* Main method for this demo application
*
* @param args
* Command line arguments first argument -IP Address of the
* reader (optional)
*/
public static void main(String[] args) {
// Create SiritClient object
SiritClientRAPID scApp;
if (args.length > 0)
scApp = new SiritClientRAPID(args[0]);
else
scApp = new SiritClientRAPID();

// Execute the application
scApp.run();
System.out.println("Exiting");
System.exit(0);

}

/**
* Event Handler
*/
public void EventFound(Object sender, EventInfo eventInfo) {
String tagID = eventInfo
.getParameter(EventInfo.EVENT_TAG_ARRIVE_PARAMS.TAG_ID);
System.out.println("Tag ID: " + tagID);
}

}
</pre>

Sirit Example Client

2009-05-27T12:26:39Z

Stefan:

Sirit Example Client

2009-05-27T12:21:21Z

Stefan:

You can see a list of possible alien commands by sending the 'help' command to the alien reader. However, not all of these commands are implemented in rifidi. See this [[Sirit_INfinity510#Supported Commands | List of supported commands]].

<pre>
/*
* SiritClientRAPID.java
*
* Created: 07.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
* Author: Stefan Fahrnbauer - stefan@pramari.com
*/
package sandbox;

/**
* This class shows how to create a program to talk to the Sirit INfinity 510 reader
* with the use of Sirit's RAPID API.
*
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/

import com.sirit.data.DataManager;
import com.sirit.driver.IEventListener;
import com.sirit.mapping.EventInfo;
import com.sirit.mapping.InfoManager;
import com.sirit.mapping.ReaderManager;
import com.sirit.mapping.SetupManager;
import com.sirit.mapping.TagManager;
import com.sirit.mapping.TagResponse;
import com.sirit.mapping.TagResponseList;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.Socket;

public class SiritClientRAPID implements IEventListener {

/*
* IP Address of the reader
*/
private String ipAddress = "192.168.11.130";

/**
* Constructor
*/
public SiritClientRAPID() {
}

/**
* Constructor - with IP Address
*
* @param ipAddr
* IP Address for the reader
*/
public SiritClientRAPID(String ipAddress) {
super();
this.ipAddress = ipAddress;
}

/**
* Executes the application
*/
public void run() {
try {
long startTime = System.currentTimeMillis();

// Open a connection to the reader
DataManager dataManager = new DataManager(
DataManager.ConnectionTypes.SOCKET, ipAddress, 0);
dataManager.open();
System.out.println("Connection Opened");

// Get the reader's name
InfoManager infoManager = new InfoManager(dataManager);
String v = infoManager.getName();
System.out.println("Name: " + v);
infoManager = null;

// Login as administrator
ReaderManager readerManager = new ReaderManager(dataManager);
if (!readerManager.login("admin", "readeradmin"))
throw new Exception("Login attempt failed: "
+ readerManager.getLastErrorMessage());
v = readerManager.whoAmI();
System.out.println("Login: " + v);

// Open an event channel and get it's ID
String id = dataManager.getEventChannel(this);
System.out.println("Event Channel ID: " + id);

// Register for event.tag.report
if (!readerManager.eventsRegister(id, "event.tag.report"))
throw new Exception("Failure to register for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Registered for event.tag.report");

// Set operating mode to active
SetupManager setupManager = new SetupManager(dataManager);
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.ACTIVE);
System.out.println("Operating Mode: Active for 5 seconds");

// Sleep while handling tag events
Thread.sleep(5000);

// Unregister for event.tag.report
if (!readerManager.eventsUnregister(id, "event.tag.report"))
throw new Exception("Failure to unregister for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Unregistered for event.tag.report");

// Set operating mode to standby
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.STANDBY);
System.out.println("Operating Mode: Standby");

// List the TagDB
System.out.println("Detected Tags:");
TagManager tagManager = new TagManager(dataManager);
TagResponseList tagList = tagManager.dbGet("", "");

TagResponse tagResponse;
for (int tagResponseID = 0; tagResponseID < tagList.getCount(); tagResponseID++) {
tagResponse = tagList.getTagResponse(tagResponseID);
System.out.println("TagID: " + tagResponse.getTagId());
System.out.println("\tAntenna: " + tagResponse.getAntenna());
System.out.println("\tCount: " + tagResponse.getRepeat());
System.out.println("\t1st Time: " + tagResponse.getFirst());
System.out.println("\tLast Time: " + tagResponse.getLast());

}

// Close the connection
setupManager = null;
readerManager = null;
dataManager.close();
System.out.println("Connection Closed");

// Output the time to execute application
long endTime = System.currentTimeMillis();
long t = endTime - startTime - 500;
System.out.println("Estimated Time: " + t + "(ms)");
} catch (Exception e) {
System.out.println("Error: " + e.getMessage());
}
}

/**
* Main method for this demo application
*
* @param args
* Command line arguments first argument -IP Address of the
* reader (optional)
*/
public static void main(String[] args) {
// Create SiritClient object
SiritClientRAPID scApp;
if (args.length > 0)
scApp = new SiritClientRAPID(args[0]);
else
scApp = new SiritClientRAPID();

// Execute the application
scApp.run();
System.out.println("Exiting");
System.exit(0);

}

/**
* Event Handler
*/
public void EventFound(Object sender, EventInfo eventInfo) {
String tagID = eventInfo
.getParameter(EventInfo.EVENT_TAG_ARRIVE_PARAMS.TAG_ID);
System.out.println("Tag ID: " + tagID);
}

}
</pre>

Sirit Example Client

2009-05-27T12:20:07Z

Stefan:

You can see a list of possible alien commands by sending the 'help' command to the alien reader. However, not all of these commands are implemented in rifidi. See this [[Sirit_INfinity510#Supported Commands | List of supported commands]].

<pre>
/*
* SiritClientRAPID.java
*
* Created: 07.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
* Author: Stefan Fahrnbauer - stefan@pramari.com
*/
package sandbox;

/**
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/

import com.sirit.data.DataManager;
import com.sirit.driver.IEventListener;
import com.sirit.mapping.EventInfo;
import com.sirit.mapping.InfoManager;
import com.sirit.mapping.ReaderManager;
import com.sirit.mapping.SetupManager;
import com.sirit.mapping.TagManager;
import com.sirit.mapping.TagResponse;
import com.sirit.mapping.TagResponseList;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.Socket;

public class SiritClientRAPID implements IEventListener {

/*
* IP Address of the reader
*/
private String ipAddress = "192.168.11.130";

/**
* Constructor
*/
public SiritClientRAPID() {
}

/**
* Constructor - with IP Address
*
* @param ipAddr
* IP Address for the reader
*/
public SiritClientRAPID(String ipAddress) {
super();
this.ipAddress = ipAddress;
}

/**
* Executes the application
*/
public void run() {
try {
long startTime = System.currentTimeMillis();

// Open a connection to the reader
DataManager dataManager = new DataManager(
DataManager.ConnectionTypes.SOCKET, ipAddress, 0);
dataManager.open();
System.out.println("Connection Opened");

// Get the reader's name
InfoManager infoManager = new InfoManager(dataManager);
String v = infoManager.getName();
System.out.println("Name: " + v);
infoManager = null;

// Login as administrator
ReaderManager readerManager = new ReaderManager(dataManager);
if (!readerManager.login("admin", "readeradmin"))
throw new Exception("Login attempt failed: "
+ readerManager.getLastErrorMessage());
v = readerManager.whoAmI();
System.out.println("Login: " + v);

// Open an event channel and get it's ID
String id = dataManager.getEventChannel(this);
System.out.println("Event Channel ID: " + id);

// Register for event.tag.report
if (!readerManager.eventsRegister(id, "event.tag.report"))
throw new Exception("Failure to register for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Registered for event.tag.report");

// Set operating mode to active
SetupManager setupManager = new SetupManager(dataManager);
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.ACTIVE);
System.out.println("Operating Mode: Active for 5 seconds");

// Sleep while handling tag events
Thread.sleep(5000);

// Unregister for event.tag.report
if (!readerManager.eventsUnregister(id, "event.tag.report"))
throw new Exception("Failure to unregister for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Unregistered for event.tag.report");

// Set operating mode to standby
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.STANDBY);
System.out.println("Operating Mode: Standby");

// List the TagDB
System.out.println("Detected Tags:");
TagManager tagManager = new TagManager(dataManager);
TagResponseList tagList = tagManager.dbGet("", "");

TagResponse tagResponse;
for (int tagResponseID = 0; tagResponseID < tagList.getCount(); tagResponseID++) {
tagResponse = tagList.getTagResponse(tagResponseID);
System.out.println("TagID: " + tagResponse.getTagId());
System.out.println("\tAntenna: " + tagResponse.getAntenna());
System.out.println("\tCount: " + tagResponse.getRepeat());
System.out.println("\t1st Time: " + tagResponse.getFirst());
System.out.println("\tLast Time: " + tagResponse.getLast());

}

// Close the connection
setupManager = null;
readerManager = null;
dataManager.close();
System.out.println("Connection Closed");

// Output the time to execute application
long endTime = System.currentTimeMillis();
long t = endTime - startTime - 500;
System.out.println("Estimated Time: " + t + "(ms)");
} catch (Exception e) {
System.out.println("Error: " + e.getMessage());
}
}

/**
* Main method for this demo application
*
* @param args
* Command line arguments first argument -IP Address of the
* reader (optional)
*/
public static void main(String[] args) {
// Create SiritClient object
SiritClientRAPID scApp;
if (args.length > 0)
scApp = new SiritClientRAPID(args[0]);
else
scApp = new SiritClientRAPID();

// Execute the application
scApp.run();
System.out.println("Exiting");
System.exit(0);

}

/**
* Event Handler
*/
public void EventFound(Object sender, EventInfo eventInfo) {
String tagID = eventInfo
.getParameter(EventInfo.EVENT_TAG_ARRIVE_PARAMS.TAG_ID);
System.out.println("Tag ID: " + tagID);
}

}
</pre>

Sirit Example Client

2009-05-27T12:15:48Z

Stefan: New page: You can see a list of possible alien commands by sending the 'help' command to the alien reader. However, not all of these commands are implemented in rifidi. See this [[Sirit_INfinity510#...

You can see a list of possible alien commands by sending the 'help' command to the alien reader. However, not all of these commands are implemented in rifidi. See this [[Sirit_INfinity510#Supported Commands | List of supported commands]].

<pre>
/*
* SiritClientRAPID.java
*
* Created: 07.05.2009
* Project: RiFidi SiritClient
* http://www.rifidi.org
* http://rifidi.sourceforge.net
* Copyright: Pramari LLC and the Rifidi Project
* License: Lesser GNU Public License (LGPL)
* http://www.opensource.org/licenses/lgpl-license.html
*/
package sandbox;

/**
* @author Stefan Fahrnbauer - stefan@pramari.com
*
*/

import com.sirit.data.DataManager;
import com.sirit.driver.IEventListener;
import com.sirit.mapping.EventInfo;
import com.sirit.mapping.InfoManager;
import com.sirit.mapping.ReaderManager;
import com.sirit.mapping.SetupManager;
import com.sirit.mapping.TagManager;
import com.sirit.mapping.TagResponse;
import com.sirit.mapping.TagResponseList;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.net.Socket;

public class SiritClientRAPID implements IEventListener {

/*
* IP Address of the reader
*/
private String ipAddress = "192.168.11.130";

/**
* Constructor
*/
public SiritClientRAPID() {
}

/**
* Constructor - with IP Address
*
* @param ipAddr
* IP Address for the reader
*/
public SiritClientRAPID(String ipAddress) {
super();
this.ipAddress = ipAddress;
}

/**
* Executes the application
*/
public void run() {
try {
long startTime = System.currentTimeMillis();

// Open a connection to the reader
DataManager dataManager = new DataManager(
DataManager.ConnectionTypes.SOCKET, ipAddress, 0);
dataManager.open();
System.out.println("Connection Opened");

// Get the reader's name
InfoManager infoManager = new InfoManager(dataManager);
String v = infoManager.getName();
System.out.println("Name: " + v);
infoManager = null;

// Login as administrator
ReaderManager readerManager = new ReaderManager(dataManager);
if (!readerManager.login("admin", "readeradmin"))
throw new Exception("Login attempt failed: "
+ readerManager.getLastErrorMessage());
v = readerManager.whoAmI();
System.out.println("Login: " + v);

// Open an event channel and get it's ID
String id = dataManager.getEventChannel(this);
System.out.println("Event Channel ID: " + id);

// Register for event.tag.report
if (!readerManager.eventsRegister(id, "event.tag.report"))
throw new Exception("Failure to register for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Registered for event.tag.report");

// Set operating mode to active
SetupManager setupManager = new SetupManager(dataManager);
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.ACTIVE);
System.out.println("Operating Mode: Active for 5 seconds");

// Sleep while handling tag events
Thread.sleep(5000);

// Unregister for event.tag.report
if (!readerManager.eventsUnregister(id, "event.tag.report"))
throw new Exception("Failure to unregister for event: "
+ readerManager.getLastErrorMessage());
System.out.println("Unregistered for event.tag.report");

// Set operating mode to standby
setupManager
.setOperatingMode(SetupManager.OPERATING_MODE_TYPES.STANDBY);
System.out.println("Operating Mode: Standby");

// List the TagDB
System.out.println("Detected Tags:");
TagManager tagManager = new TagManager(dataManager);
TagResponseList tagList = tagManager.dbGet("", "");

TagResponse tagResponse;
for (int tagResponseID = 0; tagResponseID < tagList.getCount(); tagResponseID++) {
tagResponse = tagList.getTagResponse(tagResponseID);
System.out.println("TagID: " + tagResponse.getTagId());
System.out.println("\tAntenna: " + tagResponse.getAntenna());
System.out.println("\tCount: " + tagResponse.getRepeat());
System.out.println("\t1st Time: " + tagResponse.getFirst());
System.out.println("\tLast Time: " + tagResponse.getLast());

}

// Close the connection
setupManager = null;
readerManager = null;
dataManager.close();
System.out.println("Connection Closed");

// Output the time to execute application
long endTime = System.currentTimeMillis();
long t = endTime - startTime - 500;
System.out.println("Estimated Time: " + t + "(ms)");
} catch (Exception e) {
System.out.println("Error: " + e.getMessage());
}
}

/**
* Main method for this demo application
*
* @param args
* Command line arguments first argument -IP Address of the
* reader (optional)
*/
public static void main(String[] args) {
// Create SiritClient object
SiritClientRAPID scApp;
if (args.length > 0)
scApp = new SiritClientRAPID(args[0]);
else
scApp = new SiritClientRAPID();

// Execute the application
scApp.run();
System.out.println("Exiting");
System.exit(0);

}

/**
* Event Handler
*/
public void EventFound(Object sender, EventInfo eventInfo) {
String tagID = eventInfo
.getParameter(EventInfo.EVENT_TAG_ARRIVE_PARAMS.TAG_ID);
System.out.println("Tag ID: " + tagID);
}

}
</pre>

Reader Guides

2009-05-22T13:02:07Z

Stefan: /* Virtual RFID Reader User's guides */

Package Structure for a reader project

2009-05-06T12:44:50Z

Stefan: /* org.rifidi.emulator.reader.READERNAME.command.exception */

[[category:developerDoc]][[category:emulatorDoc]]

Please refer to [[Create a new reader project | this document]] to figure out how to create a new reader project in eclipse

This page enumerates the very basic packages that a reader will need to have and the important files in each one. Complex readers will have more packages than these, but this is a bare minimum. These packages correspond with what you will need to program in [[Reader_Development_Stages#Stage_2_Reader_Core_Implementation| stage 2 of reader creation]].
==org.rifidi.emulator.reader.READERNAME==
This package just contains the osgi activator. It should be created for you automatically when you create the project. You have to modify it only to make sure it sets up the reader. [[Reader_Activator.java|Activator.java]]

==org.rifidi.emulator.reader.READERNAME.command.exception==
This package contains a file that handles exceptions that occur in the parsing and execution of reader commands.
*[[READERNAME_ExceptionHandler.java]]

==org.rifidi.emulator.reader.READERNAME.commandhandler==
This package contains one or more files that handle incoming reader messages. Normally commands can be divided into general categories. For example, with the LLRP reader, there are a set of commands that deal with ROSPec messages (such as ADD_ROSPEC, ENABLE_ROSPEC, etc.) and a separate set of commands that deal with AccessSpec messages (such as ADD_ACCESSSPEC, ENABLE_ACCESSSPEC). So for the LLRP reader, there is one file called 'LLRPReaderOperationControl.java' that contains the handler methods for ROSpec commands and a file called 'LLRPAccessControl.java' that contains the handler methods for AccessSpec commands.
*[[READERNAME_CATEGORY_Handler.java]]
==org.rifidi.emulator.reader.READERNAME.formatter==
Any kind of formatters used should go into this package. You will definitely need a formatter that handles the parsing of incoming and outgoing commands called
*[[READERNAME_CommandFormatter.java]]
But you may also need formatters such as
*[[READERNAME_LogFormatter.java]] (not required)
that handles how incoming and outgoing messages should look in the log file.
Another useful formatter that may be necessary is
*[[READERNAME_StreamReaderFormatter.java]] (not required)
that controls how bytes are read off of and written to the TCPSocket.

==org.rifidi.emulator.reader.READERNAME.protocol==
The protocol package contains one file whose purpose is twofold. The protocol needs to:
#strip any extra protocol-- such as HTTP that the reader uses to communicate-- off of incoming messages and apply these protocols back to outgoing messages.
#Sometimes two or more commands can be read off of the TCP socket at the same time if the messages are sent quickly. Therefore the protocol needs to make sure that each command is placed on the incoming buffer individually.
*[[READERNAME_Protocol.java]]

==org.rifidi.emulator.reader.READERNAME.module==
The module is the heart of the reader. It contains all the essential classes to get the reader up and running.
*[[reader.xml]] is a file that has the mappings between command names and handler methods
*[[emulator.xml]] is a file that contains with some basic configuration information
*[[REDERNAME_Module.java]] has the constructor for the reader
*[[READERNAME_ReaderSharedResources.java]] - The shared resources for this reader. It allows various pieces of the reader to be accessed in different parts.
*[[READERNAME_ReaderModuleOnPowerState.java]] - contains the transition functions for how to go from on->off and on->suspend
*[[READERNAME_ReaderModuleOffPowerState.java]] - contains the transition functions for how to go from off->on
*[[READERNAME_ReaderModuleSuspendPowerState.java]] - contains the transition functions for how to go from suspended->on and suspended->off

==org.rifidi.emulator.reader.READERNAME.tagbuffer==
Because every real reader has a slightly different way that they remember tags, each virtual reader will need a class to handle tag reads.
* [[READERNAME_TagMemory.java]] is a class that keeps up with tag reads for the reader.

READERNAME ExceptionHandler.java

2009-05-06T12:44:08Z

Stefan: READERNAME ExceptionHanlder.java moved to READERNAME ExceptionHandler.java: typo

[[category:developerDoc]][[category:emulatorDoc]]
This class should extend GenericExceptionHandler. This page goes through each of the four methods in GenericExceptionHandler and describes in detail what each one does and how it should be implemented. The first three methods must be implemented by the class that extends it, and the last class may (and probably should be) implemented by the subclass.

=CommandNotFoundError=

This exception is thrown in the [[Command Flow|CommandAdapter]] if a command is sent to the reader that is not defined in the reader.xml

<pre>public abstract ArrayList<Object> commandNotFoundError(ArrayList<Object> arg, CommandObject obj);</pre>

==Arguments==
#arg - The incoming command
#obj - The incoming command object

==Return Value==
An array of objects where the first object in the array is a message to be sent back to the client.

==Reference Implementation==
This is the commandNotFoundError in the alien reader
<pre>
public ArrayList<Object> commandNotFoundError(ArrayList<Object> arg,
CommandObject obj) {
String message = "";
for (Object i : arg) {
message += i.toString();
}
message = "Error 1: Command not understood" + message;
ArrayList<Object> returnValue = new ArrayList<Object>();
returnValue.add(message);
return returnValue;

}

</pre>

=InvalidCommandError=
This exception is thrown in the [[Command Flow|CommandAdapter]] if a command is in the reader.xml but does has and invalid argument.

<pre>public abstract ArrayList<Object> invalidCommandError(ArrayList<Object> arg, String value, CommandObject obj);</pre>

==Arguments==
#arg - The incoming command
#obj - The incoming command object

==Return Value==
An array of objects where the first object in the array is a message to be sent back to the client.

==Reference Implementation==
See the above implementation for the commandNotFound. The handling of this error will likely be the same, but the message might be slightly different.

=MalformedMessageError=
Tiis exception is thrown in the [[Command Flow|CommandAdapter]] if a command is in the reader.xml but is missing a required argument

<pre>public abstract ArrayList<Object> malformedMessageError(ArrayList<Object> arg, CommandObject obj);</pre>

==Arguments==
#arg - The incoming command
#obj - The incoming command object

==Return Value==
An array of objects where the first object in the array is a message to be sent back to the client.

==Reference Implementation==
See the above implementation for the commandNotFound. The handling of this error will likely be the same, but the message might be slightly different.

=MethodInvocationError=
This exception is thrown in the [[Command Flow|CommandAdapter]] if something goes wrong in the handler method while executing a command. It often happens if there is a null pointer exception thrown somewhere in the handler method. While it is not required to implement this method, it is a good idea to do so, so that a proper error message can be sent back to the reader if something like that happens

<pre>public CommandObject methodInvocationError(ArrayList<Object> arg,CommandObject obj)</pre>

==Arguments==
#arg - The incoming command
#obj - The incoming command object

==Return Value==
An array of objects where the first object in the array is a message to be sent back to the client.

==Reference Implementation==
This is a reference implementation from the LLRPExceptionHandler. The ErrorMessage object is an LLRP specific message that the reader is required to send back to the client if an error happens.
<pre>
public CommandObject methodInvocationError(ArrayList<Object> arg,
CommandObject obj) {
ErrorMessage em = new ErrorMessage();
LLRPStatus llrpstat = new LLRPStatus();
llrpstat.setErrorCode((short) 100);
char[] c = obj.getCurrentQueryName().toCharArray();
byte[] com = new byte[c.length];
for (int i = 0; i < c.length; i++) {
com[i] = (byte) c[i];
}

llrpstat.setErrorDescription("Internal error in Rifidi "
+ "when processing a message of type "
+ LLRPUtilities.calculateMessageNumber(com)
+ " Please report error at "
+ "rifidi sourceforge page");
em.setLLRPStatusParam(llrpstat);

obj.getReturnValue().add(em);
return obj;
}
</pre>

READERNAME ExceptionHanlder.java

2009-05-06T12:44:08Z

Stefan: READERNAME ExceptionHanlder.java moved to READERNAME ExceptionHandler.java: typo

#REDIRECT [[READERNAME ExceptionHandler.java]]

Package Structure for a reader project

2009-05-06T12:43:34Z

Stefan: /* org.rifidi.emulator.reader.READERNAME.command.exception */

[[category:developerDoc]][[category:emulatorDoc]]

Please refer to [[Create a new reader project | this document]] to figure out how to create a new reader project in eclipse

This page enumerates the very basic packages that a reader will need to have and the important files in each one. Complex readers will have more packages than these, but this is a bare minimum. These packages correspond with what you will need to program in [[Reader_Development_Stages#Stage_2_Reader_Core_Implementation| stage 2 of reader creation]].
==org.rifidi.emulator.reader.READERNAME==
This package just contains the osgi activator. It should be created for you automatically when you create the project. You have to modify it only to make sure it sets up the reader. [[Reader_Activator.java|Activator.java]]

==org.rifidi.emulator.reader.READERNAME.command.exception==
This package contains a file that handles exceptions that occur in the parsing and execution of reader commands.
*[[READERNAME_ExceptionHanlder.java]]

==org.rifidi.emulator.reader.READERNAME.commandhandler==
This package contains one or more files that handle incoming reader messages. Normally commands can be divided into general categories. For example, with the LLRP reader, there are a set of commands that deal with ROSPec messages (such as ADD_ROSPEC, ENABLE_ROSPEC, etc.) and a separate set of commands that deal with AccessSpec messages (such as ADD_ACCESSSPEC, ENABLE_ACCESSSPEC). So for the LLRP reader, there is one file called 'LLRPReaderOperationControl.java' that contains the handler methods for ROSpec commands and a file called 'LLRPAccessControl.java' that contains the handler methods for AccessSpec commands.
*[[READERNAME_CATEGORY_Handler.java]]
==org.rifidi.emulator.reader.READERNAME.formatter==
Any kind of formatters used should go into this package. You will definitely need a formatter that handles the parsing of incoming and outgoing commands called
*[[READERNAME_CommandFormatter.java]]
But you may also need formatters such as
*[[READERNAME_LogFormatter.java]] (not required)
that handles how incoming and outgoing messages should look in the log file.
Another useful formatter that may be necessary is
*[[READERNAME_StreamReaderFormatter.java]] (not required)
that controls how bytes are read off of and written to the TCPSocket.

==org.rifidi.emulator.reader.READERNAME.protocol==
The protocol package contains one file whose purpose is twofold. The protocol needs to:
#strip any extra protocol-- such as HTTP that the reader uses to communicate-- off of incoming messages and apply these protocols back to outgoing messages.
#Sometimes two or more commands can be read off of the TCP socket at the same time if the messages are sent quickly. Therefore the protocol needs to make sure that each command is placed on the incoming buffer individually.
*[[READERNAME_Protocol.java]]

==org.rifidi.emulator.reader.READERNAME.module==
The module is the heart of the reader. It contains all the essential classes to get the reader up and running.
*[[reader.xml]] is a file that has the mappings between command names and handler methods
*[[emulator.xml]] is a file that contains with some basic configuration information
*[[REDERNAME_Module.java]] has the constructor for the reader
*[[READERNAME_ReaderSharedResources.java]] - The shared resources for this reader. It allows various pieces of the reader to be accessed in different parts.
*[[READERNAME_ReaderModuleOnPowerState.java]] - contains the transition functions for how to go from on->off and on->suspend
*[[READERNAME_ReaderModuleOffPowerState.java]] - contains the transition functions for how to go from off->on
*[[READERNAME_ReaderModuleSuspendPowerState.java]] - contains the transition functions for how to go from suspended->on and suspended->off

==org.rifidi.emulator.reader.READERNAME.tagbuffer==
Because every real reader has a slightly different way that they remember tags, each virtual reader will need a class to handle tag reads.
* [[READERNAME_TagMemory.java]] is a class that keeps up with tag reads for the reader.

Package Structure for a reader project

2009-05-06T12:43:12Z

Stefan: /* org.rifidi.emulator.reader.READERNAME.command.exception */

Package Structure for a reader project

2009-05-06T12:34:59Z

Stefan:

[[category:developerDoc]][[category:emulatorDoc]]

Please refer to [[Create a new reader project | this document]] to figure out how to create a new reader project in eclipse

This page enumerates the very basic packages that a reader will need to have and the important files in each one. Complex readers will have more packages than these, but this is a bare minimum. These packages correspond with what you will need to program in [[Reader_Development_Stages#Stage_2_Reader_Core_Implementation| stage 2 of reader creation]].
==org.rifidi.emulator.reader.READERNAME==
This package just contains the osgi activator. It should be created for you automatically when you create the project. You have to modify it only to make sure it sets up the reader. [[Reader_Activator.java|Activator.java]]

==org.rifidi.emulator.reader.READERNAME.command.exception==
This package contains a file that handles exceptions that occur in the parsing and execution of reader commands.
*[[READERNAME_ExceptionHanlder.java]]
==org.rifidi.emulator.reader.READERNAME.commandhandler==
This package contains one or more files that handle incoming reader messages. Normally commands can be divided into general categories. For example, with the LLRP reader, there are a set of commands that deal with ROSPec messages (such as ADD_ROSPEC, ENABLE_ROSPEC, etc.) and a separate set of commands that deal with AccessSpec messages (such as ADD_ACCESSSPEC, ENABLE_ACCESSSPEC). So for the LLRP reader, there is one file called 'LLRPReaderOperationControl.java' that contains the handler methods for ROSpec commands and a file called 'LLRPAccessControl.java' that contains the handler methods for AccessSpec commands.
*[[READERNAME_CATEGORY_Handler.java]]
==org.rifidi.emulator.reader.READERNAME.formatter==
Any kind of formatters used should go into this package. You will definitely need a formatter that handles the parsing of incoming and outgoing commands called
*[[READERNAME_CommandFormatter.java]]
But you may also need formatters such as
*[[READERNAME_LogFormatter.java]] (not required)
that handles how incoming and outgoing messages should look in the log file.
Another useful formatter that may be necessary is
*[[READERNAME_StreamReaderFormatter.java]] (not required)
that controls how bytes are read off of and written to the TCPSocket.

==org.rifidi.emulator.reader.READERNAME.protocol==
The protocol package contains one file whose purpose is twofold. The protocol needs to:
#strip any extra protocol-- such as HTTP that the reader uses to communicate-- off of incoming messages and apply these protocols back to outgoing messages.
#Sometimes two or more commands can be read off of the TCP socket at the same time if the messages are sent quickly. Therefore the protocol needs to make sure that each command is placed on the incoming buffer individually.
*[[READERNAME_Protocol.java]]

==org.rifidi.emulator.reader.READERNAME.module==
The module is the heart of the reader. It contains all the essential classes to get the reader up and running.
*[[reader.xml]] is a file that has the mappings between command names and handler methods
*[[emulator.xml]] is a file that contains with some basic configuration information
*[[REDERNAME_Module.java]] has the constructor for the reader
*[[READERNAME_ReaderSharedResources.java]] - The shared resources for this reader. It allows various pieces of the reader to be accessed in different parts.
*[[READERNAME_ReaderModuleOnPowerState.java]] - contains the transition functions for how to go from on->off and on->suspend
*[[READERNAME_ReaderModuleOffPowerState.java]] - contains the transition functions for how to go from off->on
*[[READERNAME_ReaderModuleSuspendPowerState.java]] - contains the transition functions for how to go from suspended->on and suspended->off

==org.rifidi.emulator.reader.READERNAME.tagbuffer==
Because every real reader has a slightly different way that they remember tags, each virtual reader will need a class to handle tag reads.
* [[READERNAME_TagMemory.java]] is a class that keeps up with tag reads for the reader.

Create a new reader project

2009-05-06T12:20:36Z

Stefan: /* Add the project's dependencies */

[[category:developerDoc]][[category:emulatorDoc]]
= How to create a new Reader Project =
If you start up a new Reader it is necessary to create a new Plugin Project for the new reader. This HowTo shows how to do this in Eclipse.

== Creating a new Project in Eclipse ==
First you need to set up your Eclipse Workspace. After that you can start creating a new Project by selecting the "File"-menu in the eclipse menubar.

File -> New... -> Project

Now you will see the "New Project Wizard".
# create a new Eclipse Plug-in Project
# enter a name for the new Project and select as Target Platform Equinox
# enter the name of the Plug-in Provider and click the finish button

{| border="0" style="background:transparent;"
|-
|
[[Image:NewPluginProject1.png|300px|thumb|left|create a new "PluginProject" in Eclipse]]
||
[[Image:NewPluginProject2.png|300px|thumb|left|enter the name for the project and select as target Equinox]]
||
[[Image:NewPluginProject3.png|300px|thumb|left| Enter the Name of the Plug-in Provider]]
|}

==Add the project's dependencies==
#Double click on the project's MANIFEST.MF file
#Select the Dependencies tab
#For new readers, add the following packages:
*org.rifidi.emulator
*org.rifidi.common.utilities
*org.rifidi.services.tags

== Add the project to the SVN Server (Optional)==

If you are saving the project in the Rifidi SVN, you can do that from right inside eclipse using the subclipse plugin

If you already created a new Eclipse Plug-in Project you need to add it to the Subversion Server. This can be done by following these 4 steps.

# right click on the new Project and select "Team" -> "Share Project..."
# select SVN as repository type
# select the repository location
# select the folder you want to save the project ()

Usually our projects are stored in the trunk of the subversion server. If you want to contribute you a new project with the name '''org.rifidi.emulator.reader.test''', the path would be:

'''http://[Address of Subversion]/rifidi/trunk/org.rifidi.emulator.reader.test'''

{| border="0" style="background:transparent;"
|-
| [[Image:ShareProject1.png|300px|thumb|left| right click on the new Project and select "Team" -> "Share Project..." ]]
| [[Image:ShareProject2.png|300px|thumb|left| select SVN as repository type ]]
|-
| [[Image:ShareProject3.png|300px|thumb|left| select the repository location]]
| [[Image:ShareProject4.png|300px|thumb|left| select the folder you want to save the project ()]]
|}