Using the Engine API - Revision history

Matt: Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

2010-11-26T19:43:10Z

Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

Amesycyxa at 23:14, 23 November 2010

2010-11-23T23:14:47Z

Kyle: /* Run the program */

2010-01-27T15:52:41Z

‎Run the program

Kyle: /* Edit the Activator */

2010-01-27T15:46:33Z

‎Edit the Activator

Kyle: /* Create a new OSGi bundle */

2010-01-27T15:46:00Z

‎Create a new OSGi bundle

Kyle: /* Write the Hello World Application */

2010-01-27T15:45:09Z

‎Write the Hello World Application

Kyle: /* Edit the Activator */

2010-01-27T15:28:08Z

‎Edit the Activator

Kyle: /* Create a new plugin */

2008-11-21T15:22:49Z

‎Create a new plugin

Kyle at 17:54, 19 November 2008

2008-11-19T17:54:55Z

Kyle: /* Run the program */

2008-11-19T17:49:45Z

‎Run the program

@@ Line 1: / Line 1: @@
 [[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 &quot;hello world&quot; Rifidi application just to show you how the engine works.  In production code, however, you shouldn't run the program from the activator.
+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
@@ Line 30: / Line 22: @@
 ## Give the class a name and click finish
 =Write the Hello World Application=
-&lt;pre&gt;package testproj;
+<pre>package testproj;
 import java.io.BufferedReader;
@@ Line 73: / Line 65: @@
 			/** The IP address of the virtual reader */
-			String READER_IP = &quot;127.0.0.1&quot;;
+			String READER_IP = "127.0.0.1";
 			/** The port of the virtual reader */
 			int READER_PORT = 20000;
-			String READER_NAME = &quot;alien_test&quot;;
+			String READER_NAME = "alien_test";
 			// The GeneralReaderPropertyHolder is the object that defines a new
@@ Line 82: / Line 74: @@
 			GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
 			readerProperties
-					.setReaderClassName(&quot;org.rifidi.emulator.reader.alien.module.AlienReaderModule&quot;);
+					.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
 			readerProperties.setNumAntennas(2);
 			readerProperties.setReaderName(READER_NAME);
-			readerProperties.setProperty(&quot;inet_address&quot;, READER_IP + &quot;:&quot;
+			readerProperties.setProperty("inet_address", READER_IP + ":"
 					+ READER_PORT);
-			readerProperties.setProperty(&quot;heartbeat_address&quot;, READER_IP
+			readerProperties.setProperty("heartbeat_address", READER_IP
-					+ &quot;:54321&quot;);
+					+ ":54321");
 			readerProperties.setNumGPIs(4);
 			readerProperties.setNumGPOs(8);
@@ Line 107: / Line 99: @@
 			// uses the TagFactory to generate some new tags
-			ArrayList&lt;RifidiTag&gt; tags = TagFactory.generateTags(tagPattern);
+			ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);
 			// Set the Unique IDs for each of the tags. This is *not* the EPC.
@@ Line 118: / Line 110: @@
 			// add the tags to the virtual reader
-			readerManager.addTags(READER_NAME, 0, new HashSet&lt;RifidiTag&gt;(tags));
+			readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));
 			// sleep for 500 miliseconds
@@ Line 124: / Line 116: @@
 			/*
-			 * The next bit of code is &quot;client&quot; code. It is equivalent to
+			 * 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
@@ Line 140: / Line 132: @@
 			// send username and password
 			System.out.println(readFromReader(in));
-			out.write(&quot;alien\n&quot;);
+			out.write("alien\n");
 			out.flush();
 			System.out.println(readFromReader(in));
 			Thread.sleep(500);
-			out.write(&quot;password\n&quot;);
+			out.write("password\n");
 			out.flush();
 			System.out.println(readFromReader(in));
 			// send get taglist command
-			out.write(&quot;t\n&quot;);
+			out.write("t\n");
 			out.flush();
 			String returnVal = readFromReader(in);
@@ Line 191: / Line 183: @@
+}
-&lt;/pre&gt;
+</pre>
 =Edit the Activator=
@@ Line 198: / Line 190: @@
 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:
-&lt;pre&gt;package testproj;
+<pre>package testproj;
 import org.osgi.framework.BundleActivator;
@@ Line 215: / Line 207: @@
 	 */
 	public void start(BundleContext context) throws Exception {
-		Thread t = new Thread(new TestRunner(), &quot;Rifidi Hello World Thread&quot;);
+		Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
 		t.start();
+	}
@@ Line 245: / Line 237: @@
-&lt;/pre&gt;
+</pre>
 =Run the program=
 To run this program from Eclipse, you need to create a new Run Configuration.
-# Click Run-&gt;Run Configurations
+# 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.
@@ Line 258: / Line 250: @@
 #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 &quot;client&quot; got from the reader:
+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:
-&lt;pre&gt;
+<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
@@ Line 265: / Line 257: @@
 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
-&lt;/pre&gt;
+</pre>

@@ Line 1: / Line 1: @@
 [[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.
+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 &quot;hello world&quot; 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
@@ Line 22: / Line 30: @@
 ## Give the class a name and click finish
 =Write the Hello World Application=
-<pre>package testproj;
+&lt;pre&gt;package testproj;
 import java.io.BufferedReader;
@@ Line 65: / Line 73: @@
 			/** The IP address of the virtual reader */
-			String READER_IP = "127.0.0.1";
+			String READER_IP = &quot;127.0.0.1&quot;;
 			/** The port of the virtual reader */
 			int READER_PORT = 20000;
-			String READER_NAME = "alien_test";
+			String READER_NAME = &quot;alien_test&quot;;
 			// The GeneralReaderPropertyHolder is the object that defines a new
@@ Line 74: / Line 82: @@
 			GeneralReaderPropertyHolder readerProperties = new GeneralReaderPropertyHolder();
 			readerProperties
-					.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
+					.setReaderClassName(&quot;org.rifidi.emulator.reader.alien.module.AlienReaderModule&quot;);
 			readerProperties.setNumAntennas(2);
 			readerProperties.setReaderName(READER_NAME);
-			readerProperties.setProperty("inet_address", READER_IP + ":"
+			readerProperties.setProperty(&quot;inet_address&quot;, READER_IP + &quot;:&quot;
 					+ READER_PORT);
-			readerProperties.setProperty("heartbeat_address", READER_IP
+			readerProperties.setProperty(&quot;heartbeat_address&quot;, READER_IP
-					+ ":54321");
+					+ &quot;:54321&quot;);
 			readerProperties.setNumGPIs(4);
 			readerProperties.setNumGPOs(8);
@@ Line 99: / Line 107: @@
 			// uses the TagFactory to generate some new tags
-			ArrayList<RifidiTag> tags = TagFactory.generateTags(tagPattern);
+			ArrayList&lt;RifidiTag&gt; tags = TagFactory.generateTags(tagPattern);
 			// Set the Unique IDs for each of the tags. This is *not* the EPC.
@@ Line 110: / Line 118: @@
 			// add the tags to the virtual reader
-			readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));
+			readerManager.addTags(READER_NAME, 0, new HashSet&lt;RifidiTag&gt;(tags));
 			// sleep for 500 miliseconds
@@ Line 116: / Line 124: @@
 			/*
-			 * The next bit of code is "client" code. It is equivalent to
+			 * The next bit of code is &quot;client&quot; 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
@@ Line 132: / Line 140: @@
 			// send username and password
 			System.out.println(readFromReader(in));
-			out.write("alien\n");
+			out.write(&quot;alien\n&quot;);
 			out.flush();
 			System.out.println(readFromReader(in));
 			Thread.sleep(500);
-			out.write("password\n");
+			out.write(&quot;password\n&quot;);
 			out.flush();
 			System.out.println(readFromReader(in));
 			// send get taglist command
-			out.write("t\n");
+			out.write(&quot;t\n&quot;);
 			out.flush();
 			String returnVal = readFromReader(in);
@@ Line 183: / Line 191: @@
+}
-</pre>
+&lt;/pre&gt;
 =Edit the Activator=
@@ Line 190: / Line 198: @@
 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;
+&lt;pre&gt;package testproj;
 import org.osgi.framework.BundleActivator;
@@ Line 207: / Line 215: @@
 	 */
 	public void start(BundleContext context) throws Exception {
-		Thread t = new Thread(new TestRunner(), "Rifidi Hello World Thread");
+		Thread t = new Thread(new TestRunner(), &quot;Rifidi Hello World Thread&quot;);
 		t.start();
+	}
@@ Line 237: / Line 245: @@
-</pre>
+&lt;/pre&gt;
 =Run the program=
 To run this program from Eclipse, you need to create a new Run Configuration.
-# Click Run->Run Configurations
+# Click Run-&gt;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.
@@ Line 250: / Line 258: @@
 #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:
+You should see alot of output in the console, and at the bottom of the output, you should see the tags that you &quot;client&quot; got from the reader:
-<pre>
+&lt;pre&gt;
 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
@@ Line 257: / Line 265: @@
 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>
+&lt;/pre&gt;

@@ Line 246: / Line 246: @@
 ## Click 'Deselct All'
 ## Check the bundle that you just created.
 ## Select 'Add Required Bundles'
 #Click 'Run'

@@ Line 190: / Line 190: @@
 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>
+<pre>package testproj;
 package testproj;
 import org.osgi.framework.BundleActivator;
@@ Line 202: / Line 201: @@
 	/*
 	 * (non-Javadoc)
 	 * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
 	 */
 	public void start(BundleContext context) throws Exception {
@@ Line 211: / Line 213: @@
 	/*
 	 * (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();
+			new RifidiClass();
-			rifidiClass.start();
-−
+		}
+	}
+}
 </pre>

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

@@ Line 22: / Line 22: @@
 ## Give the class a name and click finish
 =Write the Hello World Application=
-<pre>
+<pre>package testproj;
-package testproj.program;
-−
-import gnu.cajo.utils.extra.TransparentItemProxy;
 import java.io.BufferedReader;
@@ Line 33: / Line 30: @@
 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.services.annotations.Inject;
-import org.rifidi.emulator.rmi.server.RifidiManager;
+import org.rifidi.services.registry.ServiceRegistry;
-import org.rifidi.emulator.rmi.server.RifidiManagerInterface;
+import org.rifidi.tags.enums.TagGen;
-import org.rifidi.services.tags.enums.TagGen;
+import org.rifidi.tags.factory.TagCreationPattern;
-import org.rifidi.services.tags.factory.TagCreationPattern;
+import org.rifidi.tags.factory.TagFactory;
-import org.rifidi.services.tags.factory.TagFactory;
+import org.rifidi.tags.id.TagType;
-import org.rifidi.services.tags.id.TagType;
+import org.rifidi.tags.impl.RifidiTag;
-import org.rifidi.services.tags.impl.RifidiTag;
 /**
@@ Line 53: / Line 51: @@
 public class RifidiClass {
-	public void HelloWorld() {
+	/**
 		try {
-			/**
+			/** The IP address of the virtual reader */
-			 * The IP address of the virtual reader
-			 */
 			String READER_IP = "127.0.0.1";
 			/** The port of the virtual reader */
-			/**
-			 * The port of the virtual reader
-			 */
 			int READER_PORT = 20000;
+			String READER_NAME = "alien_test";
-			/**
-			 * 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
@@ Line 92: / Line 76: @@
 					.setReaderClassName("org.rifidi.emulator.reader.alien.module.AlienReaderModule");
 			readerProperties.setNumAntennas(2);
-			readerProperties.setReaderName("alien_test");
+			readerProperties.setReaderName(READER_NAME);
 			readerProperties.setProperty("inet_address", READER_IP + ":"
 					+ READER_PORT);
@@ Line 101: / Line 85: @@
 			// create the virtual reader on the remote engine
-			managerInterface.createReader(readerProperties);
+			readerManager.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();
+			readerManager.start(READER_NAME);
 			// The TagCreationPattern is the object that defines how to create a
@@ Line 133: / Line 110: @@
 			// add the tags to the virtual reader
-			remoteVirtualReader.addTags(0, tags);
+			readerManager.addTags(READER_NAME, 0, new HashSet<RifidiTag>(tags));
 			// sleep for 500 miliseconds
@@ Line 190: / Line 167: @@
+		}
 		return buf.toString();
+	}

@@ Line 206: / Line 206: @@
 import org.osgi.framework.BundleContext;
-import testproj.program.RifidiClass;
+import testproj.RifidiClass;
 public class Activator implements BundleActivator {
@@ Line 230: / Line 230: @@
 		@Override
 		public void run() {
-			new RifidiClass().HelloWorld();
+			RifidiClass rifidiClass = new RifidiClass();
+		}

@@ Line 3: / Line 3: @@
 =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 plugin=
+=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.

← Older revision		Revision as of 17:54, 19 November 2008
Line 1:		Line 1:
		+	[[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.		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=		=Download the source code=

← Older revision		Revision as of 17:49, 19 November 2008
Line 246:		Line 246:
	## Select 'Add Required Bundles'		## Select 'Add Required Bundles'
	#Click 'Run'		#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>