RifidiWiki - User contributions [en]

Suspend Functionality

2010-11-24T10:34:02Z

Amesycyxa:

Threads

2010-11-24T10:14:36Z

Amesycyxa:

=[http://odygobyciqi.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
Rendering and it's threads are now part of our jmonkey plugin:[http://wiki.rifidi.org/index.php/Rifidi:jmeswt jmeswt] 
Documentation in this chapter is from now on obsolete! 
Designer runs as a combination of eclipse and a 3d engine. 
It is very important to closely look where things are going. 
 
 
Just some rules:
* GameTaskQueueManager.getInstance().render()/update() can be called from every part of the application and should be used to submit things to the 3d engine. It is very important to add and remove nodes inside callables that get submitted to the 3d engine as it might break the software if you don't do it this way. 
 

Old stuff: 
IF YOU HAVE BEEN USING THE HELPER CLASS REMOVE THAT CODE AS IT WILL CAUSE A DEADLOCK FROM DESIGNER 1.3 ON!
* Waiting on Futures: Sometimes it is important to be able to wait on a future when you have submitted a callable. The [http://www.rifidi.org/javadoc/designer/doc/org/rifidi/designer/utils/Helpers.html Helpers class] contains a static method called waitOnCallable. This method can be used to wait for a futue to return and is the only way (that I know of) to do this from inside the eclipse thread. THIS METHOD IS BLOCKING AND IF CALLED WHEN UPDATETHREAD IS IN THE PAUSEDSTATE WILL BLOCK FOREVER!! 
 
APPARENTLY THIS ISSUE GOT RESOLVED WITH ECLIPSE 3.3!
* syncExec/asyncExec: Avoid syncExec. According to some newsgroup posts as of eclipse 3.2 there is a deadlock condition that might cause a hang on syncExec. Use asyncExec and a callback.

Tag Streamer 1.1.1

2010-11-24T10:14:23Z

Amesycyxa:

READERNAME CommandFormatter.java

2010-11-24T10:14:09Z

Amesycyxa:

REDERNAME Module.java

2010-11-24T10:09:33Z

Amesycyxa:

=[http://ecacoraqosy.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
[[category:developerDoc]][[category:emulatorDoc]]
The readerModule is the constructor for the reader. Every reader needs one of these classes. The class needs to extend AbstractPowerModule and implement ReaderModule.

=READERNAMEModule=
This is the main constructor for the reader There should actually be two constructors. One is an empty constructor that is needed for jaxb to automatically create the reader. It should look like this:

<pre>
public SymbolReaderModule(){
}
</pre>

The readermodule also needs a main constructor with this signature:
<pre>
public SymbolReaderModule(ControlSignal<Boolean> powerControlSignal,GeneralReaderPropertyHolder properties);
</pre>

==Arguments==
# powerControlSignal - The power control signal for the entire reader. It is used to turn the reader on and off as well as to suspend and resume the reader. See information on the power states in the module package for more explanation of this.
# properties - These are the properties that the reader creation wizzard constructed. The GeneralReaderPropertyHolder contains the information required by the [[emulator.xml]].

==Reference Implementation==
This is the constructor for the SymbolReaderModule.

<pre>
public SymbolReaderModule(ControlSignal<Boolean> powerControlSignal,
GeneralReaderPropertyHolder properties) {
</pre>
always start out with a call to the super class
<pre>
super(SymbolReaderModuleOffPowerState.getInstance(),powerControlSignal);
</pre>
write some basic information to the console to let the user know that the reader is starting. Note that we are getting some information from the generalRederProperyHolder
<pre>
consoleLogger = LogFactory.getLog("console."
+ properties.getReaderName());
consoleLogger.info(SymbolReaderModule.startupText
+ "Instantiated Symbol Reader with name: "
+ properties.getReaderName());
consoleLogger.info(SymbolReaderModule.startupText
+ properties.getReaderName() + " IP Address: "
+ properties.getProperty("byte_address"));
consoleLogger.info(SymbolReaderModule.startupText
+ properties.getReaderName() + " has "
+ properties.getNumAntennas() + " antennas");
</pre>
set the name of the reader equal to the name given in the generalReaderPropertyHolder
<pre>
this.name = properties.getReaderName();
</pre>
Initialize the digester and read in the command hander methods supplied in the [[reader.xml]] file
<pre>
digester = new CommandXMLDigester();
digester.parseToCommand(this.getClass().getClassLoader()
.getResourceAsStream(XMLLOCATION + "reader.xml"));
</pre>
Create a new tag memory, create antennas, create a new radio and supply the tagMemory and antennas to the radio
<pre>
SymbolTagMemory tagMemory = new SymbolTagMemory();

HashMap<Integer, Antenna> antennaList = new HashMap<Integer, Antenna>();
for (int i = 0; i < properties.getNumAntennas(); i++) {
logger.debug("creating an antenna: " + i);
antennaList.put(i, new Antenna(i));
}

/* Make a Radio for the reader */
GenericRadio genericRadio = new GenericRadio(antennaList, 25, tagMemory);
</pre>
The symbol reader has two different IP addresses being used. One is for byte commands, and the other is for HTTP commands. parse out the IPs and ports from the GeneralReaderPropertyHolder
<pre>
String byte_address = ((String) properties.getProperty("byte_address"))
.split(":")[0];
int byte_port = Integer.parseInt(((String) properties
.getProperty("byte_address")).split(":")[1]);

String http_address = ((String) properties.getProperty("http_address"))
.split(":")[0];
int http_port = Integer.parseInt(((String) properties
.getProperty("http_address")).split(":")[1]);
</pre>
create the shared resources and supply necessary information to it
<pre>
this.srsr = new SymbolReaderSharedResources(genericRadio, tagMemory,
new ControlSignal<Boolean>(false), name, null, digester,
new ControlSignal<Boolean>(false), new ControlSignal<Boolean>(
false), new ControlSignal<Boolean>(false),
new ControlSignal<Boolean>(false), antennaList.size());
</pre>
Create the communication objects. In this case, we need two communication objects (one for bytes, and one for http), however, most readers will probably only need one. Notice that this is where we supply the reader with the [[READERNAME_Protocol.java|Protocol]], [[READERNAME_StreamReaderFormatter.java|Stream Reader]], and [[READERNAME_LogFormatter.java|Log Formatter]]
<pre>
this.httpComm = new TCPServerCommunication(new RawProtocol(), this.srsr
.getInteractiveHttpPowerSignal(), this.srsr
.getInteractiveHttpConnectionSignal(), http_address, http_port,
this.name, GenericByteStreamReader.class, new GenericByteLogFormatter());

this.byteComm = new TCPServerCommunication(new RawProtocol(), this.srsr
.getInteractiveBytePowerSignal(), this.srsr
.getInteractiveByteConnectionSignal(), byte_address, byte_port,
this.name, GenericByteStreamReader.class, new GenericByteLogFormatter());
</pre>
Build the adapters for this reader. Again, because the Symbol reader has two ways of communicating, we need two adapters. See [[Command Flow]] for more information about the adapter. This is where we supply the reader with the [[READERNAME_CommandFormatter.java|CommandFormatter]] and the [[READERNAME_ExceptionHanlder.java|ExceptionHandler]]
<pre>
this.interactiveBitAdapter = new ReflectiveCommandAdapter(
"Interactive", new SymbolBitCommandFormatter(), new SymbolBitExceptionHandler(),
this.srsr, new RawCommandSearcher());

this.interactiveHttpAdapter = new ReflectiveCommandAdapter(
"Interactive", null, new SymbolBitExceptionHandler(), this.srsr, new RawCommandSearcher());
</pre>
Build the controllers.
<pre>
this.interactiveBitController = new InteractiveCommandController(
new LoginAuthenticatedCommandControllerOperatingState(
interactiveBitAdapter), this.srsr
.getInteractiveBytePowerSignal(), this.srsr
.getInteractiveByteConnectionSignal(), this.byteComm);

this.interactiveHttpController = new InteractiveCommandController(
new LoginAuthenticatedCommandControllerOperatingState(
interactiveHttpAdapter), this.srsr
.getInteractiveHttpPowerSignal(), this.srsr
.getInteractiveHttpConnectionSignal(), this.httpComm);
}
</pre>
=Other Notes=
Here is an example from the Thing Magic reader:
<pre>
this.RQLComm = new TCPServerCommunication(new ThingMagicProtocol(), this.tmsr
.getInteractiveRQLPowerSignal(), this.tmsr
.getInteractiveRQLConnectionSignal(), rql_address, rql_port,
this.name, GenericCharStreamReader.class, new GenericStringLogFormatter());
</pre>
Notice the difference of this from the Symbol example. We are using GenericCharStreamReader and GenericStringLogFormatter instead. These are used when a client can be a standard telnet connection (another example of this is the Alien reader). 

In addition, if you need to override the default command searcher, RawCommandSearcher, then replace this class with a different implementation and pass it to ReflectiveCommandAdapter instead of the default one.

Also, one can add a few more parameters to ones implementation of the shared resources if it that information (object or primitive type) if it is needed across different areas of the reader (including its accessors and mutators if needed).

=Other Methods=
The ReaderModule will also need to implement some other methods required by the interface that it implements, however, these methods should be nearly identical to similar methods in the other readers. Please see the other readers and follow examples there for more information.

Talk:REDERNAME Module.java

2010-11-24T10:09:02Z

Amesycyxa: New page: ---- <div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; ...

TagStreamerSpecification

2010-11-24T08:32:32Z

Amesycyxa:

=[http://ojaperiwiva.co.cc Under Construction! Please Visit Reserve Page. Page Will Be Available Shortly]=
==Introduction==

This document describes a possible use case for TagStreamer 2.0 for the purpose of demonstrating how it would work. The basic idea is to define a Scenario that describes the flow of input data through processing points and BatchPattern which describe the input data in general. The processing points of the Scenario are called path items. They consist of either a reader or a GPI Listener and a time to wait before moving on to the next path item. It is important to note that the scenario and the data are decoupled. The BatchPattern describes the speed which data will put into the Scenario and how many tags will be generated. The Tag Generator uses that information and executes the BatchPattern one activated.

In the below scenario, a batch item – a group of tags – moves into the entry point of the scenario by being processed by reader 1. Reader 1 adds the tags to its antenna for a variable amount of time, between 4 and 8 seconds. Then the tags wait for 5 seconds before moving on to the next path item.

The next path item is a GPI Listener that is tied to Reader 2. Because this particular Batch Item is set to trigger GPI Listeners, the GPI Listener will toggle one of Reader 2's GPI ports. The batch item now waits for 5 more seconds. Now the tags in the batch are seen by reader 2's antenna for 3 seconds and then wait for anywhere between 10 and 20 seconds before moving on to Reader 3.

Once the tags are seen by reader 3, this iteration of the scenario is over. The TagGenerator can execute a BatchPattern more than once. This will be defined as the iteration of the BatchPattern.

[[Image:TagStreamerSpec.png]]

==Components==
A TagStreamer usecase consists of two main components -- the Scenario and the Input Data. Both are decoupled so that neither depends on the other part.

# Scenario - The Scenario describes the path through which a tag batch flows. It is made up of path items. It also contains a variable that controls how many times the scenario is repeated. If the variable is 0, the scenario is run infinitely. If it is positive, it is run n times.
## PathItem - A path item consists of either a reader or a GPI Listener and a time to wait.
###Reader - An RFID reader which tags appear on
###GPI Listener - If a Batch Item which is set to trigger a GPI event passes through a GPI Listener, it will trigger a GPI event on the GPI Listener's reader.
###Time - A time is used either to describe the amount of time that a batch item should wait on a Path Item, or the amount of time a batch item should wait after being processed by the path item. For example, in the above use case, if the tag batch moved to reader 1, it is processed by the reader for 4-8 seconds (i.e. It is added to the reader's antenna for this amount of time). Then it waits for 5 seconds before it proceeds to the next path item. It can be a random amount of time with a min value and a max value. If it's not a random value both values should be equal.
#BatchPattern - A way to describe BathItems generated at the runtime. Each batch items flows through the Scenario by starting at the entry point and being processed sequentially at each Path Item.
##BatchItem - A batch item contains a list of tags, a boolean that describes whether or not it should trigger GPI Listeners and a time value that describes the amount of time it should wait before being processed by the first path item.
### GPI Trigger - A boolean value that defines whether or not the asociated batch item should cause GPI Listerns to fire a GPI event.
### Tags - A list of RFID tags to be added to readers. They are defined by an ID, a Generation( Gen1 or Gen2), and type (e.g. DOD-96).

==XML==
===Scenario.xml===
This XML describes the PathItems and the way Data moves through the scenario to the various components like RFID Readers & GPI Listeners.
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<scenario id="0">
<pathItem id="0">
<readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
<readerID>0</readerID>
</readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
</pathItem>
<pathItem id="1">
<gpiListenerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
<gpiListenerID>0</gpiListenerID>
</gpiListenerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
</pathItem>
<pathItem id="2">
<readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
<readerID>0</readerID>
</readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
</pathItem>
<pathItem id="3">
<readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
<readerID>0</readerID>
</readerEntity>
<timeEntity>
<random>true</random>
<minValue>400</minValue>
<maxValue>500</maxValue>
</timeEntity>
</pathItem>
</scenario>
</pre>

===Component.xml===
This XML describes the various components (ie RFID Readers & GPI Listeners) in the scenario

<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<componentList id="0">
<readerComponents id="0">
<reader>
<numAntennas>1</numAntennas>
<numGPIs>4</numGPIs>
<numGPOs>4</numGPOs>
<propertiesMap>
<entry>
<key>servermode</key>
<value>true</value>
</entry>
<entry>
<key>inet_address</key>
<value>127.0.0.1:10101</value>
</entry>
<entry>
<key>llrp_inet_address</key>
<value>127.0.0.1:5084</value>
</entry>
</propertiesMap>
<readerClassName>org.rifidi.emulator.reader.llrp.module.LLRPReaderModule</readerClassName>
<readerName>LLRPreader</readerName>
<readerType>LLRPReader</readerType>
</reader>
</readerComponents>
<readerComponents id="1">
<reader>
<numAntennas>1</numAntennas>
<numGPIs>4</numGPIs>
<numGPOs>4</numGPOs>
<propertiesMap>
<entry>
<key>servermode</key>
<value>true</value>
</entry>
<entry>
<key>inet_address</key>
<value>127.0.0.1:10102</value>
</entry>
<entry>
<key>llrp_inet_address</key>
<value>127.0.0.1:5085</value>
</entry>
</propertiesMap>
<readerClassName>org.rifidi.emulator.reader.llrp.module.LLRPReaderModule</readerClassName>
<readerName>LLRPreader2</readerName>
<readerType>LLRPReader</readerType>
</reader>
</readerComponents>
<gpiListenerComponents id="0">
<port>0</port>
<readerID>0</readerID>
<signalValue>true</signalValue>
</gpiListenerComponents>
</componentList>
</pre>

===BatchPattern.xml===
The BatchPattern describes the input data generated at the runtime by the BatchGenerators. This will create BatchItems wich certain tags and flow through the scenario.
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<batchPattern id="1">
<scenario>3</scenario>
<interation>250</iteration>
<burstNumber>50</busrtNumber>
<burstInterval>4000</burstInterval>
<isGPITrigger>true</isGPITrigger>
<tagPattern count="100">
<type>Custom</type>
<prefix>eef</prefix>
<gen>2</gen>
</tagPattern>
<tagPattern count="90">
<type>DOD</type>
</prefix>
<gen>2</gen>
</tagPattern>
</batchPattern>
</pre>

READERNAME ReaderModuleOnPowerState.java

2010-11-24T08:32:27Z

Amesycyxa:

=[http://exytebuc.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
[[category:developerDoc]][[category:emulatorDoc]]
This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState.

=turnOff=

This method should turn the reader and all of its components off.

<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>

==Arguments==
#pcObject - The ReaderModule
#callingClass - The class that called the turnOff method

==Reference Implementation==
This is the implementation of the turnOff() method in the Symbol Reader. It basically turns off its two communication objects and controllers. It turns off the controllers by calling their respective turn off methods. It then turns off the communication by turning off each communication object's power and connection signal (Each Communication object has a control signal that represents the whether or not the communication is 'on', and another control signal that represents whether or not the communication is 'connected' to client). Finally, this method moves the symbol reader into the 'off' state by calling the 'changePowerState' method. This method doesn't do anything but declare that the reader is now off.

This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things. For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
<pre>
public void turnOff(PowerControllable pcObject, Class callingClass) {
SymbolReaderModule rm = (SymbolReaderModule) pcObject;
rm.getInteractiveBitController().turnOff(this.getClass());
rm.getInteractiveHttpController().turnOff(this.getClass());

rm.getSharedResources().getInteractiveBytePowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpPowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveByteConnectionSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpConnectionSignal()
.setControlVariableValue(false);

SymbolReaderSharedResources ssr = rm.getSharedResources();

rm.changePowerState(SymbolReaderModuleOffPowerState.getInstance());

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

=suspend=

This method moves the reader into the suspended state. Readers should be able to be 'suspended' and 'resumed' so that functions like 'pause' will work in Rifidi Designer. For the most part, suspend should just queue incoming and outgoing messages. This functionality works by just suspending the communication that the reader is using. The complication comes in when a reader needs to be suspended while in autonomous mode.

<pre>public void suspend(PowerControllable pcObject) </pre>

==Arguments==
#pcObject - The ReaderModule

==Reference Implementation==
This is the implementation of the suspend() method in the Symbol Reader. It works by suspending its communication and controllers. Then it moves the reader into the SuspendedState by calling the changePowerState() method.

Note that because the reader does not have an autonomous mode that is implemented it does not need to do anything else. The LLRP reader does, however, have an autonomous mode, and so it needs to make sure the autonomous mode is suspended. See that reader's OnPowerState class to see how it suspends its autonomous mode.
<pre>
public void suspend(PowerControllable pcObject) {
SymbolReaderModule rm = (SymbolReaderModule) pcObject;
rm.getHttpComm().suspend();
rm.getByteComm().suspend();
rm.getInteractiveBitController().suspend();
rm.getInteractiveHttpController().suspend();

SymbolReaderSharedResources ssr = rm.getSharedResources();

ssr.getTagMemory().suspend();

rm.changePowerState(SymbolReaderModuleSuspendedPowerState.getInstance());

String readername = rm.getSharedResources().getReaderName();
LogFactory.getLog("console." + readername).info(readername + " suspended");

}
</pre>

Northwind Hello World Servlet

2010-11-24T08:32:08Z

Amesycyxa:

Talk:READERNAME ReaderModuleOnPowerState.java

2010-11-24T08:32:01Z

Command Flow

2010-11-24T08:31:48Z

Amesycyxa:

Talk:TagStreamerSpecification

2010-11-24T08:31:44Z

Package Structure for a reader project

2010-11-24T07:30:48Z

Amesycyxa:

=[http://orylyvejuza.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
[[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.

Talk:Package Structure for a reader project

2010-11-24T07:29:47Z

Services

2010-11-24T06:39:01Z

Amesycyxa:

=[http://upezobyxez.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
Since designer 1.3 we have changed a lot of the it's internal works. 
We tried to stick even more with the principle of dependency injection. 
The most important change we made is that we switched from our custom services and their ServiceRegistry-Singleton to the service architecture that comes with OSGi. 
We also created a service locator to make it even easier to make use of these services. 
The following chapters will introduce the basic concepts of services and how we use it in designer. I will also try to show how to create your own service. 
The last chapter will then introduce the various services that we are providing with the core of designer.

Create a new reader project

2010-11-24T06:39:00Z

Amesycyxa:

Northwind Using Emulator

2010-11-24T06:38:55Z

Amesycyxa:

Talk:Compiling Rifidi with JDK 6.0 update 4

2010-11-24T06:38:55Z

Reader Guides

2010-11-24T06:38:50Z

Amesycyxa:

=[http://enececufo.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
=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)]]

Talk:Services

2010-11-24T06:38:42Z

TagStreamerArchitecture

2010-11-24T06:38:33Z

Amesycyxa:

TagStreamerUseCaseScenarios

2010-11-24T06:38:28Z

Amesycyxa:

Category:EngineImplementation

2010-11-23T23:27:23Z

Amesycyxa:

=[http://ecacoraqosy.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
'''Pages that describe specific details about how some aspect of our code is implemented'''

Category talk:EngineImplementation

2010-11-23T23:26:57Z

Edge Server API

2010-11-23T23:26:48Z

Amesycyxa:

=[http://ukusypumi.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
*[http://rifidi.org/javadoc/edge1.0.0/ 1.0.0 JavaDoc]
*[http://rifidi.org/javadoc/edge1.2.0/ 1.2.0 JavaDoc]

READERNAME ReaderSharedResources.java

2010-11-23T23:26:42Z

Amesycyxa:

Talk:Edge Server API

2010-11-23T23:26:32Z

Development Process

2010-11-23T23:26:20Z

Amesycyxa:

Alien Example Client

2010-11-23T23:26:12Z

Amesycyxa:

=[http://yjucofi.co.cc This Page Is Currently Under Construction And Will Be Available Shortly, Please Visit Reserve Copy 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 [[Alien_9800#Supported Commands | List of supported commands]].

<pre>
/*
* AlienExampleClient.java
*
* Created: Dec 6, 2007
* Project: RiFidi Emulator - A Software Simulation Tool for RFID Devices
* 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: Kyle Neumeier - kyle@pramari.com
*/
package sandbox;

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

/**
* This class shows how to create a program to talk to the alien reader.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class AlienExampleClient {

public static final String IP_ADDRESS = new String("127.0.0.1");
public static final int READER_PORT = 20000;
private static Socket connection = null;

private static PrintWriter out = null;
private static BufferedReader in = null;

/**
* Initialize the connection and send username/password
* @throws IOException
* @throws InterruptedException
*/
private void init() throws IOException, InterruptedException{
connection = new Socket("127.0.0.1", READER_PORT);

in = new BufferedReader(new InputStreamReader(connection
.getInputStream()));
out = new PrintWriter(connection.getOutputStream());

Thread.sleep(500);
System.out.println(readFromReader(in));
out.write("alien\n");
out.flush();
System.out.println(readFromReader(in));
Thread.sleep(500);
out.write("password\n");
out.flush();
System.out.println(readFromReader(in));
}

/**
* Tear down the connection
* @throws IOException
*/
private void tearDown() throws IOException{
out.write("q");
out.flush();
connection.close();
}

/**
* Get tags back from the alien reader
* @return
* @throws IOException
*/
private String getTags() throws IOException{
String command = "t";
out.write(command + "\n");
out.flush();
String returnVal = readFromReader(in);
return returnVal;
}

/**
* @param args
* @throws InterruptedException
* @throws IOException
*/
public static void main(String[] args) throws IOException, InterruptedException {
AlienExampleClient client = new AlienExampleClient();
client.init();
Thread.sleep(500);
String tags = client.getTags();
System.out.println(tags);
Thread.sleep(500);
client.tearDown();

}

/**
* Read responses from the socket
* @param inBuf
* @return
* @throws IOException
*/
public static String readFromReader(BufferedReader inBuf) throws IOException{
StringBuffer buf=new StringBuffer();
int ch=inBuf.read();
while((char)ch!='\0'){
buf.append((char)ch);
ch=inBuf.read();
}
return buf.toString();
}

}

</pre>

Emulator Packages

2010-11-23T23:25:58Z

Amesycyxa:

Talk:Alien Example Client

2010-11-23T23:25:54Z

Northwind Creating the Web Application

2010-11-23T23:25:03Z

Amesycyxa:

Use org.rifidi.logging

2010-11-23T23:24:35Z

Amesycyxa:

=[http://asuxoqonyb.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
<code>org.rifidi.logging</code> is a bundle that provides a logging service for other bundles in the rifidi project. Specifically it provides <code>org.apache.commons.logging</code> and <code>org.apache.log4j</code>. Log4J relies on a file called <code>log4j.properties</code> to provide configuration information. The plugin itself does not have a <code>log4j.properties</code> folder in it. Instead, it relies on a OSGi bundle fragment to add one to the classpath.

To use it in another plugin:
# Make sure that the bundle is checked out in your workspace. You can either download the plugin from the <code>rep-external</code> svn repository, or you can use the binary from <code>org.rifidi.binary</code> along with a target platform.
# In the Manifest for your plugin, declare a package import of <code>org.apache.commons.logging</code>. Make sure that the minimum version is 1.0.4.
# In the run configuration:
## Make sure that <code>org.rifidi.logging</code> is checked.
## Make sure that only one log4J fragment is checked. If more than one is loaded, it is not defined which one will be used to configure log4j.
## Make sure that <code>org.apache.commons.logging</code> or <code>org.apache.log4j</code> is not being provided by a target platform. It is recommended that target platforms used by rifidi not contain either of these two bundles.

Alien Edge Server Guide

2010-11-23T23:24:34Z

Amesycyxa:

Reader Activator.java

2010-11-23T23:24:19Z

Amesycyxa:

=[http://yhenaju.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
[[category:developerDoc]][[category:emulatorDoc]]
You should only modify Activator.java that was automatically created to create and register the reader--like this (Example taken from ThingMagic Reader):
<pre><nowiki>
public class Activator implements BundleActivator {

/*
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
System.out.println("Registered org.rifidi.emulator.reader.thingmagic");
context.registerService(new String[]{ReaderModule.class.getName()}, new ThingMagicReaderModule(), new Hashtable());
}

/*
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
System.out.println("Shutting down org.rifidi.emulator.reader.thingmagic");
}

}
</nowiki></pre>
Notice those those three total lines of code in the methods '''start''' and '''stop'''. Those are the only lines one has to add then chance '''ThingMagic''' or '''thingmagic''' to match the name of the reader one is building.

Talk:Use org.rifidi.logging

2010-11-23T23:23:59Z

Talk:Tag Streamer 1.1

2010-11-23T23:23:43Z

Emulator 1.5.2

2010-11-23T23:23:40Z

Amesycyxa:

Rifidi 1.4.3

2010-11-23T23:23:36Z

Amesycyxa:

Northwind Display Events using JSP: Step 9: Display events in a JSP

2010-11-23T23:23:27Z

Amesycyxa:

Emulator 1.5.1

2010-11-23T23:23:23Z

Amesycyxa:

Category:DesignerDoc

2010-11-23T23:23:01Z

Amesycyxa:

=[http://axufizyfe.co.cc This Page Is Currently Under Construction And Will Be Available Shortly, Please Visit Reserve Copy Page]=
'''All Designer Documents'''

READERNAME StreamReaderFormatter.java

2010-11-23T23:22:50Z

Amesycyxa:

Asset Tracking: An end-to end solution with the Rifidi Platform

2010-11-23T23:22:47Z

Amesycyxa:

Category talk:DesignerDoc

2010-11-23T23:22:43Z

READERNAME ReaderModuleSuspendPowerState.java

2010-11-23T23:22:18Z

Amesycyxa:

Talk:Reader Activator.java

2010-11-23T23:22:15Z

Emulator 1.5

2010-11-23T23:21:43Z

Amesycyxa:

Rifidi:Source Code

2010-11-23T23:21:42Z

Amesycyxa:

----
<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
----
=[http://yhenaju.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
----
=[http://yhenaju.co.cc CLICK HERE]=
----
</div>
[[category:developerDoc]]
This page explains how to download and run the source code for the Rifidi products. However, please keep in mind that the code in this repository is not guaranteed to be stable. If you are interested in our latest stable release, visit our sourceforge page: http://sourceforge.net/projects/rifidi/.
=Quick Instructions=
The following are the basic steps needed to begin running Rifidi from source. If you have trouble or need more explanation, please see the more detailed instructions on this page.
# Download the Eclipse for plugin developers (3.5 is what we are using)
# Install the subclipse plugin
# Add this svn to the list of repositories: https://svn.rifidi.org/svn/rep-external
# Check out the following projects from rifidi/trunk: org.rifidi.binary, org.rifidi.emulator.target, org.rifidi.ui.ide
# Open up the target file in org.rifidi.emulator.target and click the button that says "set as target platform"
# Open up the .product file in org.rifidi.ui.ide and click "launch an eclipse application"

=Weekly Builds=
Because many of our users are intereted in running the latest version of the Rifidi products but don't want to go to all the trouble of downloading the source code, there is a weekly build of the products. The weekly builds include the latest features, but is not as tested as the sourceforge releases. A link will be provided soon.
=Rifidi Source Code=
For those who need to see the source code for the Rifidi products, you will have to check out the code from svn. This section explains how to check out and run the code from source.
==Organization==
In general the code for Rifidi is organized into Eclipse plugins or bundles. Eclipse handles the loading and execution of the plugins. For more detailed information about how our source code is organized, please see [[Development and Release Process#Concepts]].
* '''SVN Structure''' - There are three main folders in the Rifidi directory on <code>rep-external</code> (the main svn repository for Rifidi). The ''trunk'' folder contains the code that is being developed. It is ''not'' guaranteed to be stable. The ''tags'' folder contains tagged versions of the source for each of the plugins. The source in these plugins should be relatively stable. The ''branches'' folder contains plugins that have been branched so that larger changes can be made on plugins without holding up other developers. These changes can then later be merged back in. For more details about our SVN, see [[Development and Release Process#SVN Structure]]
* Target Platform - A target platform is the base set of plugins that an Eclipse application needs to run. In order to provide a more stable environment and to ensure a clean separation between the base plugins that Rifidi needs and the base plugins that your Eclipse IDE needs, we provide a target platform for each of the Rifidi products. You can find these in the trunk. They will be named something like <code>org.rifidi.emulator.target</code>. For more information see [[Development and Release Process#Target Platforms]].
* org.rifidi.binary - As the source code for Rifidi gets larger it begins to get harder to maintain a stable set of plugins. In order to simplify things, there is a folder in the svn into which stable binaries of each of the plugins used in the rifidi project will be placed. This folder is used in conjunction with the target platform.
* Product File - In Eclipse, a product file is used to define the needed eclipse plugins. Running this file will create a new Eclipse 'Run Configuration' in your IDE. You can then tweak this run configuration as needed.
* Source Code Plugins - A stable binary version of each of the plugins is contained in the org.rifidi.binary folder. However, if you wish to view the source of a particular plugin or run a plugin from source, you must download the code from either the version in the trunk or a tagged version in the tags directory.

==Downloading the Code==

Our code is hosted at https://svn.rifidi.org/svn/rep-external. The svn repository allows anonymous read access. Because the svn repository is the same one that developers submit to, it contains the latest Rifidi code.

The following steps explain how to check out and run Rifidi Emulator. The other products in the Rifidi Suite follow similar steps. If you need help with them, you can ask questions on IRC or our forums.

===Prerequisites===

The Rifidi Emulator is written in java and consists of Eclipse plugins. At this point it is easiest to compile and build it inside of the eclipse environment.

====Install Eclipse====
Note that you need the "Eclipse for RCP/Plug-in Developers" version of eclipse. Rifidi will not run on other versions.
* If you do not already have eclipse, or if you have a different version, you will need to get this version
** Go to http://www.eclipse.org/downloads/ and download the "Eclipse for RCP/Plug-in Developers" version of Eclipse to a convenient location.
** Unzip the package.
** Double click on the execution file to get it started [[Image:Rifidi_from_source-1-opening_eclipse.png |none|thumb|800px|Double click on the executable to open up eclipse]]
* If you have not used eclipse before, you will be required to select a workspace when eclipse is opening.
** After eclipse opens go to the workbench[[Image:Rifidi_from_source-2-wokbench.png |none|thumb|800px|Open up the workbench]]
* If you have an existing workspace, you will need to create a new one.
** Go to file -> switch workspace -> other [[Image:Rifidi_from_source-3-switch_workspace.png |none|thumb|800px|Open up the workbench]]
** Select a new directory for your Rifidi workspace.

====Install Subclipse====

Subclipse is an eclipse plugin that manages svn commands.

* Follow the instructions at http://subclipse.tigris.org/install.html.
* In step 6 of the above instructions, don't install the Optional Integrations. Only the subclipse plugin is needed

===Add Repository===

* Open the 'SVN Repository Exploring' perspective
** Window -> Open Perspective -> Other [[Image:Rifidi_from_source-4-svn_rep_explore1.png |none|thumb|800px|Open up the perspective picker]]
** SVN Repository Exploring [[Image:Rifidi_from_source-5-svn_rep_explore2.png |none|thumb|400px|Open up the SVN Repository Explorer]]
* Add the rifidi repository
** Click 'Add SVN Repository' button
** Add 'https://svn.rifidi.org/svn/rep-external'[[Image:Rifidi_from_source-6-add_rep.png |none|400px|thumb|Add the repository]]

===Check Out Code===

* Check out all the projects in the rifidi/trunk folder of the repository
** Highlight the folders you would like to check out. For Emulator you will need
*** <code>org.rifidi.binary</code>
*** <code>org.rifidi.emulator.taget3.5.2</code>
*** <code>org.rifidi.ui.ide</code>
** Right click them and select checkout [[Image:Rifidi_from_source-7-checkout1.png |none|800px|thumb|Select the projects]]
** Select Finish. [[Image:Rifidi_from_source-8-checkout2.png |none|400px|thumb|Checkout projects]]

===Set The Target Platform===
* Open up the .target file in <code>org.rifidi.emulator.target</code>
* Click the button that says "set as target platform"

==Running Rifidi==

The last step to get Rifidi running is to create a run configuration.

A run configuration is the set of plugins that will be loaded when you run the application. Plugins can come from one of two places:
#Workspace - these are the plugins that you have in the source tree on the left
#Target Environment - These are the plugins defined by the target environment that you are using that the time.

Because there is a product file for emulator defined in the <code>org.rifidi.ui.ide</code> plugin, the easiest way to create a new run configuration is by running the product file. This will automatically create a new run configuration

To Create a new Run Configuration:
* Switch to the Java perspective in the same way that you switched to the repository exploring view [[Image:Rifidi_from_source-9-java_view.png |none|400px|thumb|Run Rifidi]]
* Right click on Rifidi.product in the org.rifidi.ui.ide project
* Click on "Run as eclipse application" [[Image:Rifidi_from_source-10_run_eclipse.png |none|thumb|800px|Run Rifidi]]
* From now on, you can start Rifidi via the green triangle button at the top of eclipse

If there was an error when starting the application, follow the step below to edit the run configuration:

To Edit a Run Configuration:
* Run -> Open Run Dialog -> Eclipse Application -> Rifidi.product. This is the run configuration.
* Go to the Tab Plug-ins. The selected plugins are the ones that will be run. Notice that there are two sections: "workspace" and "target platform"
* click the Button "Add Required Plug-ins" [[Image:Rifidi_from_source-11_add_plugins.png |none|thumb|600px|Add required plugins]]
* check any plugins specifically required for the application to run (for example, the emulator requires the readers to be included). Make sure that the plugin is coming from the place that you intended (i.e. workspace or target platform).
* click the Button "Validate Plug-ins" to make sure everything is set up correctly
* click the Button "Apply"
* click the Button "Run" and start the Project

==Updating the code==

Now that you have downloaded the code into an eclipse workspace, it is easy to get changes to the code as soon as we add them to the svn.

To update the code:

* Open up the Team Synchronizing Perspective in eclipse
* Click the button that says "Synchronize".
* Select all projects.
* Install any updates by selecting all the updates show, right clicking and choosing 'update'

Now that you have the new code, just hit the green run button on the toolbar at the top (Eclipse automatically compiles the code for you, so you don't have to worry about that).

==Switching Branches==
If you need to run code from another branch or tag, please see [[Switching Branches]].

==Viewing Source and Running From Trunk==
By default all of the rifidi plugins you are running in eclipse are pre-compiled, binary plugins contained in the <code>org.rifidi.binary</code> folder. If you want to view or edit the source for a particular plugin, you will need to check out the plugin from the trunk. Once it is checked out make sure to edit your run configuration so that the application will use the plugin from the workspace and not from the target platform.

For example, suppose I want to view the source for the Alien reader plugin. I need to follow the steps above to check out and run rifidi emulator. In addition, I need to check out the <code>org.rifidi.emulator.readers.alien</code> plugin. This is the code for the alien reader. In addition, I need to edit the run configuration to make sure that my workspace alien reader plugin is being used instead of the target platform alien reader plugin.

=Reporting Bugs=

To report bugs, please use the forum at

http://forums.rifidi.org

or drop by our IRC channel:

<nowiki>#rifidi on irc.freenode.org.</nowiki>

You can also visit us online at http://www.rifidi.org

Eclipse:osgiDS

2010-11-23T23:21:28Z

Amesycyxa: