RifidiWiki - User contributions [en]

Rifidi:Source Code

2010-09-14T16:32:14Z

Kyle: /* Check Out Code */

[[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

Main Page

2010-09-07T20:53:17Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>



<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:lightpink"><h4>Announcing Rifidi Edge Server 1.2!!!</h4>

<p>Version 1.2 offers many new features, including first class support for developing Rifidi applications. See [[Version 1.2]] for details</p>
</td>
</tr>
<tr>

<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[User's Guide | User's Guide]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Developer's Guide | Developer's Guide]]</li>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Main Page

2010-09-07T20:52:43Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>

<!-- Remove this tr tag to remove the announcement --!>

<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:lightpink"><h4>Announcing Rifidi Edge Server 1.2!!!</h4>

<p>Version 1.2 offers many new features, including first class support for developing Rifidi applications. See [[Version 1.2]] for details</p>
</td>
</tr>
<tr>

<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[User's Guide | User's Guide]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Developer's Guide | Developer's Guide]]</li>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Main Page

2010-09-07T20:51:52Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>

<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:lightpink"><h4>Announcing Rifidi Edge Server 1.2!!!</h4>

<p>Version 1.2 offers many new features, including first class support for developing Rifidi applications. See [[Version 1.2]] for details</p>
</td>
</tr>
<tr>

<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[User's Guide | User's Guide]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Developer's Guide | Developer's Guide]]</li>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Developer's Guide

2010-09-07T20:51:17Z

Kyle: Developer's Giude moved to Developer's Guide

*[http://rifidi.org/guides/Rifidi_Edge_Server_Developer_1.2.pdf Developer's Guide for 1.2.0]

Developer's Giude

2010-09-07T20:51:17Z

Kyle: Developer's Giude moved to Developer's Guide

#REDIRECT [[Developer's Guide]]

Version 1.2

2010-09-07T20:48:47Z

Kyle: /* Documentation */

=What's new in version 1.2=

==Functionality==
* First class support for Rifidi Applications. In 1.1 applications were no more than OSGi bundles which hooked into Esper. In 1.2, can make use of the new Application API which provides many services which make it easier to make powerful RFID applications. For more information see the Developer’s guide included in the SDK release.
* ActiveMQ configuration is now more flexible. The configuration is provided via an xml file and the previously used system properties have been removed.
* Improved LLRP flexibility. LLRP configuration can now be done via XML files rather than commands.
* Serial barcode reader support
* Generic reader adapter for allowing connection to readers which specific reader adapters are not provided for.
* Diagnostic commands for determining if the Edge Server is connected to readers and processing tags.

===Example of Rifidi Applications===
One of the great improvements with 1.2 is the 'Rifidi Application'. Rifidi Applications make it much easier to create RFID applications that run on top of the Rifidi Edge Server. The following is a simple example that prints a line when a tag arrives and when it departs. There are more examples inside the SDK release, including a completely re-worked Northwind example!
<pre>
package test;

import java.util.concurrent.TimeUnit;

import org.rifidi.edge.core.app.api.AbstractRifidiApp;
import org.rifidi.edge.core.app.api.service.tagmonitor.ReadZone;
import org.rifidi.edge.core.app.api.service.tagmonitor.ReadZoneMonitoringService;
import org.rifidi.edge.core.app.api.service.tagmonitor.ReadZoneSubscriber;
import org.rifidi.edge.core.services.notification.data.TagReadEvent;

/**
* A simple app to monitor a read zone
* @author Kyle Neumeier
*
*/
public class MyApp extends AbstractRifidiApp implements ReadZoneSubscriber{

/**A service to monitor a read zone*/
private ReadZoneMonitoringService readzoneService;

public MyApp(String group, String name) {
super(group, name);
}

@Override
protected void _start() {
ReadZone zone = getReadZones().get("dockdoor");
readzoneService.subscribe(this, zone, 10f, TimeUnit.SECONDS);
}

@Override
protected void _stop() {
readzoneService.unsubscribe(this);
}

@Override
public void initialize() {
}

@Override
public void tagArrived(TagReadEvent tag) {
System.out.println("TAG ARRIVED!: " + tag);
}

@Override
public void tagDeparted(TagReadEvent tag) {
System.out.println("TAG DEPARTED!: " + tag);
}

/**
* @param readzoneService the readzoneService to set
*/
public void setReadzoneService(ReadZoneMonitoringService readzoneService) {
this.readzoneService = readzoneService;
}

}
</pre>

==Properties==
We've added a couple new properties that can be added to the system properties when you run the edge server
* org.rifidi.ui.notify. If set to true, tags will be delivered to Workbench over a JMS topic. If set to false, the tags will not be put onto JMS. Not sending tags improves performance. It is set to true by default.
* org.rifidi.home This set set to the home directory (where the 'applications' folder and the 'config' directory reside). It is useful to change this when you are developing applications in eclipse to the SDK directory so that your configuration files can be stored within eclipse. It is set to 'user.dir' by default.

==Commands==
We have added several new OSGi commands to help diagnose common problems with your applications. For example:
* <tt>tagrate</tt> prints out how many tags per second the edge server is currently reading
* <tt>currenttags [readerID]</tt> prints out a list of tags that can be currently seen by the given reader

For a full list of commands, see the [[User's Guide]]

==Documentation==
We now provide a [[User's Guide]] that describes many aspects of running, configuring, and administrating the Rifidi Edge Server.

In addition, we provide a [[Developer's Guide]] that explains how to write Rifidi Applications using our new API.

Version 1.2

2010-09-07T20:47:12Z

Kyle: /* Commands */

Version 1.2

2010-09-07T20:44:27Z

Kyle: New page: =What's new in version 1.2= ==Functionality== * First class support for Rifidi Applications. In 1.1 applications were no more than OSGi bundles which hooked into Esper. In 1.2, can make u...

Main Page

2010-09-07T20:20:55Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>

<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:lightpink"><h4>Announcing Rifidi Edge Server 1.2!!!</h4>

<p>Version 1.2 offers many new features, including first class support for developing Rifidi applications. See [[Version 1.2]] for details</p>
</td>
</tr>
<tr>

<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[User's Guide | User's Guide]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Developer's Giude | Developer's Guide]]</li>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Developer's Guide

2010-09-07T19:50:49Z

Kyle: New page: *[http://rifidi.org/guides/Rifidi_Edge_Server_Developer_1.2.pdf Developer's Guide for 1.2.0]

*[http://rifidi.org/guides/Rifidi_Edge_Server_Developer_1.2.pdf Developer's Guide for 1.2.0]

User's Guide

2010-09-07T19:50:13Z

Kyle: New page: *[http://rifidi.org/guides/Rifidi_Edge_Server_User_1.2.pdf User's Guide for 1.2.0]

*[http://rifidi.org/guides/Rifidi_Edge_Server_User_1.2.pdf User's Guide for 1.2.0]

Main Page

2010-09-07T19:46:21Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>
<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[User's Guide | User's Guide]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Developer's Giude | Developer's Guide]]</li>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Edge Server Configuration

2010-09-02T19:50:52Z

Kyle: /* VMArgs */

This page explains the various configuration options of the Rifidi Edge Server
=RifidiEdgeServer.ini=
The RifidiEdgeServer.ini is a property file that contains options for various options when the edge server starts up.
==rifidiserver.ini file==
As of release 1.2.0, the default rifidiserver.ini file looks like this:
<pre>
-os
${target.os}
-ws
${target.ws}
-arch
${target.arch}
-nl
${target.nl}
-vmargs
-Declipse.ignoreApp=true
-Dosgi.console
-Dosgi.noShutdown=true
-Dorg.rifidi.edge.configuration=config/rifidi.xml
-Dosgi.clean=true
-Dorg.osgi.framework.bootdelegation=javax.xml.ws
-Dcom.sun.management.jmxremote.port=2021
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
-Djava.rmi.server.hostname=127.0.0.1
-Dorg.rifidi.edge.core.rmi.port=1101
-Dorg.rifidi.edge.ale.port=8081
-Dorg.rifidi.edge.ale.host=127.0.0.1
-Dosgi.framework.extensions=org.eclipse.equinox.weaving.hook
-Dorg.aspectj.osgi.verbose=true
-Dorg.rifidi.edge.autostart=true
-Dorg.rifidi.edge.logging=config/logging.properties
-Dorg.rifidi.ui.notify=true
</pre>

==Console==
;-console
:This starts up the OSGi console so that you can interact with the edge server from the command line. For a list of commands that are available see [[Edge Server Commands]]. If you would like the console to be available over the network, supply a port after the -console (e.g. -console 2020). Now it is possible to telnet into the server at the given port. It is recommended that you use ssh tunneling for security reasons (i.e. first ssh to the machine that is running the edge server, then telnet to the console). One thing to note is that after you telnet to the OSGi console, you cannot use the <tt>exit</tt> command as you normally would to close the telnet session. This is because <tt>exit</tt> will be caught by the OSGi console and will perform a System.exit(). Instead, to exit the telnet session while keeping the server running, just close the telnet window.
==VMArgs==
VMArgs must follow the <tt>-vmargs</tt> flag in the .ini file. They must start with <tt>-D</tt>. Default values can be found in the <tt>bundle.properties</tt> file in the spring directory for the appropriate option. Important VM args:
;-Dorg.rifidi.edge.configuration
:This is the path to the persistence file. See [[#rifidi.xml]].
;-Dcom.sun.management.jmxremote.port
:The port to open up JMX on. This is important if you are using a program like VisualVM to profile the server
;-Djava.rmi.server.hostname
:The hostname to open up the RMI registry at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.core.rmi.port
:The port of the RMI registry Default is <tt>1101</tt>
;-Dorg.rifidi.edge.ale.host
:The hostname to publish the ALE webservices at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.ale.port
:The port to publish the ALE webservices at. Default is <tt>8081</tt>
;-Dorg.rifidi.edge.ale.read
:The service name of the ALE reading service. Default is <tt>ALEService</tt>
;-Dorg.rifidi.edge.ale.logicalreader
:The service name of the ALE logical reader service. Default is <tt>ALELRService</tt>
;-Dorg.rifidi.home
:The Rifidi directory. If not set, it defaults to ${user.dir}
;-Dorg.rifidi.ui.notify
:If set to true, reader adapters will send tag notifications to workbench. Default is true

=rifidi.xml=
The rifidi.xml file is the persistence file for the Rifidi Edge Server. The two important services that are saved are Reader Configurations and Command Configurations.

==Loading a configuration file==
Whenever the edge server starts up, it looks for the file that is specified in the <tt>org.rifidi.configuration</tt> vm flag. After the configuration file is read, the server will attempt to recreate all services specified in the file. If a needed factory is not available, the service will be skipped and recreated when the factory becomes available. For example, suppose the configuration file has an Alien Reader Configuration and an LLRP Reader Configuration. Suppose that when the server starts up, only the Alien plugin is available (so the Alien Reader Factory is available, but the LLRP Reader Factory is not). At this point the Alien Reader is recreated. If later the LLRP plugin is installed, then the LLRP reader will be recreated.

==File Structure==
The edge server uses JAXB to persist a configuration file. Each service will have a serviceID and a factoryID. The serviceID is the unique name of the service, and is used when using the service (such as starting a session on a reader). The factoryID is the ID of the factory that can create a service. The following is an example of file that has one Alien Reader saved.
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configurationStore>
<services>
<attributes>
<entry>
<key>ReconnectionInterval</key>
<value>500</value>
</entry>
<entry>
<key>Port</key>
<value>20000</value>
</entry>
<entry>
<key>InvertExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>PersistTime</key>
<value>-1</value>
</entry>
<entry>
<key>Username</key>
<value>alien</value>
</entry>
<entry>
<key>Password</key>
<value>password</value>
</entry>
<entry>
<key>InvertExternalInput</key>
<value>0</value>
</entry>
<entry>
<key>ReaderNumber</key>
<value>0</value>
</entry>
<entry>
<key>ExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>IpAddress</key>
<value>127.0.0.1</value>
</entry>
<entry>
<key>MaxNumConnectionAttempts</key>
<value>10</value>
</entry>
<entry>
<key>RFAttenuation</key>
<value>0</value>
</entry>
</attributes>
<factoryID>Alien</factoryID>
<serviceID>Alien_1</serviceID>
</services>
</configurationStore>
</pre>

Edge Server Configuration

2010-09-02T19:48:59Z

Kyle: /* Default .ini file */

This page explains the various configuration options of the Rifidi Edge Server
=RifidiEdgeServer.ini=
The RifidiEdgeServer.ini is a property file that contains options for various options when the edge server starts up.
==rifidiserver.ini file==
As of release 1.2.0, the default rifidiserver.ini file looks like this:
<pre>
-os
${target.os}
-ws
${target.ws}
-arch
${target.arch}
-nl
${target.nl}
-vmargs
-Declipse.ignoreApp=true
-Dosgi.console
-Dosgi.noShutdown=true
-Dorg.rifidi.edge.configuration=config/rifidi.xml
-Dosgi.clean=true
-Dorg.osgi.framework.bootdelegation=javax.xml.ws
-Dcom.sun.management.jmxremote.port=2021
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
-Djava.rmi.server.hostname=127.0.0.1
-Dorg.rifidi.edge.core.rmi.port=1101
-Dorg.rifidi.edge.ale.port=8081
-Dorg.rifidi.edge.ale.host=127.0.0.1
-Dosgi.framework.extensions=org.eclipse.equinox.weaving.hook
-Dorg.aspectj.osgi.verbose=true
-Dorg.rifidi.edge.autostart=true
-Dorg.rifidi.edge.logging=config/logging.properties
-Dorg.rifidi.ui.notify=true
</pre>

==Console==
;-console
:This starts up the OSGi console so that you can interact with the edge server from the command line. For a list of commands that are available see [[Edge Server Commands]]. If you would like the console to be available over the network, supply a port after the -console (e.g. -console 2020). Now it is possible to telnet into the server at the given port. It is recommended that you use ssh tunneling for security reasons (i.e. first ssh to the machine that is running the edge server, then telnet to the console). One thing to note is that after you telnet to the OSGi console, you cannot use the <tt>exit</tt> command as you normally would to close the telnet session. This is because <tt>exit</tt> will be caught by the OSGi console and will perform a System.exit(). Instead, to exit the telnet session while keeping the server running, just close the telnet window.
==VMArgs==
VMArgs must follow the <tt>-vmargs</tt> flag in the .ini file. They must start with <tt>-D</tt>. Default values can be found in the <tt>bundle.properties</tt> file in the spring directory for the appropriate option. Important VM args:
;-Dorg.rifidi.edge.configuration
:This is the path to the persistence file. See [[#rifidi.xml]].
;-Dcom.sun.management.jmxremote.port
:The port to open up JMX on. This is important if you are using a program like VisualVM to profile the server
;-Djava.rmi.server.hostname
:The hostname to open up the RMI registry at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.core.rmi.port
:The port of the RMI registry Default is <tt>1101</tt>
;-Dorg.rifidi.edge.ale.host
:The hostname to publish the ALE webservices at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.ale.port
:The port to publish the ALE webservices at. Default is <tt>8081</tt>
;-Dorg.rifidi.edge.ale.read
:The service name of the ALE reading service. Default is <tt>ALEService</tt>
;-Dorg.rifidi.edge.ale.logicalreader
:The service name of the ALE logical reader service. Default is <tt>ALELRService</tt>
;-Dorg.rifidi.edge.jms.hostname
:The hostname to use for JMS. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.jms.port
:The port to use for JMS. Default is <tt>1100</tt>
;-Dorg.rifidi.edge.jms.topic.tags
:The topic name that JMS will publish all tag read events at. Default is <tt>org.rifidi.edge.external.tags</tt>
;-Dorg.rifidi.edge.jms.topic.notifications
:The topic name that JMS will publish all notification events (such as when a reader is added or a session is started). Default is <tt>org.rifidi.edge.external.notifications</tt>

=rifidi.xml=
The rifidi.xml file is the persistence file for the Rifidi Edge Server. The two important services that are saved are Reader Configurations and Command Configurations.

==Loading a configuration file==
Whenever the edge server starts up, it looks for the file that is specified in the <tt>org.rifidi.configuration</tt> vm flag. After the configuration file is read, the server will attempt to recreate all services specified in the file. If a needed factory is not available, the service will be skipped and recreated when the factory becomes available. For example, suppose the configuration file has an Alien Reader Configuration and an LLRP Reader Configuration. Suppose that when the server starts up, only the Alien plugin is available (so the Alien Reader Factory is available, but the LLRP Reader Factory is not). At this point the Alien Reader is recreated. If later the LLRP plugin is installed, then the LLRP reader will be recreated.

==File Structure==
The edge server uses JAXB to persist a configuration file. Each service will have a serviceID and a factoryID. The serviceID is the unique name of the service, and is used when using the service (such as starting a session on a reader). The factoryID is the ID of the factory that can create a service. The following is an example of file that has one Alien Reader saved.
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configurationStore>
<services>
<attributes>
<entry>
<key>ReconnectionInterval</key>
<value>500</value>
</entry>
<entry>
<key>Port</key>
<value>20000</value>
</entry>
<entry>
<key>InvertExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>PersistTime</key>
<value>-1</value>
</entry>
<entry>
<key>Username</key>
<value>alien</value>
</entry>
<entry>
<key>Password</key>
<value>password</value>
</entry>
<entry>
<key>InvertExternalInput</key>
<value>0</value>
</entry>
<entry>
<key>ReaderNumber</key>
<value>0</value>
</entry>
<entry>
<key>ExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>IpAddress</key>
<value>127.0.0.1</value>
</entry>
<entry>
<key>MaxNumConnectionAttempts</key>
<value>10</value>
</entry>
<entry>
<key>RFAttenuation</key>
<value>0</value>
</entry>
</attributes>
<factoryID>Alien</factoryID>
<serviceID>Alien_1</serviceID>
</services>
</configurationStore>
</pre>

Edge Server Getting Started

2010-09-02T19:45:11Z

Kyle: /* Develop Your Own Application */

Thank you for your interest in the Rifidi Edge Server -- an open source platform for developing and deploying RFID applications. Here's how to get started:

==Run it==
# '''Download''' the [http://sourceforge.net/projects/rifidi/ Edge Server] from our sourceforge page. The download comes bundled with two programs: the '''Edge Server''' which does the core work of connecting to sensors (such as RFID readers), collecting tag information, and making that data available. It ships with adapters for Alien, LLRP, Awid, and several other types of RFID readers. It also ships with ALE support. The second program is '''Workbench''' which is a user interface that allows you to control the edge server and view tag information that it is collecting, as well as experiment with ALE.
# '''Download''' [http://sourceforge.net/projects/rifidi/files/ Rifidi Emulator]. This program allows you to virtualize several popular types of RFID readers on your desktop.
# '''Follow''' the [[Workbench User's Guide|quick start guide]] to start getting tag reads back from virtual readers.

==Develop Your Own Application==
The edge server by itself allows you to connect to sensors and collect tag data from them, but if you really want to put it to work, you will need to develop your own applications that run on the edge server.
# '''Download''' our SDK (Standard Development Kit). This provides our API, sourcecode and examples to help you get started. You can find out how to set up a development environment here: [[Edge Server Development Environment]].
# '''Develop''' an application. There are several example applications which ship with the Rifidi Edge Server. You can read about them in detail in the developer guide that is included in the release
# [[How_to_export_your_custom_Rifidi_application|'''Export''']] your application
# '''Deploy''' the application you've built. Once you've built and tested your application, you can deploy it onto the edge server that you've downloaded.

==Contribute Back==
The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome contributions of any sort (code, documentation, testing, etc) and encourage you to submit these back. To get involved with the community:
# '''Visit''' our [http://forums.rifidi.org forums]. This is the best place to talk to our developers and users of Rifidi.
# '''Submit''' feature requests and bug reports. We have a [https://trac.rifidi.org bug tracking system] that manages outstanding feature requests and bugs. Before you submit bug reports here, we ask that you visit us on the forums first and make sure that there isn't a known solution for your question already
# '''Contribute''' to our wiki. We gladly welcome any documentation in the form of HOWTOs, example code, tutorials, or any other form that you find helpful.

Sensor Plugin API

2010-09-02T19:43:43Z

Kyle:

An in-depth discussion of the Sensor API Architecture can be found in the developer documentation included with the SDK release 1.2.0 and above. You can also see the [[How to create a sensor plugin]] to learn about the Sensor API.

Rifidi Edge Server Application Tutorials

2010-09-02T19:42:42Z

Kyle:

With release 1.2.0 of the Rifidi Edge Server, a developer API is provided to make writing Rifidi Applications much easier. The best place to find out how to write applications is the developer document that is released as part of the SDK release. There are several example applications included with the SDK and the developer documentation describes them in detail.

Edge Server API

2010-09-02T19:39:48Z

Kyle:

*[http://rifidi.org/javadoc/edge1.0.0/ 1.0.0 JavaDoc]
*[http://rifidi.org/javadoc/edge1.2.0/ 1.2.0 JavaDoc]

Edge Server API

2010-06-04T17:51:16Z

Kyle:

*[http://rifidi.org/javadoc/edge1.0.0/ 1.0.0 JavaDoc]

Edge Server Development Environment

2010-05-07T01:49:41Z

Kyle: /* Configuring eclipse environment */

This document details the steps necessary to set up a development environment in order to either develop a custom Rifidi Edge Server application, or modify an existing Edge Server bundle.
=Configuring eclipse environment=
# [http://java.sun.com/javase/downloads/index.jsp Download] and install the latest version of the Java SE Development Kit (JDK) for your OS.
# [http://sourceforge.net/projects/rifidi/files/ Download] the latest version of the Rifidi Edge Server SDK.
# [http://www.eclipse.org/downloads/ Download] the Galileo release of Eclipse for RCP/Plugin developers.
# Run eclipse and create a new workspace.<br>[[Image:Edgeserver_dev_screenshot1.png]]
# Unzip the Rifidi Edge Server SDK into the newly created workspace directory on your file system.
# In eclipse go to File->Import. Choose "Existing Projects into Workspace". Now select the SDK folder (which must reside in workspace directory).<br>[[Image:Edgeserver_dev_screenshot2.png]]<br><br>[[Image:Edgeserver_dev_screenshot3.png]]<br>[[Image:Edgeserver_dev_screenshot4.png]]
# Open up the target platform file (the file that ends in .target). Click the button that says "set as target platform" on the upper right-hand corner of the page.<br>[[Image:Edgeserver_dev_screenshot5.png]]
# Go to Run->Run Configurations. Open up the Edge Server OSGi run configuration (might be an item under "OSGi Framework"). Click Run. For more information about the run configuration see [[How to configure the run configuration in eclipse]]<br>[[Image:Edgeserver_dev_screenshot6.png]]
Congratulations! You have successfully set up and configured your eclipse environment and are ready to develop an edge server application!

See the [[Developing a Rifidi Edge Server Application Tutorial]] for instructions on how to develop your first application to run on the edge server.

Edge Server Development Environment

2010-05-07T01:49:23Z

Kyle: /* Configuring eclipse environment */

This document details the steps necessary to set up a development environment in order to either develop a custom Rifidi Edge Server application, or modify an existing Edge Server bundle.
=Configuring eclipse environment=
# [http://java.sun.com/javase/downloads/index.jsp Download] and install the latest version of the Java SE Development Kit (JDK) for your OS.
# [http://sourceforge.net/projects/rifidi/files/] the latest version of the Rifidi Edge Server SDK.
# [http://www.eclipse.org/downloads/ Download] the Galileo release of Eclipse for RCP/Plugin developers.
# Run eclipse and create a new workspace.<br>[[Image:Edgeserver_dev_screenshot1.png]]
# Unzip the Rifidi Edge Server SDK into the newly created workspace directory on your file system.
# In eclipse go to File->Import. Choose "Existing Projects into Workspace". Now select the SDK folder (which must reside in workspace directory).<br>[[Image:Edgeserver_dev_screenshot2.png]]<br><br>[[Image:Edgeserver_dev_screenshot3.png]]<br>[[Image:Edgeserver_dev_screenshot4.png]]
# Open up the target platform file (the file that ends in .target). Click the button that says "set as target platform" on the upper right-hand corner of the page.<br>[[Image:Edgeserver_dev_screenshot5.png]]
# Go to Run->Run Configurations. Open up the Edge Server OSGi run configuration (might be an item under "OSGi Framework"). Click Run. For more information about the run configuration see [[How to configure the run configuration in eclipse]]<br>[[Image:Edgeserver_dev_screenshot6.png]]
Congratulations! You have successfully set up and configured your eclipse environment and are ready to develop an edge server application!

See the [[Developing a Rifidi Edge Server Application Tutorial]] for instructions on how to develop your first application to run on the edge server.

Main Page

2010-04-13T19:14:09Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>
<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>[http://rifidi.org/ About Rifidi]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

How to Contribute to the Rifidi project

2010-04-13T19:13:00Z

Kyle:

The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome contributions of any sort (code, documentation, testing, etc) and encourage you to submit these back. To get involved with the community:
# '''Visit''' our [http://forums.rifidi.org forums]. This is the best place to talk to our developers and users of Rifidi.
# '''Submit''' feature requests and bug reports. We have a [https://trac.rifidi.org bug tracking system] that manages outstanding feature requests and bugs. Before you submit bug reports here, we ask that you visit us on the forums first and make sure that there isn't a known solution for your question already
# '''Contribute''' to our wiki. We gladly welcome any documentation in the form of HOWTOs, example code, tutorials, or any other form that you find helpful.

For more information, please send emails to info@pramari.com

How to Contribute to the Rifidi project

2010-04-13T19:12:27Z

Kyle: New page: The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome c...

The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome contributions of any sort (code, documentation, testing, etc) and encourage you to submit these back. To get involved with the community:
Visit our forums. This is the best place to talk to our developers and users of Rifidi.
Submit feature requests and bug reports. We have a bug tracking system that manages outstanding feature requests and bugs. Before you submit bug reports here, we ask that you visit us on the forums first and make sure that there isn't a known solution for your question already
Contribute to our wiki. We gladly welcome any documentation in the form of HOWTOs, example code, tutorials, or any other form that you find helpful.

For more information, please send emails to info@pramari.com

Main Page

2010-04-13T19:12:01Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>
<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>About Rifidi</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>[[How to Contribute to the Rifidi project]]</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

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

2010-04-12T21:23:44Z

Kyle: New page: The Rifidi suite allows you to build a complete, end-to-end solution from prototype to production system. This page demonstrates how you can use three Rifidi projects together to build an ...

The Rifidi suite allows you to build a complete, end-to-end solution from prototype to production system. This page demonstrates how you can use three Rifidi projects together to build an asset tracking solution.

To get started, download the [http://rifidi.org/apps/AssetTrackingSolution.zip asset tracking solution]. To run the demonstration, you will need to be running MS Windows (xp, vista, or 7) and java 6.

==Asset Tracking==
Every year, thousands of dollars in assets are lost due to theft of high value equipment. RFID technology has the potential to alleviate this problem. This demonstration shows how you can use the Rifidi suite to build a complete asset tracking solution. It includes a "virtual infrastructure" for use in demonstrations, the Rifidi Edge Server which collects tag reads, processes business rules, and provides integration with a client, and Workbench, which serves as both a management tool for the Edge Server and a monitor for the business events.

==Prototyper==
Prototyper is a 2D layer on top of the Rifidi RFID reader emulation engine that allows you to quickly build out RFID-enabled business processes. Because Prototyper emulates RFID readers, RFID software (such as the Rifidi Edge Server) can then talk to the prototype in the same way it would talk to real hardware readers; in fact, the RFID software doesn't know that it's not talking to the real readers!

To get started with the Asset Tracking Solution, open up Prototyper. Go to File->Open Prototype and choose hospitalAssetTracking.rifidi.

[[Image:Prototyper-1.png|thumb|none|600px]]

This map is the virtual infrastructure in an RFID-enabled Hospital. There are several read zones which are denoted on the map as antennas. There are several tagged items, including patients, microscopes, and mobile x-ray machines.

To use the prototype, take Prototyper out of edit mode by clicking the edge mode button at the top. At this point you can move assets around the floorplan. When you drag an asset on top of a read zone, a message will appear in the console indicating that an asset is now in the read zone.

==Edge Server==
To get value out of an RFID solution, you need software that talks to RFID readers. The Rifidi Edge Server fills this need. The Edge Server is more than just software that collects tag IDs, however; It's an RFID application platform. This means that you can write your own code to fill your own business and integration needs and deploy it onto the Edge Server. The Edge Server takes care of the work of parsing reader protocols, reader management, sensor integration, tag filtering and aggregation and other common needs.

For this application, we have built a simple application that listens for new tags to arrive in read zones. When this happens, it sends out an event message over JMS. When a tag has not been detected for a period of time (a few second for this demo), the application assumes the asset has departed from the read zone, and the application sends out another message over JMS to indicate that the asset can no longer be seen.

To run the Rifidi Edge Server, run the Rifidi Edge Server executable.

==Workbench==

At this point the Rifidi Edge Server is processing asset tracking business events, but there is no software which is listening to the JMS queue. We developed a plugin for Workbench that listens for business events generated by the asset tracking Edge Server application. To use it, open up Rifidi Workbench. Right click on the Edge Server in the Edge Server View, and select "connect". A list of all the reader configurations on the Edge Server will appear with their sessions in the connected state (indicated by a green light).

[[Image:Workbench-1.png|thumb|none|600px]]

Click on the "Event Monitor" button at the top. This brings up the Event Monitor perspective, which displays tracking messages from the asset tracking Edge Server application. If you move assets around on prototyper, you will be able to see messages appear in the event monitor.

[[Image:Workbench-2.png|thumb|none|600px]]

File:Workbench-2.png

2010-04-12T21:20:23Z

Kyle:

File:Workbench-1.png

2010-04-12T21:20:12Z

Kyle:

File:Prototyper-1.png

2010-04-12T20:28:57Z

Kyle:

Main Page

2010-04-12T18:40:06Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>
<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>[[Asset Tracking: An end-to end solution with the Rifidi Platform]]</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>About Rifidi</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>How to Contribute to the Rifidi project</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Main Page

2010-04-08T18:09:25Z

Kyle:

<table border="0" style="width: 100%">
<tr
style="text-align:center;margin-left:auto;margin-right:auto">
<td colspan="2" style="background-color:rgb(240, 247, 255)"><h1>Welcome
to the <strong>RIFIDI Community Wiki</strong></h1>

<p>RIFIDI is an open source RFID Middleware Platform</p>

<p>Please find out how to [[Documentation Guidelines|contribute to the Wiki]] before you begin
editing. </p>
</td>
</tr>
<tr>
<td>
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Edge Server</strong></div>
<hr>

<p><strong>User Documentation</strong></p>
<ul>
<li>[[Edge Server Getting Started|Getting Started]]</li>
<li>[[Edge Server Configuration|Configuration]]</li>
<li>[[Edge Server Console|Console]]</li>
<li>[[Edge Server Sensor Plugins | Sensor Plugin User's Guide]]
<li>[[Installing an Application]]
</ul>

<p><strong>Developer
Documentation </strong></p>
<ul>
<li>[[Rifidi Edge Server Application Tutorials]]</li>
<li>[[Edge Server API]]</li>
<li>[[Sensor Plugin API]]</li>
<li>[[Edge Server Architecture|Architecture]]</li>
<li>[[Edge Server Development Environment|Setting up a Development Environment]]</li>
<li>[[Edge Server HOWTOs | HOWTOs]]
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Workbench</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Workbench User's Guide|Getting Started]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>Plugging in a custom RCP perspective</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong">Toolkit</strong></div>
<hr>
<p><strong>User Documentation</strong> </p>
<ul>
<li>[[Emulator User's Guide]]</li>
<li>[[Prototyper User's Guide]]</li>
<li>[[Tag Streamer User's Guide]]</li>
<li>[[Release Features]]</li>
<li>[[:Category:userDoc|browse more user documents...]]</li>
</ul>

<p><strong>Developer Documentation </strong></p>
<ul>
<li>[[Emulator documentation summary | Emulator Documentation]]</li>
<li>[[tag streamer documentation summary | Tag Streamer Documentation]]</li>
<li>Virtual [[Reader Guides]]</li>
<li>[[Development Process| How to Develop Rifidi]]</li>
<li> [[:Category:developerDoc|browse more developer documents...]]</li>
</ul>
</td>
</tr>
</table>
</td>
<td valign="top">
<table border="0" style="width:80%">
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Rifidi Suite</strong></div>
<hr>
<ul>
<li>Developing an End-to-End RFID solution with Rifidi</li>
<li>[[Rifidi roadmap|Rifidi Roadmap]]</li>
<li>About Rifidi</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>General Information</strong></div>
<hr>
<ul>
<li>[[Developer FAQ]]</li>
<li>How to Contribute to the Rifidi project</li>
</ul>
</td>
</tr>
<tr>
<td><p></p>
</td>
</tr>
<tr>
<td style="background-color:rgb(240, 247, 255)"><div style="text-align:center" ><strong>Useful Links</strong></div>
<hr>
<p><strong>Rifidi Project</strong></p>
<ul>
<li>[http://forums.rifidi.org Rifidi Forums]</li>
<li>[https://trac.rifidi.org/rep-edge-trac/ Rifidi Bug Tracker]
<li>[http://sourceforge.net/projects/rifidi/ Rifidi's Sourceforge Page]</li>
<li>[https://svn.rifidi.org/svn/rep-external Rifidi Source SVN]</li>
<li>[http://www.pramari.com Pramari's Website]</li>
</ul>

<p><strong>Other Projects</strong></p>
<ul>
<li>[http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ Spring]</li>
<li>[http://esper.codehaus.org/about/esper/esper.html Esper]</li>
<li>[http://help.eclipse.org/galileo/index.jsp Eclipse]</li>
<li>[http://springsource.com/repository/app/ Spring Enterprise Bundle Repository]</li>
</ul>
</td>
</tr>
</table>
</td>
</tr>
</table>

Configure An EdgeBox

2010-02-09T01:04:57Z

Kyle: /* Intall and Configure Edge Server */

This page explains how to configure a Rifidi Edge Box. It steps through the process of installing and configuring linux on a machine for the edge server to run on. It takes about 1 hour 30 min to complete.

==Prepare a USB installer==
# Download UNetbootin. This is a program that will automatically download Ubuntu's Net Installer and create a USB drive installer for you.
# Insert a blank USB key into your computer. Open UNetbootin. Select Ubuntu/9.10_NetInstall.
==Install and Configure Linux==
* Before you begin the installation, plug a monitor, keyboard, and ethernet cable into the Edge Box. For this installation, it is required that the Edge Box have access to the internet.
* Turn the ebox on, and open up the BIOS configuration. Ensure that the ebox will boot from USB.
* Insert the USB drive that you made in the previous step into the USB port. Restart the Edge Box.
* Step through the Ubunutu installation wizard. Here is some important information about how to standardize the installation:
** If the "Configure Network" step does not work, you may have the ethernet cable plugged in to the wrong port.
** For the hostname use rifidi-ebox-#, where # is an id, such as 0.
** When partitioning the disk, choose "guided partition, use entire disk". Make sure to select the hard drive and not the USB!
** Make the full name "Rifidi"
** Make the username "rifidi"
** Make the password "rifidi"
** Choose no automatic updates.
** Choose to install OpenSSH server only.
* After the installation is complete, remove the USB drive, and restart the Edge Box. Log into it using "rifidi/rifidi"
* Install a text editor like VIm if you don't like nano.
<pre>sudo apt-get install vim</pre>
*Now edit /etc/network/interfaces to look like this:
<pre>sudo vim /etc/network/interfaces</pre>
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# Use these two lines if you want DHCP
#auto eth0
#iface eth0 inet dhcp

#Use these lines if you want static
auto eth0
iface eth0 inet static
address 192.168.1.125
netmask 255.255.255.0
gateway 192.168.1.1
</pre>
* To refresh the network changes, type this:
<pre>
sudo ifdown eth0
sudo ifup eth0
</pre>
* Install java:
<pre>sudo apt-get install sun-java6-jre</pre>
*Remove avahi-daemon for security reasons
<pre>sudo apt-get purge avahi-daemon</pre>
==Intall and Configure Edge Server==
* Copy the latest version of the Rifidi Edge Server into /home/rifidi
<pre>cd ~
sudo wget http://dl.dropbox.com/u/1513839/pramari/Rifidi-Edge-1.1.beta.zip
</pre>
* Unizp the server and move the rifidi folder to /usr/local/sbin
<pre>sudo apt-get install unzip
unzip Rifidi-Edge-1.1.beta.zip
cd Rifidi-Edge-1.1.beta
sudo mv rifidi /usr/local/sbin
</pre>
*Make rifidiserver an executable
<pre>cd /usr/local/sbin/rifidi
sudo chmod+x rifidiserver</pre>
* Move the startup script to /etc/init.d
<pre>cd startupscript
sudo mv rifidiserver /etc/init.d</pre>
*Now generate the symbolic links necessary for the init deamon to use the rifidiserver startup script when the system starts up:
<pre>cd /etc/init.d
sudo chmod 755 rifidiserver
sudo update-rc.d blah defaults</pre>
* You can now start and stop the rifidi edgeserver like this:
<pre>sudo /etc/init.d/rifidiserver start
sudo /etc/inti.d/rifidiserver stop</pre>

You can edit the properties of the edge server in the rifidiserver.ini file in the /usr/local/sbin/rifidi folder. One important property that you don't change without knowing what you are doing is the osgi.console property. The osgi.console property opens up a telnet port at 2020 so that you can telnet into the server for administrative control. However, since telnet is not secure, the startup scripts blocks port 2020 from the outside. In order to access the osgi console, first ssh into the edge box, then telnet to localhost port 2020. If you need to change this port, you need to edit the startup script so that the new osgi console port is secured properly.

In order to open up access to the workbench over the network, set the rmi hostname and jms hostname to the address of the edge box (e.g. 192.168.1.125).

Configure An EdgeBox

2010-02-09T01:04:29Z

Kyle: /* Intall and Configure Edge Server */

This page explains how to configure a Rifidi Edge Box. It steps through the process of installing and configuring linux on a machine for the edge server to run on. It takes about 1 hour 30 min to complete.

==Prepare a USB installer==
# Download UNetbootin. This is a program that will automatically download Ubuntu's Net Installer and create a USB drive installer for you.
# Insert a blank USB key into your computer. Open UNetbootin. Select Ubuntu/9.10_NetInstall.
==Install and Configure Linux==
* Before you begin the installation, plug a monitor, keyboard, and ethernet cable into the Edge Box. For this installation, it is required that the Edge Box have access to the internet.
* Turn the ebox on, and open up the BIOS configuration. Ensure that the ebox will boot from USB.
* Insert the USB drive that you made in the previous step into the USB port. Restart the Edge Box.
* Step through the Ubunutu installation wizard. Here is some important information about how to standardize the installation:
** If the "Configure Network" step does not work, you may have the ethernet cable plugged in to the wrong port.
** For the hostname use rifidi-ebox-#, where # is an id, such as 0.
** When partitioning the disk, choose "guided partition, use entire disk". Make sure to select the hard drive and not the USB!
** Make the full name "Rifidi"
** Make the username "rifidi"
** Make the password "rifidi"
** Choose no automatic updates.
** Choose to install OpenSSH server only.
* After the installation is complete, remove the USB drive, and restart the Edge Box. Log into it using "rifidi/rifidi"
* Install a text editor like VIm if you don't like nano.
<pre>sudo apt-get install vim</pre>
*Now edit /etc/network/interfaces to look like this:
<pre>sudo vim /etc/network/interfaces</pre>
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# Use these two lines if you want DHCP
#auto eth0
#iface eth0 inet dhcp

#Use these lines if you want static
auto eth0
iface eth0 inet static
address 192.168.1.125
netmask 255.255.255.0
gateway 192.168.1.1
</pre>
* To refresh the network changes, type this:
<pre>
sudo ifdown eth0
sudo ifup eth0
</pre>
* Install java:
<pre>sudo apt-get install sun-java6-jre</pre>
*Remove avahi-daemon for security reasons
<pre>sudo apt-get purge avahi-daemon</pre>
==Intall and Configure Edge Server==
* Copy the latest version of the Rifidi Edge Server into /home/rifidi
<pre>cd ~
sudo wget http://dl.dropbox.com/u/1513839/pramari/Rifidi-Edge-1.1.beta.zip
</pre>
* Unizp the server and move the rifidi folder to /usr/local/sbin
<pre>sudo apt-get install unzip
unzip Rifidi-Edge-1.1.beta.zip
cd Rifidi-Edge-1.1.beta
sudo mv rifidi /usr/local/sbin
</pre>
*Make rifidiserver an executable
<pre>cd /usr/local/sbin/rifidi
sudo chmod+x rifidiserver</pre>
* Move the startup script to /etc/init.d
<pre>cd startupscript
sudo mv rifidiserver /etc/init.d</pre>
*Now generate the symbolic links necessary for the init deamon to use the rifidiserver startup script when the system starts up:
<pre>cd /etc/init.d
sudo chmod 755 rifidiserver
sudo update-rc.d blah defaults</pre>
* You can now start and stop the rifidi edgeserver like this:
<pre>sudo /etc/init.d/rifidiserver starte
sudo /etc/inti.d/rifidiserver stop</pre>

You can edit the properties of the edge server in the rifidiserver.ini file in the /usr/local/sbin/rifidi folder. One important property that you don't change without knowing what you are doing is the osgi.console property. The osgi.console property opens up a telnet port at 2020 so that you can telnet into the server for administrative control. However, since telnet is not secure, the startup scripts blocks port 2020 from the outside. In order to access the osgi console, first ssh into the edge box, then telnet to localhost port 2020. If you need to change this port, you need to edit the startup script so that the new osgi console port is secured properly.

In order to open up access to the workbench over the network, set the rmi hostname and jms hostname to the address of the edge box (e.g. 192.168.1.125).

Configure An EdgeBox

2010-02-09T01:04:01Z

Kyle: New page: This page explains how to configure a Rifidi Edge Box. It steps through the process of installing and configuring linux on a machine for the edge server to run on. It takes about 1 hour 30...

This page explains how to configure a Rifidi Edge Box. It steps through the process of installing and configuring linux on a machine for the edge server to run on. It takes about 1 hour 30 min to complete.

==Prepare a USB installer==
# Download UNetbootin. This is a program that will automatically download Ubuntu's Net Installer and create a USB drive installer for you.
# Insert a blank USB key into your computer. Open UNetbootin. Select Ubuntu/9.10_NetInstall.
==Install and Configure Linux==
* Before you begin the installation, plug a monitor, keyboard, and ethernet cable into the Edge Box. For this installation, it is required that the Edge Box have access to the internet.
* Turn the ebox on, and open up the BIOS configuration. Ensure that the ebox will boot from USB.
* Insert the USB drive that you made in the previous step into the USB port. Restart the Edge Box.
* Step through the Ubunutu installation wizard. Here is some important information about how to standardize the installation:
** If the "Configure Network" step does not work, you may have the ethernet cable plugged in to the wrong port.
** For the hostname use rifidi-ebox-#, where # is an id, such as 0.
** When partitioning the disk, choose "guided partition, use entire disk". Make sure to select the hard drive and not the USB!
** Make the full name "Rifidi"
** Make the username "rifidi"
** Make the password "rifidi"
** Choose no automatic updates.
** Choose to install OpenSSH server only.
* After the installation is complete, remove the USB drive, and restart the Edge Box. Log into it using "rifidi/rifidi"
* Install a text editor like VIm if you don't like nano.
<pre>sudo apt-get install vim</pre>
*Now edit /etc/network/interfaces to look like this:
<pre>sudo vim /etc/network/interfaces</pre>
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# Use these two lines if you want DHCP
#auto eth0
#iface eth0 inet dhcp

#Use these lines if you want static
auto eth0
iface eth0 inet static
address 192.168.1.125
netmask 255.255.255.0
gateway 192.168.1.1
</pre>
* To refresh the network changes, type this:
<pre>
sudo ifdown eth0
sudo ifup eth0
</pre>
* Install java:
<pre>sudo apt-get install sun-java6-jre</pre>
*Remove avahi-daemon for security reasons
<pre>sudo apt-get purge avahi-daemon</pre>
==Intall and Configure Edge Server==
* Copy the latest version of the Rifidi Edge Server into /home/rifidi
<pre>cd ~
sudo wget http://dl.dropbox.com/u/1513839/pramari/Rifidi-Edge-1.1.beta.zip
</pre>
* Unizp the server and move the rifidi folder to /usr/local/sbin
<pre>sudo apt-get install unzip
unzip Rifidi-Edge-1.1.beta.zip
cd Rifidi-Edge-1.1.beta
sudo mv rifidi /usr/local/sbin
</pre>
*Make rifidiserver an executable
<pre>cd /usr/local/sbin/rifidi
sudo chmod+x rifidiserver
* Move the startup script to /etc/init.d
<pre>cd startupscript
sudo mv rifidiserver /etc/init.d</pre>
*Now generate the symbolic links necessary for the init deamon to use the rifidiserver startup script when the system starts up:
<pre>cd /etc/init.d
sudo chmod 755 rifidiserver
sudo update-rc.d blah defaults</pre>
* You can now start and stop the rifidi edgeserver like this:
<pre>sudo /etc/init.d/rifidiserver starte
sudo /etc/inti.d/rifidiserver stop</pre>

You can edit the properties of the edge server in the rifidiserver.ini file in the /usr/local/sbin/rifidi folder. One important property that you don't change without knowing what you are doing is the osgi.console property. The osgi.console property opens up a telnet port at 2020 so that you can telnet into the server for administrative control. However, since telnet is not secure, the startup scripts blocks port 2020 from the outside. In order to access the osgi console, first ssh into the edge box, then telnet to localhost port 2020. If you need to change this port, you need to edit the startup script so that the new osgi console port is secured properly.

In order to open up access to the workbench over the network, set the rmi hostname and jms hostname to the address of the edge box (e.g. 192.168.1.125).

Rifidi Edge Server Application Tutorials

2010-02-02T14:33:01Z

Kyle:

The Rifidi Edge Server is an application platform that provides developers with a way to quickly develop and deploy RFID applications. This page lists several tutorials that will help you get started learning the Rifidi platform.
;[[Northwind Tutorial]]
:This tutorial is an in-depth, step-by-step guide for absolute beginners. It delves into details about how to get started doing everything from creating an eclipse project to dependency injection using spring to writing a JSP. The tutorial show you how to create some esper statements that filter on certain events, push the out events over JMS, use spring to listen to a JMS Queue, and display the events in using a JSP deployed as a web application.
;[[Database Tutorial]]
:This is a short tutorial that shows you how to build an application which collects information from readers and inserts them into a database. It uses JDBC and spring for database connectivity. The example has been tested with both an embedded derby and MySQL database. It also shows you how to contribute commands to the osgi command interface so that you can control the application. It has much less detail than the Northwind tutorial.

After you have written your own application, you will need to export it so that you can deploy it on the Rifidi Edge Sever. Follow these [[How_to_export_your_custom_Rifidi_application | instructions]] to learn how.

Edge Server Getting Started

2010-02-02T14:31:46Z

Kyle: /* Develop Your Own Application */

Thank you for your interest in the Rifidi Edge Server -- an open source platform for developing and deploying RFID applications. Here's how to get started:

==Run it==
# '''Download''' the [http://sourceforge.net/projects/rifidi/ Edge Server] from our sourceforge page. The download comes bundled with two programs: the '''Edge Server''' which does the core work of connecting to sensors (such as RFID readers), collecting tag information, and making that data available. It ships with adapters for Alien, LLRP, Awid, and several other types of RFID readers. It also ships with ALE support. The second program is '''Workbench''' which is a user interface that allows you to control the edge server and view tag information that it is collecting, as well as experiment with ALE.
# '''Download''' [http://sourceforge.net/projects/rifidi/files/ Rifidi Emulator]. This program allows you to virtualize several popular types of RFID readers on your desktop.
# '''Follow''' the [[Workbench User's Guide|quick start guide]] to start getting tag reads back from virtual readers.

==Develop Your Own Application==
The edge server by itself allows you to connect to sensors and collect tag data from them, but if you really want to put it to work, you will need to develop your own applications that run on the edge server.
# '''Download''' our SDK (Standard Development Kit). This provides our API, sourcecode and examples to help you get started. You can find out how to set up a development environment here: [[Edge Server Development Environment]].
# '''Develop''' an application. We currently have a couple of [[Rifidi_Edge_Server_Application_Tutorials| tutorials]] on our wiki that explain the process of developing an application in a step-by-step manner. There will be more to come.
# [[How_to_export_your_custom_Rifidi_application|'''Export''']] your application
# '''Deploy''' the application you've built. Once you've built and tested your application, you can deploy it onto the edge server that you've downloaded.

==Contribute Back==
The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome contributions of any sort (code, documentation, testing, etc) and encourage you to submit these back. To get involved with the community:
# '''Visit''' our [http://forums.rifidi.org forums]. This is the best place to talk to our developers and users of Rifidi.
# '''Submit''' feature requests and bug reports. We have a [https://trac.rifidi.org bug tracking system] that manages outstanding feature requests and bugs. Before you submit bug reports here, we ask that you visit us on the forums first and make sure that there isn't a known solution for your question already
# '''Contribute''' to our wiki. We gladly welcome any documentation in the form of HOWTOs, example code, tutorials, or any other form that you find helpful.

How to export your custom Rifidi application

2010-02-02T14:27:43Z

Kyle: New page: Once you have finished writing, debuging, and testing your application, you will need to export it so that you can put it in the applications folder of the Rifidi Edge Server. ==Step 1: ...

Once you have finished writing, debuging, and testing your application, you will need to export it so that you can put it in the applications folder of the Rifidi Edge Server.

==Step 1: Export the Application Bundles==
# Open up the Manifest.MF of your application bundle. If you have more than one bundle in your application, just pick one. [[Image:ExportApp1.png|thumb|600px|none]]
# Click on "Export Wizard" in the Exporting section
# Select the bundle(s) that comprise your application.
# Choose a Directory to export to. Usually it is easiest to export to Desktop [[Image:exportApp2.png|thumb|none|400px]]
# In the options tab, choose to package as individual JAR archives. Also, unselect the qualifier replacement.
# Click finish.

==Step 2: Create the Application==
# Create a new folder, and give it the name of the application. For example, "AcmeApp"
# Move the plugins folder that was created during Step 1 into the new applications folder
# If you have any other bundle dependencies that are not provided by the edge server, drop them into the plugins folder. For example in the dbapp, the mysql driver bundle is not provided by the edge server core. So it is necessary to drop this dependency into the plugins folder.
# Download the [http://www.osgi.org/Repository/BIndex bindex] utility.
# Copy bindex.jar into the application folder.
# From the command line, cd into the application folder.
# Type 'java -jar bindex plugins/*.jar'. This should create a file called repository.xml in the application folder. [[Image:exportApp3.png|none|thumb|400px]]
# Delete bindex.jar from the application folder

==Step 3: Deploy the Application==
# Copy the application that you have just created into the applications folder in the edge server
# Start the edge server. After everything starts up, type 'loadApp <appname>' where <appname> is the name of the application folder that you created in step 2. For example 'loadApp AcmeApp'.

File:ExportApp3.png

2010-02-02T14:24:38Z

Kyle:

File:ExportApp2.png

2010-02-02T14:24:12Z

Kyle:

File:ExportApp1.png

2010-02-02T14:23:39Z

Kyle:

Edge Server HOWTOs

2010-02-02T13:08:10Z

Kyle:

*[[How to change logging levels]]
*[[How to export a service using RMI]]
*[[How to export a service using web services]]
*[[EdgeServerJMS#Setting up a Consumer|How to consume tag events from the Internal JMS Message Bus]]
*[[How to write esper queries]]
*[[How to configure Manifest.MF in my bundle]]
*[[How to configure spring.xml in my bundle]]
*[[How to use OSGi Services]]
*[[How to create a sensor plugin]]
*[[How to configure the run configuration in eclipse]]
*[[How to Add your own event types to Esper]]
*[[How to export your custom Rifidi application]]

Edge Server Getting Started

2010-02-02T13:07:09Z

Kyle: /* Develop Your Own Application */

Thank you for your interest in the Rifidi Edge Server -- an open source platform for developing and deploying RFID applications. Here's how to get started:

==Run it==
# '''Download''' the [http://sourceforge.net/projects/rifidi/ Edge Server] from our sourceforge page. The download comes bundled with two programs: the '''Edge Server''' which does the core work of connecting to sensors (such as RFID readers), collecting tag information, and making that data available. It ships with adapters for Alien, LLRP, Awid, and several other types of RFID readers. It also ships with ALE support. The second program is '''Workbench''' which is a user interface that allows you to control the edge server and view tag information that it is collecting, as well as experiment with ALE.
# '''Download''' [http://sourceforge.net/projects/rifidi/files/ Rifidi Emulator]. This program allows you to virtualize several popular types of RFID readers on your desktop.
# '''Follow''' the [[Workbench User's Guide|quick start guide]] to start getting tag reads back from virtual readers.

==Develop Your Own Application==
The edge server by itself allows you to connect to sensors and collect tag data from them, but if you really want to put it to work, you will need to develop your own applications that run on the edge server.
# '''Download''' our SDK (Standard Development Kit). This provides our API, sourcecode and examples to help you get started. You can find out how to set up a development environment here: [[Edge Server Development Environment]].
# '''Develop''' an application. We currently have a couple of [[Rifidi_Edge_Server_Application_Tutorials| tutorials]] on our wiki that explain the process of developing an application in a step-by-step manner. There will be more to come.
# '''Deploy''' the application you've built. Once you've built and tested your application, you can deploy it onto the edge server that you've downloaded.

==Contribute Back==
The Rifidi Edge Server is open source. This means that if you find bugs or have ideas for useful features, you have the ability to extend the edge server yourself! We will gladly welcome contributions of any sort (code, documentation, testing, etc) and encourage you to submit these back. To get involved with the community:
# '''Visit''' our [http://forums.rifidi.org forums]. This is the best place to talk to our developers and users of Rifidi.
# '''Submit''' feature requests and bug reports. We have a [https://trac.rifidi.org bug tracking system] that manages outstanding feature requests and bugs. Before you submit bug reports here, we ask that you visit us on the forums first and make sure that there isn't a known solution for your question already
# '''Contribute''' to our wiki. We gladly welcome any documentation in the form of HOWTOs, example code, tutorials, or any other form that you find helpful.

Using the Engine API

2010-01-27T15:52:41Z

Kyle: /* Run the program */

[[Category:developerDoc]][[Category:EmulatorDoc]]
This page describes how to create an instance of the Rifidi engine, create readers, and add and remove tags from that engine all programatically via RMI. It is a tutorial for creating a "hello world" Rifidi application just to show you how the engine works. In production code, however, you shouldn't run the program from the activator.
=Download the source code=
In order to use the Engine API, you will first need to download the core rifidi plugins from svn. See [[Rifidi:Source_Code|Running Rifidi from Source]] for instructions on how to do this
=Create a new OSGi bundle=
Because Rifidi is OSGi based, all code must be written inside an OSGi bundle. The thing you will need to create a new OSGi bundle for your code to run in. To do this, follow the same steps as in [[Create a new reader project]]. You do not need to add the project to svn.

For this example, you will want to declare dependencies on the following plugins:
* org.rifidi.emulator
* org.rifidi.services
* org.rifidi.tags
* org.rifidi.emulator.reader.alien

=Create a program=
# Create a new package.
## Right click on the package found in the src directory.
## Select new package
## Give the package a name and select Finish
# Create a new class
## Right Click on the new package
## Select new class
## Give the class a name and click finish
=Write the Hello World Application=
<pre>package testproj;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.ArrayList;
import java.util.HashSet;

import org.rifidi.emulator.manager.ReaderManager;
import org.rifidi.emulator.reader.module.GeneralReaderPropertyHolder;
import org.rifidi.services.annotations.Inject;
import org.rifidi.services.registry.ServiceRegistry;
import org.rifidi.tags.enums.TagGen;
import org.rifidi.tags.factory.TagCreationPattern;
import org.rifidi.tags.factory.TagFactory;
import org.rifidi.tags.id.TagType;
import org.rifidi.tags.impl.RifidiTag;

/**
* This class demonstrates how to use the Rifidi Engine RMI API to create a
* virtual reader and add tags to it.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class RifidiClass {

/**
* The reader manager - the service that controls the virtual RFID readers
*/
private ReaderManager readerManager;

public RifidiClass() {
// tell the service registry to inject dependencies into this object
ServiceRegistry.getInstance().service(this);
}

private void startReader() {
try {

/** The IP address of the virtual reader */
String READER_IP = "127.0.0.1";
/** The port of the virtual reader */
int READER_PORT = 20000;
String READER_NAME = "alien_test";

// The GeneralReaderPropertyHolder is the object that defines a new
// virtual reader to create
GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
readerProperties
.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
readerProperties.setNumAntennas(2);
readerProperties.setReaderName(READER_NAME);
readerProperties.setProperty("inet_address", READER_IP + ":"
+ READER_PORT);
readerProperties.setProperty("heartbeat_address", READER_IP
+ ":54321");
readerProperties.setNumGPIs(4);
readerProperties.setNumGPOs(8);

// create the virtual reader on the remote engine
readerManager.createReader(readerProperties);

// turn the reader on so that you can connect to it from a client
// (e.g. telnet)
readerManager.start(READER_NAME);

// The TagCreationPattern is the object that defines how to create a
// batch of tags
TagCreationPattern tagPattern = new TagCreationPattern();
tagPattern.setNumberOfTags(5);
tagPattern.setTagGeneration(TagGen.GEN2);
tagPattern.setTagType(TagType.SGTIN96);

// uses the TagFactory to generate some new tags
ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);

// Set the Unique IDs for each of the tags. This is *not* the EPC.
// The UniqueID is the ID used internally to differentiate between
// tags.
long id = 1;
for (RifidiTag tag : tags) {
tag.setTagEntitiyID(id++);
}

// add the tags to the virtual reader
readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));

// sleep for 500 miliseconds
Thread.sleep(500);

/*
* The next bit of code is "client" code. It is equivalent to
* connecting to an alien reader over telnet and seding the 'get
* taglist' command. It is only shown here to demonstrate that the
* tags that reader has been turned on and tags were added
* successfully.
*/

// create a new socket connection to the reader
Socket connection = new Socket(READER_IP, READER_PORT);

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

// send username and password
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));

// send get taglist command
out.write("t\n");
out.flush();
String returnVal = readFromReader(in);

// print tag list coming back from reader
System.out.println(returnVal);
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* This method reads from the socket.
*
* @param inBuf
* @return The string that was read
* @throws IOException
*/
public 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();
}

/**
* This method is called by the service registry to inject the ReaderManager
*
* @param readerManager
*/
@Inject
public void setReaderManager(ReaderManager readerManager) {
this.readerManager = readerManager;
// start the program now that we know the readerManager has been
// injected.
startReader();
}

}
</pre>

=Edit the Activator=
The Activator is the class that the OSGi framework uses to start and stop the bundle that you wrote. The start() method is called when your bundle is activated, and the stop() method is called when the bundle is deactivated. For an introduction to OSGi see [http://www.javaworld.com/javaworld/jw-03-2008/jw-03-osgi1.html this article].

Although this is a bad idea for production code, for the sake of simplicity, the start() method in the activator for this project starts the hello world class. This is the activator for the bundle:

<pre>package testproj;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import testproj.RifidiClass;

public class Activator implements BundleActivator {

/*
* (non-Javadoc)
*
* @see
* org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext
* )
*/
public void start(BundleContext context) throws Exception {
Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
t.start();
}

/*
* (non-Javadoc)
*
* @see
* org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
}

/**
* Run the program in a separate thread so we don't occupy the OSGi starter
* thread.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
private class TestRunner implements Runnable {

@Override
public void run() {
new RifidiClass();
}
}
}

</pre>

=Run the program=
To run this program from Eclipse, you need to create a new Run Configuration.
# Click Run->Run Configurations
# Double click on OSGi Framework on the tree on the left
# Select the required bundles. The 'bundles' list displays a list of the bundles that will be activated when you run the program. You only want the bundles selected that are required.
## Click 'Deselct All'
## Check the bundle that you just created.
## Check all the bundles that start with 'org.springframework...'
## Select 'Add Required Bundles'
#Click 'Run'

You should see alot of output in the console, and at the bottom of the output, you should see the tags that you "client" got from the reader:
<pre>
Tag:304A 37DA 04A4 4927 D1C8 0775, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:3008 26FD CCAC 1E53 612D 56EB, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:302E 5243 7D73 9CEF 1E8A 08FA, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:307A 11F3 960A B58C 7454 B248, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:308C 5BD0 BA14 CB02 55D4 89D5, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
</pre>

Using the Engine API

2010-01-27T15:46:33Z

Kyle: /* Edit the Activator */

[[Category:developerDoc]][[Category:EmulatorDoc]]
This page describes how to create an instance of the Rifidi engine, create readers, and add and remove tags from that engine all programatically via RMI. It is a tutorial for creating a "hello world" Rifidi application just to show you how the engine works. In production code, however, you shouldn't run the program from the activator.
=Download the source code=
In order to use the Engine API, you will first need to download the core rifidi plugins from svn. See [[Rifidi:Source_Code|Running Rifidi from Source]] for instructions on how to do this
=Create a new OSGi bundle=
Because Rifidi is OSGi based, all code must be written inside an OSGi bundle. The thing you will need to create a new OSGi bundle for your code to run in. To do this, follow the same steps as in [[Create a new reader project]]. You do not need to add the project to svn.

For this example, you will want to declare dependencies on the following plugins:
* org.rifidi.emulator
* org.rifidi.services
* org.rifidi.tags
* org.rifidi.emulator.reader.alien

=Create a program=
# Create a new package.
## Right click on the package found in the src directory.
## Select new package
## Give the package a name and select Finish
# Create a new class
## Right Click on the new package
## Select new class
## Give the class a name and click finish
=Write the Hello World Application=
<pre>package testproj;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.ArrayList;
import java.util.HashSet;

import org.rifidi.emulator.manager.ReaderManager;
import org.rifidi.emulator.reader.module.GeneralReaderPropertyHolder;
import org.rifidi.services.annotations.Inject;
import org.rifidi.services.registry.ServiceRegistry;
import org.rifidi.tags.enums.TagGen;
import org.rifidi.tags.factory.TagCreationPattern;
import org.rifidi.tags.factory.TagFactory;
import org.rifidi.tags.id.TagType;
import org.rifidi.tags.impl.RifidiTag;

/**
* This class demonstrates how to use the Rifidi Engine RMI API to create a
* virtual reader and add tags to it.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class RifidiClass {

/**
* The reader manager - the service that controls the virtual RFID readers
*/
private ReaderManager readerManager;

public RifidiClass() {
// tell the service registry to inject dependencies into this object
ServiceRegistry.getInstance().service(this);
}

private void startReader() {
try {

/** The IP address of the virtual reader */
String READER_IP = "127.0.0.1";
/** The port of the virtual reader */
int READER_PORT = 20000;
String READER_NAME = "alien_test";

// The GeneralReaderPropertyHolder is the object that defines a new
// virtual reader to create
GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
readerProperties
.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
readerProperties.setNumAntennas(2);
readerProperties.setReaderName(READER_NAME);
readerProperties.setProperty("inet_address", READER_IP + ":"
+ READER_PORT);
readerProperties.setProperty("heartbeat_address", READER_IP
+ ":54321");
readerProperties.setNumGPIs(4);
readerProperties.setNumGPOs(8);

// create the virtual reader on the remote engine
readerManager.createReader(readerProperties);

// turn the reader on so that you can connect to it from a client
// (e.g. telnet)
readerManager.start(READER_NAME);

// The TagCreationPattern is the object that defines how to create a
// batch of tags
TagCreationPattern tagPattern = new TagCreationPattern();
tagPattern.setNumberOfTags(5);
tagPattern.setTagGeneration(TagGen.GEN2);
tagPattern.setTagType(TagType.SGTIN96);

// uses the TagFactory to generate some new tags
ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);

// Set the Unique IDs for each of the tags. This is *not* the EPC.
// The UniqueID is the ID used internally to differentiate between
// tags.
long id = 1;
for (RifidiTag tag : tags) {
tag.setTagEntitiyID(id++);
}

// add the tags to the virtual reader
readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));

// sleep for 500 miliseconds
Thread.sleep(500);

/*
* The next bit of code is "client" code. It is equivalent to
* connecting to an alien reader over telnet and seding the 'get
* taglist' command. It is only shown here to demonstrate that the
* tags that reader has been turned on and tags were added
* successfully.
*/

// create a new socket connection to the reader
Socket connection = new Socket(READER_IP, READER_PORT);

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

// send username and password
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));

// send get taglist command
out.write("t\n");
out.flush();
String returnVal = readFromReader(in);

// print tag list coming back from reader
System.out.println(returnVal);
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* This method reads from the socket.
*
* @param inBuf
* @return The string that was read
* @throws IOException
*/
public 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();
}

/**
* This method is called by the service registry to inject the ReaderManager
*
* @param readerManager
*/
@Inject
public void setReaderManager(ReaderManager readerManager) {
this.readerManager = readerManager;
// start the program now that we know the readerManager has been
// injected.
startReader();
}

}
</pre>

=Edit the Activator=
The Activator is the class that the OSGi framework uses to start and stop the bundle that you wrote. The start() method is called when your bundle is activated, and the stop() method is called when the bundle is deactivated. For an introduction to OSGi see [http://www.javaworld.com/javaworld/jw-03-2008/jw-03-osgi1.html this article].

Although this is a bad idea for production code, for the sake of simplicity, the start() method in the activator for this project starts the hello world class. This is the activator for the bundle:

<pre>package testproj;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import testproj.RifidiClass;

public class Activator implements BundleActivator {

/*
* (non-Javadoc)
*
* @see
* org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext
* )
*/
public void start(BundleContext context) throws Exception {
Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
t.start();
}

/*
* (non-Javadoc)
*
* @see
* org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
}

/**
* Run the program in a separate thread so we don't occupy the OSGi starter
* thread.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
private class TestRunner implements Runnable {

@Override
public void run() {
new RifidiClass();
}
}
}

</pre>

=Run the program=
To run this program from Eclipse, you need to create a new Run Configuration.
# Click Run->Run Configurations
# Double click on OSGi Framework on the tree on the left
# Select the required bundles. The 'bundles' list displays a list of the bundles that will be activated when you run the program. You only want the bundles selected that are required.
## Click 'Deselct All'
## Check the bundle that you just created.
## Select 'Add Required Bundles'
#Click 'Run'

You should see alot of output in the console, and at the bottom of the output, you should see the tags that you "client" got from the reader:
<pre>
Tag:304A 37DA 04A4 4927 D1C8 0775, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:3008 26FD CCAC 1E53 612D 56EB, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:302E 5243 7D73 9CEF 1E8A 08FA, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:307A 11F3 960A B58C 7454 B248, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:308C 5BD0 BA14 CB02 55D4 89D5, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
</pre>

Using the Engine API

2010-01-27T15:46:00Z

Kyle: /* Create a new OSGi bundle */

[[Category:developerDoc]][[Category:EmulatorDoc]]
This page describes how to create an instance of the Rifidi engine, create readers, and add and remove tags from that engine all programatically via RMI. It is a tutorial for creating a "hello world" Rifidi application just to show you how the engine works. In production code, however, you shouldn't run the program from the activator.
=Download the source code=
In order to use the Engine API, you will first need to download the core rifidi plugins from svn. See [[Rifidi:Source_Code|Running Rifidi from Source]] for instructions on how to do this
=Create a new OSGi bundle=
Because Rifidi is OSGi based, all code must be written inside an OSGi bundle. The thing you will need to create a new OSGi bundle for your code to run in. To do this, follow the same steps as in [[Create a new reader project]]. You do not need to add the project to svn.

For this example, you will want to declare dependencies on the following plugins:
* org.rifidi.emulator
* org.rifidi.services
* org.rifidi.tags
* org.rifidi.emulator.reader.alien

=Create a program=
# Create a new package.
## Right click on the package found in the src directory.
## Select new package
## Give the package a name and select Finish
# Create a new class
## Right Click on the new package
## Select new class
## Give the class a name and click finish
=Write the Hello World Application=
<pre>package testproj;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.ArrayList;
import java.util.HashSet;

import org.rifidi.emulator.manager.ReaderManager;
import org.rifidi.emulator.reader.module.GeneralReaderPropertyHolder;
import org.rifidi.services.annotations.Inject;
import org.rifidi.services.registry.ServiceRegistry;
import org.rifidi.tags.enums.TagGen;
import org.rifidi.tags.factory.TagCreationPattern;
import org.rifidi.tags.factory.TagFactory;
import org.rifidi.tags.id.TagType;
import org.rifidi.tags.impl.RifidiTag;

/**
* This class demonstrates how to use the Rifidi Engine RMI API to create a
* virtual reader and add tags to it.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class RifidiClass {

/**
* The reader manager - the service that controls the virtual RFID readers
*/
private ReaderManager readerManager;

public RifidiClass() {
// tell the service registry to inject dependencies into this object
ServiceRegistry.getInstance().service(this);
}

private void startReader() {
try {

/** The IP address of the virtual reader */
String READER_IP = "127.0.0.1";
/** The port of the virtual reader */
int READER_PORT = 20000;
String READER_NAME = "alien_test";

// The GeneralReaderPropertyHolder is the object that defines a new
// virtual reader to create
GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
readerProperties
.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
readerProperties.setNumAntennas(2);
readerProperties.setReaderName(READER_NAME);
readerProperties.setProperty("inet_address", READER_IP + ":"
+ READER_PORT);
readerProperties.setProperty("heartbeat_address", READER_IP
+ ":54321");
readerProperties.setNumGPIs(4);
readerProperties.setNumGPOs(8);

// create the virtual reader on the remote engine
readerManager.createReader(readerProperties);

// turn the reader on so that you can connect to it from a client
// (e.g. telnet)
readerManager.start(READER_NAME);

// The TagCreationPattern is the object that defines how to create a
// batch of tags
TagCreationPattern tagPattern = new TagCreationPattern();
tagPattern.setNumberOfTags(5);
tagPattern.setTagGeneration(TagGen.GEN2);
tagPattern.setTagType(TagType.SGTIN96);

// uses the TagFactory to generate some new tags
ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);

// Set the Unique IDs for each of the tags. This is *not* the EPC.
// The UniqueID is the ID used internally to differentiate between
// tags.
long id = 1;
for (RifidiTag tag : tags) {
tag.setTagEntitiyID(id++);
}

// add the tags to the virtual reader
readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));

// sleep for 500 miliseconds
Thread.sleep(500);

/*
* The next bit of code is "client" code. It is equivalent to
* connecting to an alien reader over telnet and seding the 'get
* taglist' command. It is only shown here to demonstrate that the
* tags that reader has been turned on and tags were added
* successfully.
*/

// create a new socket connection to the reader
Socket connection = new Socket(READER_IP, READER_PORT);

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

// send username and password
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));

// send get taglist command
out.write("t\n");
out.flush();
String returnVal = readFromReader(in);

// print tag list coming back from reader
System.out.println(returnVal);
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* This method reads from the socket.
*
* @param inBuf
* @return The string that was read
* @throws IOException
*/
public 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();
}

/**
* This method is called by the service registry to inject the ReaderManager
*
* @param readerManager
*/
@Inject
public void setReaderManager(ReaderManager readerManager) {
this.readerManager = readerManager;
// start the program now that we know the readerManager has been
// injected.
startReader();
}

}
</pre>

=Edit the Activator=
The Activator is the class that the OSGi framework uses to start and stop the bundle that you wrote. The start() method is called when your bundle is activated, and the stop() method is called when the bundle is deactivated. For an introduction to OSGi see [http://www.javaworld.com/javaworld/jw-03-2008/jw-03-osgi1.html this article].

Although this is a bad idea for production code, for the sake of simplicity, the start() method in the activator for this project starts the hello world class. This is the activator for the bundle:

<pre>
package testproj;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import testproj.RifidiClass;

public class Activator implements BundleActivator {

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
t.start();
}

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
}

private class TestRunner implements Runnable{

@Override
public void run() {
RifidiClass rifidiClass = new RifidiClass();
rifidiClass.start();

}
}
}

</pre>

=Run the program=
To run this program from Eclipse, you need to create a new Run Configuration.
# Click Run->Run Configurations
# Double click on OSGi Framework on the tree on the left
# Select the required bundles. The 'bundles' list displays a list of the bundles that will be activated when you run the program. You only want the bundles selected that are required.
## Click 'Deselct All'
## Check the bundle that you just created.
## Select 'Add Required Bundles'
#Click 'Run'

You should see alot of output in the console, and at the bottom of the output, you should see the tags that you "client" got from the reader:
<pre>
Tag:304A 37DA 04A4 4927 D1C8 0775, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:3008 26FD CCAC 1E53 612D 56EB, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:302E 5243 7D73 9CEF 1E8A 08FA, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:307A 11F3 960A B58C 7454 B248, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:308C 5BD0 BA14 CB02 55D4 89D5, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
</pre>

Using the Engine API

2010-01-27T15:45:09Z

Kyle: /* Write the Hello World Application */

[[Category:developerDoc]][[Category:EmulatorDoc]]
This page describes how to create an instance of the Rifidi engine, create readers, and add and remove tags from that engine all programatically via RMI. It is a tutorial for creating a "hello world" Rifidi application just to show you how the engine works. In production code, however, you shouldn't run the program from the activator.
=Download the source code=
In order to use the Engine API, you will first need to download the core rifidi plugins from svn. See [[Rifidi:Source_Code|Running Rifidi from Source]] for instructions on how to do this
=Create a new OSGi bundle=
Because Rifidi is OSGi based, all code must be written inside an OSGi bundle. The thing you will need to create a new OSGi bundle for your code to run in. To do this, follow the same steps as in [[Create a new reader project]]. You do not need to add the project to svn.

For this example, you will want to declare dependencies on the following plugins:
* org.rifidi.emulator
* org.rifidi.dependencies
* org.rifidi.services.tags
* org.rifidi.emulator.reader.alien

=Create a program=
# Create a new package.
## Right click on the package found in the src directory.
## Select new package
## Give the package a name and select Finish
# Create a new class
## Right Click on the new package
## Select new class
## Give the class a name and click finish
=Write the Hello World Application=
<pre>package testproj;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.ArrayList;
import java.util.HashSet;

import org.rifidi.emulator.manager.ReaderManager;
import org.rifidi.emulator.reader.module.GeneralReaderPropertyHolder;
import org.rifidi.services.annotations.Inject;
import org.rifidi.services.registry.ServiceRegistry;
import org.rifidi.tags.enums.TagGen;
import org.rifidi.tags.factory.TagCreationPattern;
import org.rifidi.tags.factory.TagFactory;
import org.rifidi.tags.id.TagType;
import org.rifidi.tags.impl.RifidiTag;

/**
* This class demonstrates how to use the Rifidi Engine RMI API to create a
* virtual reader and add tags to it.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class RifidiClass {

/**
* The reader manager - the service that controls the virtual RFID readers
*/
private ReaderManager readerManager;

public RifidiClass() {
// tell the service registry to inject dependencies into this object
ServiceRegistry.getInstance().service(this);
}

private void startReader() {
try {

/** The IP address of the virtual reader */
String READER_IP = "127.0.0.1";
/** The port of the virtual reader */
int READER_PORT = 20000;
String READER_NAME = "alien_test";

// The GeneralReaderPropertyHolder is the object that defines a new
// virtual reader to create
GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
readerProperties
.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
readerProperties.setNumAntennas(2);
readerProperties.setReaderName(READER_NAME);
readerProperties.setProperty("inet_address", READER_IP + ":"
+ READER_PORT);
readerProperties.setProperty("heartbeat_address", READER_IP
+ ":54321");
readerProperties.setNumGPIs(4);
readerProperties.setNumGPOs(8);

// create the virtual reader on the remote engine
readerManager.createReader(readerProperties);

// turn the reader on so that you can connect to it from a client
// (e.g. telnet)
readerManager.start(READER_NAME);

// The TagCreationPattern is the object that defines how to create a
// batch of tags
TagCreationPattern tagPattern = new TagCreationPattern();
tagPattern.setNumberOfTags(5);
tagPattern.setTagGeneration(TagGen.GEN2);
tagPattern.setTagType(TagType.SGTIN96);

// uses the TagFactory to generate some new tags
ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);

// Set the Unique IDs for each of the tags. This is *not* the EPC.
// The UniqueID is the ID used internally to differentiate between
// tags.
long id = 1;
for (RifidiTag tag : tags) {
tag.setTagEntitiyID(id++);
}

// add the tags to the virtual reader
readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));

// sleep for 500 miliseconds
Thread.sleep(500);

/*
* The next bit of code is "client" code. It is equivalent to
* connecting to an alien reader over telnet and seding the 'get
* taglist' command. It is only shown here to demonstrate that the
* tags that reader has been turned on and tags were added
* successfully.
*/

// create a new socket connection to the reader
Socket connection = new Socket(READER_IP, READER_PORT);

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

// send username and password
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));

// send get taglist command
out.write("t\n");
out.flush();
String returnVal = readFromReader(in);

// print tag list coming back from reader
System.out.println(returnVal);
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* This method reads from the socket.
*
* @param inBuf
* @return The string that was read
* @throws IOException
*/
public 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();
}

/**
* This method is called by the service registry to inject the ReaderManager
*
* @param readerManager
*/
@Inject
public void setReaderManager(ReaderManager readerManager) {
this.readerManager = readerManager;
// start the program now that we know the readerManager has been
// injected.
startReader();
}

}
</pre>

=Edit the Activator=
The Activator is the class that the OSGi framework uses to start and stop the bundle that you wrote. The start() method is called when your bundle is activated, and the stop() method is called when the bundle is deactivated. For an introduction to OSGi see [http://www.javaworld.com/javaworld/jw-03-2008/jw-03-osgi1.html this article].

Although this is a bad idea for production code, for the sake of simplicity, the start() method in the activator for this project starts the hello world class. This is the activator for the bundle:

<pre>
package testproj;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import testproj.RifidiClass;

public class Activator implements BundleActivator {

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
t.start();
}

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
}

private class TestRunner implements Runnable{

@Override
public void run() {
RifidiClass rifidiClass = new RifidiClass();
rifidiClass.start();

}
}
}

</pre>

=Run the program=
To run this program from Eclipse, you need to create a new Run Configuration.
# Click Run->Run Configurations
# Double click on OSGi Framework on the tree on the left
# Select the required bundles. The 'bundles' list displays a list of the bundles that will be activated when you run the program. You only want the bundles selected that are required.
## Click 'Deselct All'
## Check the bundle that you just created.
## Select 'Add Required Bundles'
#Click 'Run'

You should see alot of output in the console, and at the bottom of the output, you should see the tags that you "client" got from the reader:
<pre>
Tag:304A 37DA 04A4 4927 D1C8 0775, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:3008 26FD CCAC 1E53 612D 56EB, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:302E 5243 7D73 9CEF 1E8A 08FA, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:307A 11F3 960A B58C 7454 B248, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:308C 5BD0 BA14 CB02 55D4 89D5, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
</pre>

Using the Engine API

2010-01-27T15:28:08Z

Kyle: /* Edit the Activator */

[[Category:developerDoc]][[Category:EmulatorDoc]]
This page describes how to create an instance of the Rifidi engine, create readers, and add and remove tags from that engine all programatically via RMI. It is a tutorial for creating a "hello world" Rifidi application just to show you how the engine works. In production code, however, you shouldn't run the program from the activator.
=Download the source code=
In order to use the Engine API, you will first need to download the core rifidi plugins from svn. See [[Rifidi:Source_Code|Running Rifidi from Source]] for instructions on how to do this
=Create a new OSGi bundle=
Because Rifidi is OSGi based, all code must be written inside an OSGi bundle. The thing you will need to create a new OSGi bundle for your code to run in. To do this, follow the same steps as in [[Create a new reader project]]. You do not need to add the project to svn.

For this example, you will want to declare dependencies on the following plugins:
* org.rifidi.emulator
* org.rifidi.dependencies
* org.rifidi.services.tags
* org.rifidi.emulator.reader.alien

=Create a program=
# Create a new package.
## Right click on the package found in the src directory.
## Select new package
## Give the package a name and select Finish
# Create a new class
## Right Click on the new package
## Select new class
## Give the class a name and click finish
=Write the Hello World Application=
<pre>
package testproj.program;

import gnu.cajo.utils.extra.TransparentItemProxy;

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

import org.rifidi.emulator.reader.module.GeneralReaderPropertyHolder;
import org.rifidi.emulator.rmi.server.ReaderModuleManagerInterface;
import org.rifidi.emulator.rmi.server.RifidiManager;
import org.rifidi.emulator.rmi.server.RifidiManagerInterface;
import org.rifidi.services.tags.enums.TagGen;
import org.rifidi.services.tags.factory.TagCreationPattern;
import org.rifidi.services.tags.factory.TagFactory;
import org.rifidi.services.tags.id.TagType;
import org.rifidi.services.tags.impl.RifidiTag;

/**
* This class demonstrates how to use the Rifidi Engine RMI API to create a
* virtual reader and add tags to it.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public class RifidiClass {

public void HelloWorld() {
try {

/**
* The IP address of the virtual reader
*/
String READER_IP = "127.0.0.1";

/**
* The port of the virtual reader
*/
int READER_PORT = 20000;

/**
* The IP of the RMI server
*/
String RMI_IP = "127.0.0.1";

/**
* The IP of the RMI port
*/
int RMI_PORT = 1198;

// Start up the RMI Server
RifidiManager.startManager(RMI_IP, RMI_PORT);

// Get the remote object that allows you to create and destroy
// virtual readers from the RMI registry
RifidiManagerInterface managerInterface = (RifidiManagerInterface) TransparentItemProxy
.getItem("//" + RMI_IP + ":" + RMI_PORT + "/"
+ RifidiManager.URL,
new Class[] { RifidiManagerInterface.class });

// The GeneralReaderPropertyHolder is the object that defines a new
// virtual reader to create
GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
readerProperties
.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
readerProperties.setNumAntennas(2);
readerProperties.setReaderName("alien_test");
readerProperties.setProperty("inet_address", READER_IP + ":"
+ READER_PORT);
readerProperties.setProperty("heartbeat_address", READER_IP
+ ":54321");
readerProperties.setNumGPIs(4);
readerProperties.setNumGPOs(8);

// create the virtual reader on the remote engine
managerInterface.createReader(readerProperties);

// get the remote object that allows you to control the virtual
// reader
ReaderModuleManagerInterface remoteVirtualReader = (ReaderModuleManagerInterface) TransparentItemProxy
.getItem("//" + RMI_IP + ":" + RMI_PORT + "/"
+ readerProperties.getReaderName(),
new Class[] { ReaderModuleManagerInterface.class });

// turn the reader on so that you can connect to it from a client
// (e.g. telnet)
remoteVirtualReader.turnReaderOn();

// The TagCreationPattern is the object that defines how to create a
// batch of tags
TagCreationPattern tagPattern = new TagCreationPattern();
tagPattern.setNumberOfTags(5);
tagPattern.setTagGeneration(TagGen.GEN2);
tagPattern.setTagType(TagType.SGTIN96);

// uses the TagFactory to generate some new tags
ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);

// Set the Unique IDs for each of the tags. This is *not* the EPC.
// The UniqueID is the ID used internally to differentiate between
// tags.
long id = 1;
for (RifidiTag tag : tags) {
tag.setTagEntitiyID(id++);
}

// add the tags to the virtual reader
remoteVirtualReader.addTags(0, tags);

// sleep for 500 miliseconds
Thread.sleep(500);

/*
* The next bit of code is "client" code. It is equivalent to
* connecting to an alien reader over telnet and seding the 'get
* taglist' command. It is only shown here to demonstrate that the
* tags that reader has been turned on and tags were added
* successfully.
*/

// create a new socket connection to the reader
Socket connection = new Socket(READER_IP, READER_PORT);

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

// send username and password
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));

// send get taglist command
out.write("t\n");
out.flush();
String returnVal = readFromReader(in);

// print tag list coming back from reader
System.out.println(returnVal);
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* This method reads from the socket.
*
* @param inBuf
* @return The string that was read
* @throws IOException
*/
public 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>

=Edit the Activator=
The Activator is the class that the OSGi framework uses to start and stop the bundle that you wrote. The start() method is called when your bundle is activated, and the stop() method is called when the bundle is deactivated. For an introduction to OSGi see [http://www.javaworld.com/javaworld/jw-03-2008/jw-03-osgi1.html this article].

Although this is a bad idea for production code, for the sake of simplicity, the start() method in the activator for this project starts the hello world class. This is the activator for the bundle:

<pre>
package testproj;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import testproj.RifidiClass;

public class Activator implements BundleActivator {

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
t.start();
}

/*
* (non-Javadoc)
* @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
}

private class TestRunner implements Runnable{

@Override
public void run() {
RifidiClass rifidiClass = new RifidiClass();
rifidiClass.start();

}
}
}

</pre>

=Run the program=
To run this program from Eclipse, you need to create a new Run Configuration.
# Click Run->Run Configurations
# Double click on OSGi Framework on the tree on the left
# Select the required bundles. The 'bundles' list displays a list of the bundles that will be activated when you run the program. You only want the bundles selected that are required.
## Click 'Deselct All'
## Check the bundle that you just created.
## Select 'Add Required Bundles'
#Click 'Run'

You should see alot of output in the console, and at the bottom of the output, you should see the tags that you "client" got from the reader:
<pre>
Tag:304A 37DA 04A4 4927 D1C8 0775, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:3008 26FD CCAC 1E53 612D 56EB, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:302E 5243 7D73 9CEF 1E8A 08FA, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:307A 11F3 960A B58C 7454 B248, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
Tag:308C 5BD0 BA14 CB02 55D4 89D5, Disc:2008/11/19 12:09:20, Last:2008/11/19 12:09:21, Count:1, Ant:0, Proto:2
</pre>

Database Tutorial Command Provider

2009-12-03T22:27:01Z

Kyle: /* Extra Credit */

In order to control the database application, you can use a CommandProvider, which is a class that plugs into the eclipse osgi console and allows you to provide custom commands.
=Implement the CommandProvider interface=
The org.eclipse.osgi.framework.console.CommandProvider interface allows you to write methods which are exposed as commands in the eclipse console. By convention, any methods that you want to expose should start with an underscore (i.e. '_'), should have a return type of Object and should take in a CommandInterpreter (which allows you to get input and write output to the eclipse console ).
<pre>
/**
* Start the application
*
* @param intp
* @return
*/
public Object _dbstart(CommandInterpreter intp) {
app.start();
return null;
}

/**
* Stop the application
*
* @param intp
* @return
*/
public Object _dbstop(CommandInterpreter intp) {
app.stop();
return null;
}
</pre>
==Dependency Injection==
Like the other objects we have create so far, we are going to use dependency injection to give the CommandProvider access to the DBApp object.
<pre>
/**
* Called by spring
*
* @param app
* the app to set
*/
public void setApp(DBApp app) {
this.app = app;
}

</pre>
=Extra Credit=
Here are some extra things that could be added to this class to extend functionality.
==A command that lists the last five tag reads==
Right now the console only allows you to start and stop the application. However, it could provide richer functionality. For example, suppose you wrote a method like this:
<pre>
public Object _lastFiveTagReads(CommandInterpreter intp)
</pre>
This method might print out the last five tag reads seen by the reader.
==Control the DBApp with RMI instead of the console==
The Eclipse Console is one way to control the DB Application, but it has its pitfalls. For example, if the edge server is started up as a background service, you won't have access to the console. In this case, you may want a more robust way to control the application. You could do this any number of ways, one of which would be to use RMI (Remote Method Invocation). This would allow clients in the network to issue commands to your application.

Database Tutorial Data Access Object

2009-12-03T22:20:42Z

Kyle: /* Properly closing the Database connection */

A Data Access Object is an object-oriented pattern that is often used in conjunction with databases to hide the details of interfacing with a database. In our case, it allows us to encapsulate all the work of talking with JDBC so that none of that logic is included in the DBApp class.
=The DAO interface=
The first step is to create an interface class that the DBApp can use to add new RFIDEvent objects to the database. For now, we will keep it very simple:
<pre>
/**
* This interface is implemented by Data Access Objects (DAO) that have the
* ability to write to our data source.
*
* @author Kyle Neumeier - kyle@pramari.com
*
*/
public interface RFID_DAO {

/***
* Write the supplied event to the data source
*
* @param event
*/
public void addRow(RFIDEvent event);

}
</pre>
=The DAO Implementation=
The next step is to create an object that implements the <tt>RFID_DAO</tt> interface and can use JDBC to write to a database.
==Define the table and column names==
To make sure that we use the same table and column names throughout the application, let's define some static final members:
<pre>
/** The name of the table to write to */
private static final String TABLE = "rfidevents";
/** The name of the ID column in the table */
private static final String COL_ID = "id";
/** The name of the reader column in the table */
private static final String COL_READER = "reader";
/** The name of the antenna column in the table */
private static final String COL_ANT = "antenna";
/** The name of the time column in the table */
private static final String COL_TIME = "time";
</pre>
==Dependency Injection==
Like the DBApp class, the DAO should have its dependencies injected by spring. In this case, we only have one dependency:
;SimpleDriverDataSource
:This object contains the information about how to connect to a database: the JDBC driver to use, the URL of the database, and the username and pass.
<pre>
/**
* Method called by spring to inject the datasource. This method also opens
* up the connection to the datasource.
*
* @param ds
*/
public void setDataSource(SimpleDriverDataSource ds) {
this.ds = ds;
template = new SimpleJdbcTemplate(ds);

// first thing to do is to drop the table if it exists already.
try {
template.update("drop table " + TABLE, new Object[] {});
logger.debug("RFIDEVENTS table dropped");
} catch (DataAccessException dae) {
}

// next create the table
template.update("create table " + TABLE + "(" + COL_ID
+ " VARCHAR(24), " + COL_READER + " VARCHAR(50)," + COL_ANT
+ " INTEGER, " + COL_TIME + " TIMESTAMP)", new Object[] {});
logger.debug("New RFIDEVENTS table created");
insertRFIDEvent = new SimpleJdbcInsert(ds).withTableName(TABLE);
}
</pre>
This setter method is a bit more complicated than the one in the DBApp class. Whenever spring hands the DAO a new datasource, it needs to do some setup.
First, it needs to create the <tt>SimpleJdbsTemplate</tt> which is a helper class provided by spring that simplifies JDBC database access. Next it attempts to drop the table if it has already been created. Then it tries to create the table. There are definitely more sophisticated ways to ensure that a table exists and that there are no rows in it, but this is simple enough. Finally, the setter method creates another spring helper object called SimpleJdbcInsert which (as the name implies) simplifies the process of writing a new row in the database.
==Add Rows==
The last piece of functionality that the DAO needs is to implement the addRow method from its interface.
<pre>
/*
* (non-Javadoc)
*
* @see
* org.rifidi.edge.app.db.dao.RFIDDAO#addRow(org.rifidi.edge.app.db.domain
* .RFIDEvent)
*/
@Override
public void addRow(RFIDEvent event) {
Map<String, Object> parameters = new HashMap<String, Object>();
parameters.put(COL_ID, event.getId());
parameters.put(COL_READER, event.getReader());
parameters.put(COL_ANT, event.getAntenna());
parameters.put(COL_TIME, new Timestamp(event.getTimestamp()));
insertRFIDEvent.execute(parameters);

}
</pre>
This method is self-evident. Whenever it is called with an RFID event object, it creates a map containing the information to be inserted and the columns to insert that data into. Then it inserts a new row into the database.
=Extra Credit=
Here are a few ideas for extra functionality that might be useful for this DAO to have
==Query the database==
This particular application only writes some basic information to the DB. One thing that you could do with the SimpleJdbcTemplate is to query the database. For example, you could write a method in the interface:
<pre>
List<RFIDEvent> queryByReader(String readerID);
</pre>
This method would allow an object that has access to the DAO (for example, the DBApp) to get a list of tags that has been seen by a certain reader.

==Properly closing the Database connection==
This DAO does not properly shut down the JDBC connection. You could possibly add a method called <tt>close()</tt> to the DAO interface and then let the DBApp object call this method when its stop method is called.