=Dashboard Vision/Roadmap=

The key components of the enterprise-wide dashboard we added with this release – and how they improve ease of use – are summarized below.
#Edge Server Node Management – Let’s you monitor multiple Rifidi Edge server nodes across the enterprise to see connection states, properties, sensors and applications.
#Sensor Management – Provides an interface to monitor sensors’ state, manage sensors’ properties and dynamically update sensors’ execution.
#Rifidi Application Management – Allows you to monitor application states, manage sensor/reader read zones, and update both out-of-the-box business solutions and custom (via SDK) Rifidi sensor/IoT device properties, providing the foundation for a Rifidi Application marketplace.
=Introduction=
The Web Administration Dashboard enables users to manage, monitor and configure Rifidi Servers, Sensors/Readers and Applications.

Go to http://localhost:8111/dashboard

[[File:dashboard_sections.png]]
 
[[File:dashboard_wizard_section.png]]

==Menu section==
The menu is a hierarchical tree component, where all the configured servers are listed, and under each server there are three fixed sections: 
#Sensor Management: Allows call operations related to sensors, such as listing sensors, create a new sensor connection, modify sensor properties, associate sessions to sensors, submit a command on a session
#Command Management: Allows create and delete command instances.
#App Management: Allows list the applications, start and stop them, modify application properties, group properties. It allows manage readzones, create, modify properties and delete.

==Facility floor plan section==
It will be available in a future release

==Wizard section==
When there is the need to create a component by using a wizard, it is displayed in wizard section.

==Properties editor section==
When a tree element is selected then its properties are displayed in this section, offering the possibility to read or modify them

=Server Management=

==General Information==
Due to browser security enhancements in order to use dashboard to manage remote Rifidi servers please follow these steps
# Update the following JVM argument in the Rifidi Sever startup script to use the external ip address in place of localhost/127.0.0.1 -

-Djava.rmi.server.hostname=192.168.86.58

# Configure Rifidi servers to run via https/ssl with a trusted signed cert from a CA

Steps for this can be found here

==Add Server==
Add a new server connection to rest services
# Right click on 'Servers' node and then choose 'Add server' [[File:add_server_link.png]]
# Provide the values for attributes: Display name, IP address, protocol and port where rest services are deployed on that server. [[File:add_server.png]]
# Click on 'Create' button and confirm [[File:add_server_confirm2.png]]

==Delete Server==
Delete a server connection
# Right click on server node to delete and then choose 'Delete server' [[File:delete_server_link.png]]
# Confirm delete operation [[File:delete_server_confirm2.png]]

==Update Server Connection Properties==
Update connection properties for server
# Click on server node to modify and then go to properties editor area [[File:edit_server_link.png]]
# Provide the values for attributes: Display name, IP address, protocol and port where rest services are deployed on that server. [[File:modify_server.png]]
# Click on 'Save' button and confirm [[File:modify_server_confirm.png]]

==Update Server Auto Refresh settings==
Enables or disables the menu auto refresh feature, so web app periodically synchronizes with server to reflect actual state of elements
# Click on servers node and then go to properties editor area [[File:edit_servers_link.png]]
# Provide the values for attributes: Enable auto refresh and auto refresh delay. [[File:modify_servers.png]]
# Click on 'Save' button and confirm [[File:modify_servers_confirm.png]]

==Save Server Configuration==
Save config changes made on this server
# Right click on server node and then choose 'Save server config' [[File:save_server_link.png]]
# Confirm the save operation [[File:save_server_confirm.png]]

==Save all servers Configuration==
Save config changes made on all connected servers
# Right click on "Servers" node and then choose 'Save all servers config' [[File:save_all_servers_link.png]]
# Confirm the save operation [[File:save_all_servers_confirm.png]]



=Sensor Management=

===Add Sensor Wizard===

Steps user through creating sensor, session and command (where applicable).

# Right click on 'Sensor Management' node and then choose 'Add Sensor' [[File:add_sensor_link.png]]
# Choose the sensor type and optionally provide the reader id and click Next [[File:add_sensor_readertype_selection.png]]
# Set the connection properties for sensor and optionally check if automatically start session, and click Next [[File:add_sensor_set_sensor_properties.png]]
# Create the command for sensor, choose the command type and choose to create a new command instance or select an existing one, set the properties for command instance and set the scheduling options for executing command, and click Next [[File:add_sensor_create_command.png]]
# Review steps summary and confirm [[File:add_sensor_summary.png]]

===Update Sensor Properties===
Option to modify sensor properties
# Click on sensor node to modify and then go to properties editor area [[File:edit_sensor_link.png]]
# Provide the values for sensor attributes [[File:edit_sensor.png]]
# Click on 'Save sensor properties' button and confirm [[File:edit_sensor_confirm.png]]

===Delete Sensor===
Option to delete a sensor connection
# Right click on sensor node to delete and then choose 'Delete Sensor' [[File:delete_sensor_link.png]]
# Confirm delete operation [[File:delete_sensor_confirm.png]]

==Session==
===Start Session===
To start a session on sensor
# Click on session node to start and then click on 'Start Session' [[File:start_session_link.png]]

===Stop Session===
To stop a session on sensor
# Click on session node to stop and then click on 'Stop Session' [[File:stop_session_link.png]]

==Commands==
===Update Command properties===
Allows the updating of properties for a command
# Click on command instance node to modify and then go to properties editor area [[File:edit_command_link.png]]
# Provide the values for command attributes [[File:edit_command.png]]
# Click on 'Save' button and confirm [[File:edit_command_confirm.png]]

===Deleted Command===
Deletes a command template
# Right click on command node to delete and then choose 'Delete Command Template' [[File:delete_command_link.png]]
# Confirm delete operation [[File:delete_command_confirm.png]]

===Create Command===
Creates a command template
# Right click on command type node, select 'Create Command Template' and then go to properties editor area [[File:create_command_link.png]]
# Provide the values for command attributes [[File:create_command.png]]
# Click on 'Create' button and confirm [[File:create_command_confirm.png]]

===Execute Command===
Executes a command on a session
# Right click on session element where you want to submit the job and then choose 'Submit Job' [[File:execute_command_link.png]]
# Choose the command type and choose to create a new command instance or select an existing one, set the properties for command instance and set the scheduling options for executing command, and click Submit [[File:execute_command.png]]
# Confirm the operation clicking on 'Submit Job' buton [[File:execute_command_confirm.png]]







=Application Management=



==Readzones==
===Get Readzones===
Option to list the readzones associated with an application group
# Click on 'ReadZones' menu element and it will display the readzones belonging to parent application group [[File:readzones_link.png]]

===Add Readzone===
To add a readzone definition associated with an application group
# Right click on 'ReadZones' node and then choose 'Add Read Zone' [[File:add_readzone_link.png]]
# Set the readzone name and readerID, and optionally provide the antennas, matchPattern and tagPattern, and click on 'Create' button [[File:add_readzone.png]]
# Confirm the readzone creation operation [[File:add_readzone_confirm.png]]

===Delete Readzone===
Deletes a readzone definition
# Right click on readzone node to delete and then choose 'Delete Command Template' [[File:delete_readzone_link.png]]
# Confirm delete operation [[File:delete_readzone_confirm.png]]

===Update Readzone properties===
Updates the properties for a readzone
# Click on readzone node to modify and then go to properties editor area [[File:update_readzone_link.png]]
# Provide the values for readerID, and optionally provide the antennas, matchPattern and tagPattern attributes [[File:update_readzone.png]]
# Click on 'Save' button and confirm [[File:update_readzone_confirm.png]]

==Application Properties==
===Get / Update Group Properties===
List and modify the application group properties
# Click on application group node to get / update and then go to properties editor area [[File:update_groupproperties_link.png]]
# Provide the values for application group properties and click on 'Save' [[File:update_groupproperties.png]]
# Click on 'Save app group properties' button and confirm [[File:update_groupproperties_confirm.png]]



===Get / Update Application Properties===
List and modify the application properties
# Click on application node to get / update and then go to properties editor area [[File:update_appproperties_link.png]]
# Provide the values for application properties and click on 'Save' [[File:update_appproperties.png]]
# Click on 'Save app properties' button and confirm [[File:update_appproperties_confirm.png]]


=Diagnostic=
==Current Tags View==
# Right click on reader/sensor name [[File:Currenttagsmenu.png]]
# Click on Current tags to view tags on reader [[File:Currenttagsview.png]]

Edge Management

2020-12-24T13:25:30Z

Bppause: /* REST HTTP over SSL Example Application */

Edge Management

2020-12-24T12:31:47Z

Bppause: /* REST HTTP over SSL Example Application */

=Introduction=
Starting in 3.1 Edge Management is now accessible though Restful Services (leveraging [http://restlet.com/ Restlet plugin]. Restlet allows all Rifidi Edge Management operations available through workbench to be accessible via Restful Services.Prior to Rifidi 3.1 Edge Management is available through RMI (currently used by Rifidi Workbench if looking for code examples).

The types of operations available through Restful Services include:
*All "session" commands (for stopping and starting reader/sensor sessions)
*ExecuteCommand and deleteCommand (for commands supported by a sensor such as a tag read)
*Readers (for getting a list of readers/sensors available on Edge Server instance)
*Commands (for issuing command line operations such as saving the Edge Server Configuration currently in memory)
*Get and Set Properties (for setting and getting sensor properties such as Setting the LLRP Reader Configuration dynamically)
*Create Reader (for creating a new reader connection)
*Managing Rifidi Applications (for stopping/starting, listing and deploying Rifidi Apps)

Additional features can be found on [http://restlet.com/ Restlet User Guide ]

=Configuration=

In rifidiserver.ini - A full list of Rifidi Edge configuration parameters can be found [[Edge_Server_Configuration]]
<pre>
#Port can be set
-Dorg.rifidi.restlet.port=8111
#Restlet starts by default this can be changed
-Dorg.rifidi.restlet.enabled=true

</pre>
Source for Restful Rifidi Management Commands - https://transcends.svn.cloudforge.com/rifidi/rifidi/trunk/org.rifidi.edge/src/org/rifidi/edge/rest/

=Configuration (HTTP over SSL) - Available as of version 3.1.1=

A full list of Rifidi Edge configuration parameters can be found [[Edge_Server_Configuration]]
<pre>
#SSL Port can be set
-Dorg.rifidi.restlet.ssl.port=8183
#Restlet starts by default this can be changed
-Dorg.rifidi.restlet.ssl.enabled=true
#Keystore Path
-Dorg.rifidi.restlet.ssl.keystorepath=\config\serverX.jks
#Key store password
-Dorg.rifidi.restlet.ssl.keystorepassword=password
#Key Password
-Dorg.rifidi.restlet.ssl.keypassword=password
#Key store Type
-Dorg.rifidi.restlet.ssl.keystoretype=JKS

</pre>

*Note: Link to how to configure/setup certificates with REST - http://restlet.com/learn/guide/2.3/core/security/https
==REST HTTP over SSL Example Application==
link to https java client example - https://transcends.svn.cloudforge.com/rifidi/rifidi/trunk/org.rifidi.edge.rest/src/org/rifidi/edge/rest/test/HttpsTestClient.java

<pre>
user can add this jvm parameter to see detailed messages if getting any
trouble when running this example:
-Djavax.net.debug=all

In order to successful get the https response from stand alone java
example, user must import the certificate into JVM:

open command windows as administrator and execute keytool -import, like:

keytool -import -alias localhost -keystore "C:\Program Files
(x86)\Java\jdk1.6.0_45\jre\lib\security\cacerts" -file
"D:\tmp\cert\localhost.cer"

if requested, default password is: changeit
</pre>

=Restlet Logging=

*1. Add an entry to the rifidiserver.ini (if using windows; when using linux you add this JVM argument in the rifidi-server executable):
-Djava.util.logging.config.file=d:/myLogging.properties

*2. Create logging properties file, for example like the below myLogging.properties
The entry in that file that determines where the log file will show up is the following: java.util.logging.FileHandler.pattern=d:/restlet.log

<pre>
myLogging.properties
# ================================
# == ==
# == Web Logging Properties ==
# == ==
# ================================

# ------------------
# General properties
# ------------------

# This defines a whitespace separated list of class names for handler classes to load and register as handlers on
# the root Logger (the Logger named ""). Each class name must be for a Handler class which has a default constructor.
# Note that these Handlers may be created lazily, when they are first used.
handlers=java.util.logging.FileHandler
# ------------------
# Loggers properties
# ------------------

.level=WARNING
org.mortbay.level=WARNING
org.restlet.level=INFO
com.noelios.level=WARNING

com.noelios.web.WebComponent.www.level=INFO
com.noelios.web.WebComponent.www.handlers=com.noelios.restlet.util.AccessLogFileHandler
com.noelios.web.WebComponent.www.useParentHandlers=false
# -------------------------
# ConsoleHandler properties
# -------------------------

# Specifies the default level for the Handler (defaults to Level.INFO).
# java.util.logging.ConsoleHandler.level=WARNING

# Specifies the name of a Filter class to use (defaults to no Filter).
# java.util.logging.ConsoleHandler.filter=

# Specifies the name of a Formatter class to use (defaults to java.util.logging.SimpleFormatter).
# java.util.logging.ConsoleHandler.formatter=

# The name of the character set encoding to use (defaults to the default platform encoding).
# java.util.logging.ConsoleHandler.encoding=

# ------------------------------
# General FileHandler properties
# ------------------------------

# Specifies the default level for the Handler (defaults to Level.ALL).
# java.util.logging.FileHandler.level=ALL

# Specifies the name of a Filter class to use (defaults to no Filter).
# java.util.logging.FileHandler.filter=

# Specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter)
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

# The name of the character set encoding to use (defaults to the default platform encoding).
# java.util.logging.FileHandler.encoding=

# Specifies an approximate maximum amount to write (in bytes) to any one file.
# If this is zero, then there is no limit. (Defaults to no limit).
java.util.logging.FileHandler.limit=10000000

# Specifies how many output files to cycle through (defaults to 1).
java.util.logging.FileHandler.count=100

# Specifies a pattern for generating the output file name. (Defaults to "%h/java%u.log").
# A pattern consists of a string that includes the following special components that will be replaced at runtime:
# "/" the local pathname separator
# "%t" the system temporary directory
# "%h" the value of the "user.home" system property
# "%g" the generation number to distinguish rotated logs
# "%u" a unique number to resolve conflicts
# "%%" translates to a single percent sign "%"
java.util.logging.FileHandler.pattern=d:/restlet.log

# Specifies whether the FileHandler should append onto any existing files (defaults to false).
# java.util.logging.FileHandler.append=
# -------------------------
# LogFileHandler properties
# -------------------------

# Specifies the default level for the Handler (defaults to Level.ALL).
# org.restlet.engine.log.AccessLogFileHandler.level=ALL

# Specifies the name of a Filter class to use (defaults to no Filter).
# org.restlet.engine.log.AccessLogFileHandler.filter=

# Specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter)
org.restlet.engine.log.AccessLogFileHandler.formatter=com.noelios.restlet.util.AccessLogFormatter

# The name of the character set encoding to use (defaults to the default platform encoding).
# org.restlet.engine.log.AccessLogFileHandler.encoding=

# Specifies an approximate maximum amount to write (in bytes) to any one file.
# If this is zero, then there is no limit. (Defaults to no limit).
org.restlet.engine.log.AccessLogFileHandler.limit=10000000

# Specifies how many output files to cycle through (defaults to 1).
org.restlet.engine.log.AccessLogFileHandler.count=100

# Specifies a pattern for generating the output file name. (Defaults to "%h/java%u.log").
# A pattern consists of a string that includes the following special components that will be replaced at runtime:
# "/" the local pathname separator
# "%t" the system temporary directory
# "%h" the value of the "user.home" system property
# "%g" the generation number to distinguish rotated logs
# "%u" a unique number to resolve conflicts
# "%%" translates to a single percent sign "%" .pattern=/home/prod/data/log/WebComponent-www-%u-%g.log

# Specifies whether the FileHandler should append onto any existing files (defaults to false).
# org.restlet.util.AccessLogFileHandler.append=
</pre>

=Restlet Tuning/Confguration (Jetty) as of Rifidi 3.4=

As of Rifidi 3.4 Jetty was made the default HTTP container for Restlet to allow for extended performance and configuration of the REST interface.

The parameters can for configured in the Rifidi Server (ini) configuration

Examples:

*-Dorg.rifidi.restlet.threadPool.minThreads=8 Thread pool minimum threads
*-Dorg.rifidi.restlet.threadPool.maxThreads=200 Thread pool max threads

Full list of Jetty parameters using the same naming convention can be found here - http://restlet.com/technical-resources/restlet-framework/javadocs/snapshot/jse/ext/org/restlet/ext/jetty/JettyServerHelper.html

=Commands=

==Command Code Snippet - start session - example how to use Rifidi API in a Java App==
All Rifidi Management API Command Logic here - https://transcends.svn.cloudforge.com/rifidi/rifidi/trunk/org.rifidi.edge/src/org/rifidi/edge/rest/SensorManagerServiceRestletImpl.java
<pre>
try {
sensorManagerService.startSession((String) request
.getAttributes().get("readerID"), (String) request
.getAttributes().get("sessionID"));
response.setEntity(self.generateReturnString(self
.generateSuccessMessage()), MediaType.TEXT_XML);
} catch (Exception e) {
response.setEntity(e.getMessage(), MediaType.TEXT_PLAIN);
}
</pre>
==Command Basic Flow Example==
#Create a Reader - http://localhost:8111/createreader/LLRP/IpAddress=127.0.0.1;Port=5084
#Create a Session (on a reader/sensor) - http://localhost:8111/createsession/LLRP_1
#Create a Command (on a reader/sensor)) -/createcommand/{commandType}/{properties}
*Note: some readers do not require create/executing a command as there is only one command hence for convenience is part of the create session/start session (Thinkify, CSL and Generic adapter (for handhelds/async push calls) are some examples of this)
#Set Command Properties - http://localhost:8111/setproperties/LLRP_Configure_1/Duration=2130
#Execute Command (on a given reader/sensor and session) - http://localhost:8111/executecommand/LLRP_1/1/LLRP_Configure_1/-1
#Start Session (to begin processing reads using associate command/reader/sensor configuration) - http://localhost:8111/startsession/LLRP_1/1
#Save Configuartion (optional - to save/persist config in case of a server restart) - http://localhost:8111/save

=Command Example=

Note: localhost can be substituted with IP address/Host name of Rifidi Edge Server. Port can be changed in Rifidi configuration

==commandtypes command example==

*commandtypes - returns a list of available command types

Request (via HTTP Post/Get) "commandtypes" command like this:

http://localhost:8111/commandtypes

Response:

<pre>
<response>
<commands>
<command>
<factoryID>LLRP-ADD_ROSPEC-File</factoryID>
<description>
Configure the LLRP reader via an XML file. Any changes made to the reader are determined by the contents of the file. To generate xml code for the commands you want to submit, check out LLRP Commander here: http://www.fosstrak.org/llrp/index.html
</description>
<readerFactoryID>LLRP</readerFactoryID>
</command>
<command>
<factoryID>ThingMagic-Poll</factoryID>
<description>
Poll the ThingMagic reader for its tags. For monitoring of the read zone, submit this command for recurring execution.
</description>
<readerFactoryID>ThingMagic</readerFactoryID>
</command>
<command>
<factoryID>Alien-Push-Start</factoryID>
<description>
Configure the Alien reader to send back tags using the autonomous mode. To monitor a read zone, configure an Alien autonomous reader to listen. Then submit this command for a one-time execution.
</description>
<readerFactoryID>Alien</readerFactoryID>
</command>
<command>
<factoryID>LLRP-Configure</factoryID>
<description>
Configure the LLRP reader to collect tags. By default, this command will cause the LLRP reader to push back tag reads automatically. If you would rather use the Poll mode, you will need to use the LLRP Poll command. To use the LLRP Configure command, submit it for a one-time execution
</description>
<readerFactoryID>LLRP</readerFactoryID>
</command>
<command>
<factoryID>LLRP-Push-Stop</factoryID>
<description>
Command the LLRP reader to stop sending back tags. To use, supply the RO Spec that is currently executing on the reader, and submit this command for a one-time execution.
</description>
<readerFactoryID>LLRP</readerFactoryID>
</command>
<command>
<factoryID>Awid2010-Poll</factoryID>
<description>
Configure the Awid reader to send back tags using the Gen 2 Portal ID command. To monitor a read zone, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid2010</readerFactoryID>
</command>
<command>
<factoryID>Thingmagic6-Push</factoryID>
<description>
Sets the Thingmagic to push tags back to the edge server
</description>
<readerFactoryID>Thingmagic6</readerFactoryID>
</command>
<command>
<factoryID>Awid3014-Poll</factoryID>
<description>
Configure the Awid reader to send back tags using the Gen 2 Portal ID command. To monitor a read zone, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid3014</readerFactoryID>
</command>
<command>
<factoryID>Awid3014-Push-Stop</factoryID>
<description>
Command the Awid reader to stop sending back tags. To use, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid3014</readerFactoryID>
</command>
<command>
<factoryID>Alien-Poll</factoryID>
<description>
Poll the Alien reader for its tag list. For monitoring of the read zone, submit this command for recurring execution.
</description>
<readerFactoryID>Alien</readerFactoryID>
</command>
<command>
<factoryID>LLRP-Poll</factoryID>
<description>
Poll the LLRP reader for its tags. For monitoring of the read zone, first use the LLRP Configure command to configure the LLRP reader for Poll Mode. Then submit this command for recurring execution.
</description>
<readerFactoryID>LLRP</readerFactoryID>
</command>
<command>
<factoryID>Awid-Mask-Poll</factoryID>
<description>
Configure the Awid reader to send back tags using the Gen 2 Portal ID With Mask command. To monitor a read zone and read a specific memory bank, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid2010</readerFactoryID>
</command>
<command>
<factoryID>Alien-Push-Stop</factoryID>
<description>
Command the Alien reader to stop sending back tags in autonomous mode. To use, submit this command for a one-time execution.
</description>
<readerFactoryID>Alien</readerFactoryID>
</command>
<command>
<factoryID>Awid2010-Push-Stop</factoryID>
<description>
Command the Awid reader to stop sending back tags. To use, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid2010</readerFactoryID>
</command>
<command>
<factoryID>Awid-Read-Block-Data</factoryID>
<description>
Configure the Awid reader to send back memory bank tags using the Read Block Data commmand. To monitor a read zone and read a specific memory bank, submit this command for a one-time execution.
</description>
<readerFactoryID>Awid2010</readerFactoryID>
</command>
</commands>
</response></pre>

==readertypes command example==

*readertypes - returns a list of available reader/sensor types (such as LLRP, Alien, BarCode etc..)

Request (via HTTP Post/Get) "readertypes" command like this:

http://localhost:8111/readertypes

Response:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<sensors>
<sensor>
<factoryID>Generic</factoryID>
<description>A generic Rifidi Adapter.</description>
</sensor>
<sensor>
<factoryID>Opticon</factoryID>
<description>The Rifidi Adapter for the Opticon Barcode Sensor</description>
</sensor>
<sensor>
<factoryID>Alien-Autonomous</factoryID>
<description>The Rifidi Alien autonomous adapter is an endpoint to passively receive tag reads from an Alien reader operating in autonomous mode. You cannot send any commands on the alien autonomous session</description>
</sensor>
<sensor>
<factoryID>Awid2010</factoryID>
<description>The Rifidi Awid adapater supports the Awid TCP/IP protocol on the 2010 and 3014</description>
</sensor>
<sensor>
<factoryID>Thingmagic6</factoryID>
<description>Sensor plugin for Thingmagic 6 readers</description>
</sensor>
<sensor>
<factoryID>LLRP</factoryID>
<description>The Rifidi LLRP adapter supports any reader that exposes a Low Level Reader Protocol (LLRP) interface. LLRP is a standard from EPCglobal.</description>
</sensor>
<sensor>
<factoryID>Awid3014</factoryID>
<description>The Rifidi Awid adapater supports the Awid TCP/IP protocol on the 2010 and 3014</description>
</sensor>
<sensor>
<factoryID>Alien</factoryID>
<description>The Rifidi Alien adapter supports the Alien ALR protocol on the 9900, 9800, 8800 readers.</description>
</sensor>
<sensor>
<factoryID>Thinkify50</factoryID>
<description>Sensor plugin for Thinkify TR50 readers</description>
</sensor>
<sensor>
<factoryID>ThingMagic</factoryID>
<description>The Rifidi ThingMagic adapater supports the ThingMagic RQL protocol on the Mercury 4 and Mercury 5 readers</description>
</sensor>
</sensors>
</response>
</pre>

==createreader command example==

Note: The command is atomic so either all the parameters/properties in request are valid hence the reader/sensor adapter instance is created or the call fails therefore the reader/adapter instance is not created

*createreader/{readerType}/{properties} -creates a reader/sensor configuration

*Special characters: See how to send special characters in properties' values http://wiki.rifidi.net/index.php?title=Rifidi_App_API#Properties_with_special_characters

Request (via HTTP Post/Get) "createreader" command like this (splitting all property key/value pairs by a semicolon):

Response success:

http://localhost:8111/createreader/LLRP/IpAddress=127.0.0.1;Port=5084

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<readerID>LLRP_1</readerID> Note: added in in 4.0 release
<message>Success</message>
</response>
</pre>

Response fail (if there is at least one non valid property, the reader is not created):

http://localhost:8111/createreader/LLRP/IpAddress=127.0.0.2;Port=5084;fakeProp=1234;anotherProp=ABC

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Fail</message>
<description>Not valid properties: fakeProp=1234|anotherProp=ABC</description>
</response>
</pre>

==createreader overriding default readerID command example==

The reader id is important for applications' read zones to appropriate operate, and this id is used to link read zones with sensors. This command enables one to set the readerId versus the system generating one (default behavior).

Note: To override the default reader id, there must be included the property readerID, in order to assign a specific reader id and override the default.
Note: The command is atomic so either all the parameters/properties in request are valid hence the reader/sensor adapter instance is created or the call fails therefore the reader/adapter instance is not created

*createreader/{readerType}/{properties} -creates a reader/sensor configuration

*Special characters: See how to send special characters in properties' values http://wiki.rifidi.net/index.php?title=Rifidi_App_API#Properties_with_special_characters

Request (via HTTP Post/Get) "createreader" command like this (splitting all property key/value pairs by a semicolon):

Response success:

http://localhost:8111/createreader/LLRP/IpAddress=127.0.0.1;Port=5084;readerID=myReaderID

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<readerID>LLRP_1</readerID> Note: added in in 4.0 release
<message>Success</message>
</response>
</pre>

Response fail (if there is at least one non valid property, the reader is not created):

http://localhost:8111/createreader/LLRP/IpAddress=127.0.0.2;Port=5084;fakeProp=1234;anotherProp=ABC;readerID=myReaderID

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Fail</message>
<description>Not valid properties: fakeProp=1234|anotherProp=ABC</description>
</response>
</pre>

==deletereader command example (released in 3.2)==

Note: The command is atomic so either all the parameters/properties in request are valid hence the reader/sensor adapter instance is created or the call fails therefore the reader/adapter instance is not created

*deletereader/{readerID} -deletes a reader/sensor configuration

Response success:

http://localhost:8111/deletereader/LLRP_1

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

Response fail (if there is at least one non valid property, the reader is not created):

http://localhost:8111/deletereader/LLRP

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Fail</message>
<description>Not valid readerID: LLRP</description>
</response>
</pre>

==readers command example==

Request (via HTTP Post/Get) "readers" command like this:

*readers - returns a list of readers/senors managed by the Edge Server

http://localhost:8111/readers

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<sensors>
<sensor>
<serviceID>Alien_1</serviceID>
<factoryID>Alien</factoryID>
</sensor>
<sensor>
<serviceID>Alien_2</serviceID>
<factoryID>Alien</factoryID>
</sensor>
</sensors>
</response>
</pre>

==getproperties command example (to get reader properties)==

*getproperties/{readerID} - returns the reader/sensor properties

Request (via HTTP Post/Get) "getproperties" command like this, to get a reader properties:

http://localhost:8111/getproperties/LLRP_1

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<attributes>
<entry>
<key>ReconnectionInterval</key>
<value>500</value>
</entry>
<entry>
<key>Port</key>
<value>5084</value>
</entry>
<entry>
<key>IpAddress</key>
<value>192.168.1.48</value>
</entry>
<entry>
<key>MaxNumConnectionAttempts</key>
<value>10</value>
</entry>
<entry>
<key>DisplayName</key>
<value>null</value>
</entry>
<entry>
<key>ReaderConfigPath</key>
<value>config/SET_READER_CONFIG.llrp</value>
</entry>
</attributes>
</response>
</pre>

==getproperties command example (to get command properties)==

*getproperties/{commandID} - returns the command properties

Request (via HTTP Post/Get) "getproperties" command like this:

http://localhost:8111/getproperties/LLRP_Configure_1

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<attributes>
<entry>
<key>ROSpecID</key>
<value>1</value>
</entry>
<entry>
<key>AntennaIDs</key>
<value>0</value>
</entry>
<entry>
<key>Duration</key>
<value>1000</value>
</entry>
<entry>
<key>TriggerType</key>
<value>PUSH</value>
</entry>
</attributes>
</response>
</pre>

==setproperties command example (to set reader properties)==

*setproperties/{readerID}/{properties}" - sets the reader/sensor properties
Note: if there is an existing session for updated reader properties to take effect the session will need to be deleted and recreated so the properties are moved to the session

*Special characters: See how to send special characters in properties' values http://wiki.rifidi.net/index.php?title=Rifidi_App_API#Properties_with_special_characters

Request (via HTTP Post/Get) setproperties" like this (splitting all property key/value pairs by a semicolon):

Response success:

http://localhost:8111/setproperties/Alien_1/MaxNumConnectionAttempts=11;DisplayName=Alien_Name

<pre>
<response><message>Success</message></response>
</pre>

Response fail (valid properties are set, ignoring not valid ones):

http://localhost:8111/setproperties/LLRP_1/IpAddress=127.0.0.15;Port=4567;att1=aa;att2=bbb;attt3=YY

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
<state>Warning</state>
<description>Not valid properties: att1=aa|att2=bbb|attt3=YY</description>
</response>
</pre>

==setproperties command example (to set command properties)==

*setproperties/{commandID}/{properties}" - sets the command properties

*Special characters: See how to send special characters in properties' values http://wiki.rifidi.net/index.php?title=Rifidi_App_API#Properties_with_special_characters

Request (via HTTP Post/Get) setproperties" like this (splitting all property key/value pairs by a semicolon):

Response success

http://localhost:8111/setproperties/LLRP_Configure_1/Duration=2130

<pre>

<response><message>Success</message></response>
</pre>

Response fail (valid properties are set, ignoring not valid ones):

http://localhost:8111/setproperties/LLRP_Configure_1/Duration=7500;cc=4;other=67

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
<state>Warning</state>
<description>Not valid properties: cc=4|other=67</description>
</response>
</pre>

==commands command example==

*commands - returns a list of available commands

Request (via HTTP Post/Get) "commands" command like this:

http://localhost:8111/commands

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<commands>
<command>
<commandID>LLRP_Configure_1</commandID>
<factoryID>LLRP-Configure</factoryID>
</command>
</commands>
</response>
</pre>

==createcommand example==

Note: The command is atomic so either all the parameters/properties in request are valid hence the command instance is created or the call fails therefore the rcommand instance is not created

*createcomamnd/{commandType}/{properties} - creates a command to be executed on a reader session

*Special characters: See how to send special characters in properties' values http://wiki.rifidi.net/index.php?title=Rifidi_App_API#Properties_with_special_characters

Request (via HTTP Post/Get) "createcommand" command like this (splitting all property key/value pairs by a semicolon):

Response success:

http://localhost:8111/createcommand/LLRP-Configure/Duration=5000

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<commandID>Alien_Poll_2</commandID> Note: Added in 4.0 release
<message>Success</message>
</response>
</pre>

Response error (if there is at least one non valid property, the command is not created):

http://localhost:8111/createcommand/LLRP-Configure/Duration=4000;propX=123;prop2=AB

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Fail</message>
<description>Not valid properties: propX=123|prop2=AB</description>
</response>
</pre>

==deletecommand command example (released in 3.2)==

Note: The command is atomic so either all the parameters/properties in request are valid hence the reader/sensor adapter instance is created or the call fails therefore the reader/adapter instance is not created

*deletecommand/{commandID} -deletes a reader/sensor configuration

Response success:

http://localhost:8111/deletecommand/LLRP_Configure_1

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

Response fail (if there is at least one non valid property, the reader is not created):

http://localhost:8111/deletecommand/LLRP_Configure

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Fail</message>
<description>Not valid commandID: LLRP_Configure</description>
</response>
</pre>

==createsession command example==

*createsession/{readerID} - creates a session (with corresponding reader/sensor configuration) and returns status code (such as successful)

Request (via HTTP Post/Get) "createsession" command like this:

http://localhost:8111/createsession/LLRP_1

Response: Success
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<sessionID>1</sessionID>
<message>Success</message>
</response>
</pre>

Response: Fail -already a session for sensor id
<pre>
<?xml version="1.0" encoding="UTF-8"?>

<response>
<message>Fail</message>
<description>
java.lang.Exception: Reader Alien_1 already has a session.
</description>
</response>
</pre>

==startsession command example==

*startsession/{readerID}/{sessionID} - starts a session for a given reader/sensor and returns status code (such as successful)

Request (via HTTP Post/Get) "startsession" command like this:

http://localhost:8111/startsession/LLRP_1/1

Response: Success
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

Response: Fail
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Error</message>
<state>CONNECTING</state>
<description>Unable to start session, current state is CONNECTING - See Rifidi Edge Sever Log for details</description>
</response>
</pre>

==readerstatus command example==

*readerstatus/{readerID} - retuns teh status of a given reader/sensor

Request (via HTTP Post/Get) "readerstatus" command like this:

http://localhost:8111/readerstatus/LLRP_1

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<sensor>
<serviceID>LLRP_1</serviceID>
<factoryID>LLRP</factoryID>
</sensor>
<sessions>
<session>
<ID>1</ID>
<status>PROCESSING</status>

<executingcommands>
<executingcommand>
<commandFactory>LLRP-Configure</commandFactory>
<commandID>LLRP_Configure_1</commandID>
<interval>0</interval>
</executingcommand>
</executingcommands>
</session>
</sessions>
</response>
</pre>

==stopsession command example==

*stopsession/{readerID}/{sessionID} - stops a session for a given reader/sensor and returns status code (such as successful)

Request (via HTTP Post/Get) "stopsession" command like this:

http://localhost:8111/stopsession/LLRP_1/1

Response success:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

Response fail:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Error</message>
<state>CREATED</state>
<description>Unable to stop session, current state is CREATED - See Rifidi Edge Sever Log for details</description>
</response>
</pre>

==resetsession command example (released in Rifidi 3.7)==

*/resetsession/{readerID}/{sessionID}

Used to stop and start an existing reader session

http://localhost:8111/resetsession/LLRP_1/1 (for recurring)

==executecommand command example==

*executecommand/{readerID}/{sessionID}/{commandID}/{repeatInterval} - Executes a command for a given session

Request (via HTTP Post/Get) "executecommand" command like this:

http://localhost:8111/executecommand/LLRP_1/1/LLRP_Configure_1/-1 (for recurring)

http://localhost:8111/executecommand/LLRP_1/1/LLRP_Configure_1/0 (for single shot - one time execution)

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

==deletesession command example==

*deletesession/{readerID}/{sessionID} - deletes a session and returns status code (such as successful)

Request (via HTTP Post/Get) "deletesession" command like this:

http://localhost:8111/deletesession/LLRP_1/1

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

==save command example==

*save - Saves the current state of the Edge Server configuration (such as created readers/sensors, modified properties etc..

Request (via HTTP Post/Get) "save" command like this:

http://localhost:8111/save

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
</response>
</pre>

==Ping - Used by failover feature==
*ping - Returns a date/timestamp

Request (via HTTP Post/Get) "ping" command like this:

http://localhost:8111/ping

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<timestamp>1414610247969</timestamp>
</response>
</pre>

==currenttags example (released in Rifidi 3.4)==
*currenttags/{readerID} - Returns a list of tags on a given reader

Note: timestamp, reader and RSSI added in 3.5.1

Request (via HTTP Post/Get) "currenttags" command like this:

http://localhost:8111/currenttags/LLRP_1

Response:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<currenttags>
<tag><id>2f6a00ab13c1536b3085aba3</id><antenna>1</antenna><timestamp>1466736476986</timstamp><reader>LLRP_1</reader><rssir>-100</rssi></tag>
<tag><id>2f6a00ab13c1536b3085aba3</id><antenna>1</antenna><timestamp>1466736476986</timstamp><reader>LLRP_1</reader><rssir>-100</rssi></tag>
</currenttags>
</response>
</pre>

==readermetadata - Used by Web Administration Dashboard for Dynamic Reader & Command Properties/Wizard (released in 3.2)==
*readermetadata- Returns reader metadata

Request (via HTTP Post/Get) "readermetadata" command like this:

http://localhost:8111/readermetadata

Response:
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><response>
<response>
<readers>
<reader>
<properties>
<property>
<name>ReconnectionInterval</name>
<displayName>Reconnection Interval</displayName>
<defaultvalue>500</defaultvalue>
<description>
Upon connection failure, the time to wait between two connection attempts (ms)
</description>
<type>java.lang.Integer</type>
<minvalue>0</minvalue>
<category>connection</category>
<writable>true</writable>
<ordervalue>4.0</ordervalue>
</property>
<property>
<name>Port</name>
<displayName>Port</displayName>
<defaultvalue>8090</defaultvalue>
<description>Port of the Reader</description>
<type>java.lang.Integer</type>
<maxvalue>65535</maxvalue>
<minvalue>0</minvalue>
<category>connection</category>
<writable>true</writable>
<ordervalue>1.0</ordervalue>
</property>
</pre>

==Thinkify RCS Command - Used for one time configuration of a Thinkify USB reader (Deprecated in 3.5.1)==
*rcs/{Thinkify Reader ID}/{sessionid}

request (via HTTP Post/Get) "rcs" command like this:

http://localhost:8111/rcs/ThinkifyUSB_1/1

==startbundle OSGI command example (released in Rifidi 3.7)==

*/startbundle/{bundleID}

Used to stop a OSGI bundle

Request
http://localhost:8111/startbundle/1

Response: success

==stopbundle OSGI command example (released in Rifidi 3.7)==

*/stopbundle/{bundleID}

Used to install a OSGI bundle

Request
http://localhost:8111/stopbundle/1

Response: success

==installbundle OSGI command example (released in Rifidi 3.7)==

*/installbundle
(put the path in the request)

Used to start a OSGI bundle

Request
http://localhost:8111/installbundle

Response: success

==uninstallbundle OSGI command example (released in Rifidi 3.7)==

*/uninstallbundle/{bundleID}
(put the path in the request)

Used to uninstall a OSGI bundle

Request
http://localhost:8111/uninstallbundle/1

Response: success

==ss OSGI command example (released in Rifidi 3.7)==

*/ss

Used to list the OSGI bundles

Request
http://localhost:8111/ss

Response:

<pre>
<response>
<bundles>
<bundles>
<name>org.eclipse.osgi</name>
<id>0</id>
<state>ACTIVE</state>
</bundles>
<bundles>
<name>org.eclipse.equinox.weaving.hook</name>
<id>1</id>
<state>RESOLVED</state>
</bundles>
<bundles>
<name>org.eclipse.equinox.simpleconfigurator</name>
<id>2</id>
<state>ACTIVE</state>
</bundles>
<bundles>
<name>com.sun.mail.javax.mail</name>
<id>3</id>
<state>ACTIVE</state>
</bundles>
</pre>

==Set GPO Command Example (released in Rifidi 3.8.1)==

*/setgpo/{readerID}/{sessionID}/{ports}

Used to set gpo

Request
http://localhost:8111/setgpo/LLRP_1/1/1,2,3

Response:

<pre>
<response>
<message>Success</message>
</response>
</pre>

==Flash GPO Command Example (released in Rifidi 3.8.1)==

*//flashgpo/{readerID}/{sessionID}/{ports}/{duration in seconds}

Used to turn gpo on for a specified duration such as Flashing a light on for 4 seconds then turn it off again

Request
http://localhost:8111/flashgpo/LLRP_1/1/1,2,3/4

Response:

<pre>
<response>
<message>Success</message>
</response>
</pre>

How to Upgrade Rifidi

2020-12-24T12:29:14Z

Bppause: /* RedHat (RHEL) */

These steps explain how to upgrade a Rifidi Edge server

=Edge Server Upgrade (Windows)=

Note: Applicable to version 1.3 or greater

# Download and install in a new directory (windows only) - see below for Ubuntu/Linux install steps
# Ensure all rifidi edge servers instances are stopped (old and new versions)
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# Start the new Rifidi server

All you applications and reader/sensor adapters should start and operate as prior version

Note: Advised that you make a copy of your old version before deleting in case you run into any issues requiring recovery

=Ubuntu Upgrade(Specfics) or Rifidi Box (which comes with Ubuntu OS)=
Steps specific to Rifidi Box or Ubuntu Deb

# SSH into the box and copy the contents of the application directory, the rifidi.xml, and any other files (llrp files, etc) to ~
# Make sure the edge server is shut down...telnet in and type "close" in the console.
#. "sudo apt-get purge rifidi"
#. Copy the new deb into ~ on the machine (Such as use dropbox and perform a "wget" on the dropbox link for this, very handy!)
# "sudo dpkg -i (deb here)"
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# "sudo /etc/init.d/rifidiserver start"
# Telnet in and verify that everything looks good. Upgrade complete.

=RedHat (RHEL)=

# SSH into the box and copy the contents of the application directory, the rifidi.xml, and any other files (llrp files, etc) to ~
# Make sure the edge server is shut down...telnet in and type "close" in the console
# Copy the new zip into ~ on the machine (Such as use dropbox and perform a "wget" on the dropbox link for this, very handy!).
# Manually remove and unzip the new version instead of using apt-get commands.
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# "sudo /etc/init.d/rifidiserver start"
# Telnet in and verify that everything looks good. Upgrade complete.

How to Upgrade Rifidi

2020-12-24T12:28:44Z

Bppause:

These steps explain how to upgrade a Rifidi Edge server

=Edge Server Upgrade (Windows)=

Note: Applicable to version 1.3 or greater

# Download and install in a new directory (windows only) - see below for Ubuntu/Linux install steps
# Ensure all rifidi edge servers instances are stopped (old and new versions)
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# Start the new Rifidi server

All you applications and reader/sensor adapters should start and operate as prior version

Note: Advised that you make a copy of your old version before deleting in case you run into any issues requiring recovery

=Ubuntu Upgrade(Specfics) or Rifidi Box (which comes with Ubuntu OS)=
Steps specific to Rifidi Box or Ubuntu Deb

# SSH into the box and copy the contents of the application directory, the rifidi.xml, and any other files (llrp files, etc) to ~
# Make sure the edge server is shut down...telnet in and type "close" in the console.
#. "sudo apt-get purge rifidi"
#. Copy the new deb into ~ on the machine (Such as use dropbox and perform a "wget" on the dropbox link for this, very handy!)
# "sudo dpkg -i (deb here)"
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# "sudo /etc/init.d/rifidiserver start"
# Telnet in and verify that everything looks good. Upgrade complete.

=RedHat (RHEL)=

# SSH into the box and copy the contents of the application directory, the rifidi.xml, and any other files (llrp files, etc) to ~
# Make sure the edge server is shut down...telnet in and type "close" in the console
# Copy the new deb into ~ on the machine (Such as use dropbox and perform a "wget" on the dropbox link for this, very handy!).
# Manually remove and unzip the new version instead of using apt-get commands.
# Copy the Rifidi.xml from the old version to the new server home directory (this contains the reader/sensor adapter configurations)
# Manually make any updates to the server configuration (rifidiserver.ini in windows/ rifidi-server in Ubuntu/Linux) you may have customized for your setup [[Edge_Server_Configuration]]
# Copy any customized Rifidi Applications from old server version ./applications to new server version ./applications
# Copy any customized .llrp configuration files from old server version ./config to new server version ./config
# Copy default.ini files from old server ./config to new server ./config (this contains list of custom Rifidi Apps to start by default when server starts)
# "sudo /etc/init.d/rifidiserver start"
# Telnet in and verify that everything looks good. Upgrade complete.

2019-07-26T18:06:13Z

Bppause: /* Requirements */

[[category:userDoc]]

=Quick Start Video=
A quick start video is available at http://rifidi.net/www/videos/emulator/emulator.swf

=Requirements=
*Microsoft Windows 2000/XP/2003 or Linux (Ubuntu, Red Hat, SuSe)
*Java
**For [[Emulator 1.5.1]] and above: Sun Java Runtime Environment 1.6 update 4 (32 bit only) or higher Note: Not yet supported on Java 1.8 on product backlog
**For [[Emulator 1.5]] and below: Sun Java Runtime Environment 1.5 (32 bit only

=Installation=
Emulator is completely written in Java so installation is very easy. Additionally, Emulator is packaged in a standard installer.

# Download the latest version of Rifidi Emulator from http://sourceforge.net/projects/rifidi/
# Double click to run the install. Follow the on screen instructions.

=Launching Rifidi=

*Windows Users: Simply click the shortcut located in the Rifidi folder in the Start Menu/Programs folder.
*Linux Users: Double click the executable file located in the installation directory.
** Note: If the application binary does not have the correct permissions after installation (not marked executable), you can use one of the following steps to correct this:
**# From a terminal:
**#* Change to the application directory (''e.g.,'' "cd /home/user/rifidi/RifidiEmulator1.6/")
**#* Add executable permissions to the application file: "chmod +x emulator" (without the quotes).
**# Within the Ubuntu File Manager (nautilus):
**#* Navigate to the application directory (''e.g.,'' /home/user/rifidi/RifidiEmulator1.6/)
**#* Right-click on the "emulator" application, and select "Properties" from the context menu.
**#* Click on the "Permissions" tab at the top and mark the checkbox "Allow executing file as program", then click "Close."

=Starting a Virtual Reader=

# Once the program is loaded, the main GUI will be present.
[[Image:Quickstart-1-initial.png |none|thumb|800px|The Rifidi Emulator GUI]]
#To start the reader, click the 'add reader button'.
#Select the reader type to be emulated and pick the address to start the reader on. For the purposes of this quickstart guide, start an Alien Reader.[[Image:Quickstart-2-reader.png |none|thumb|400px|Select the kind of reader]]
#Select the Reader's IP and port address. 127.0.0.1:1000, will use the loopback address of the current system and start listening on port 30000. [[Image:Quickstart-3-createReader.png|none|thumb|400px|Supply the reader's IP and port]]
#Right click the reader and press start [[Image:Quickstart-4-startReader.png |none|thumb|800px|Rightclick on the reader to begin]]
#The reader may be stopped at any time right clicking and pushing stop.

=Adding and Removing Tags=

#First you will need to create the tags. There are two ways to do this:
##Manual entry may be done by entering tags into the provided text field and clicking add.
###Click on the add multiple tags button
###Follow the steps in the tag creation wizard [[Image:Quickstart-5-createTags.png |none|thumb|400px|Tag creation wizard]]
###Removal may also be done in the similar manner by clicking remove tag after either selecting tags from the list or manually entering the tag.
##Tags may also be added from an XML file. A few example tag files are included with the program installation. Loading tag files are not additive, however, and will replace any data already present in the reader.
#Next Add the tags by dragging and dropping them onto a reader [[Image:Quickstart-6-tagsOnAntenna.png |none|thumb|800px|Tags on an Antenna]]

=Viewing Results=

To view the results of adding tags on the fly, one may either have a supporting tool open, such as the Alien RFID Gateway, or simply use telnet to perform command interaction with the reader. To telnet into the reader, simply connect to the address given to the reader when it was started. Once connected, the following commands may be useful.

<pre>get TagList - Displays the tags currently detected by the reader.
get $PROPERTY - Returns the value for the passed property.
set $PROPERTY=$VALUE - Sets the passed property to the passed value.
q - Close the connection</pre>

If you would like to see how to write a client tool connect to the reader, see our [[Alien Example Client]]

=Quickstart Video=
A video of these installation steps can be seen here: http://www.rifidi.net/www/rifidipackage/rif_out.html

Version 3.8.0

2019-07-23T18:54:41Z

Bppause: /* LLRP */

=Changes in 3.8 =

==LLRP==

# Ability to set antenna power
# ENABLE_EVENTS_AND_REPORTS for compatibility with Zebra FX9500/9600 readers
# Fixes for the RSSI filtering service impacting LLRP compatible readers - http://forums.rifidi.net/viewtopic.php?f=35&t=4706
# Fixes for scenarios causing LLRP reader sessions to get stuck in a Loggingin state

==Links==

Javadocs:
http://www.transcends.co/www/javadoc/edge3.8.0/

[[Developer's_Guide]]

[[User's_Guide]]

Version 3.8.0

2019-07-23T18:54:20Z

Bppause: /* LLRP */

=Changes in 3.8 =

==LLRP==

# Ability to set antenna power
# ENABLE_EVENTS_AND_REPORTS for compatibility with Zebra FX9500/9600 readers
# Fixes for the RSSI filtering service - http://forums.rifidi.net/viewtopic.php?f=35&t=4706
# Fixes for scenarios causing LLRP reader sessions to get stuck in a Loggingin state

==Links==

Javadocs:
http://www.transcends.co/www/javadoc/edge3.8.0/

[[Developer's_Guide]]

[[User's_Guide]]