Permalink
Browse files

rfid update and enable in TOC for SP1 release

  • Loading branch information...
1 parent 9c0a38b commit c75cfb2340ed23d21b28ffa4ba2c372fc6bfb828 @cfh463 cfh463 committed Jan 10, 2013
Showing with 105 additions and 58 deletions.
  1. +3 −3 docs/rhoelements/backlight.txt
  2. +100 −54 docs/rhoelements/rfid.txt
  3. +1 −1 indicators.rb
  4. +1 −0 toc.rb
View
6 docs/rhoelements/backlight.txt
@@ -50,7 +50,7 @@ For more details on the event syntax and parameters see the <a href="/rhoelement
Items listed in this section indicate methods or, in some cases, indicate parameters which will be retrieved.
-<table class="re-table"><col width="10%" /><col width="68%" /><col width="22%" /><tr><th class="tableHeading">Name</th><th class="tableHeading">Description</th><th class="tableHeading">Default Value</th></tr><tr><td class="clsSyntaxCells clsOddRow"><b>on</b></td><td class="clsSyntaxCells clsOddRow">Turn on the screen backlight</td><td class="clsSyntaxCells clsOddRow">
+<table class="re-table"><col width="10%" /><col width="68%" /><col width="22%" /><tr><th class="tableHeading">Name</th><th class="tableHeading">Description</th><th class="tableHeading">Default Value</th></tr><tr><td class="clsSyntaxCells clsOddRow"><b>on</b></td><td class="clsSyntaxCells clsOddRow">Turn on the screen backlight. N/A for Android devices, please use the wake module to keep the screen ON.</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>off</b></td><td class="clsSyntaxCells clsEvenRow">Turn off the screen backlight</td><td class="clsSyntaxCells clsEvenRow">
N/A
@@ -73,7 +73,7 @@ Values are returned to the caller in RhoElements via Events. Most modules conta
<br />
###backlightSettingsEvent
The backlight display settings
-<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>intensity</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">The current backlight intensity value E.g. 2</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>intensityRange</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">A javascript array of integers contanining the valid range of intensity values. e.g. ['0','1','2']</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">3</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>state</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">The current backlight state "on" or "off" or "timeout"</td></tr></table>
+<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>intensity</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">The current backlight intensity value E.g. 2. On Android a negative value indicates the default system value.</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>intensityRange</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">A javascript array of integers contanining the valid range of intensity values. e.g. ['0','1','2']</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">3</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>state</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">The current backlight state "on" or "off" or "timeout"</td></tr></table>
@@ -97,7 +97,7 @@ Windows Mobile 6.5 Devices with a light sensor, such as the ES400 will support t
###Enterprise Tablet
-Unlike all other devices, changes made to the backlight intensity are made only to RhoElements. Switching native applications or quitting RhoElements will revert the backlight intensity to the system's default level until RhoElements is resumed.
+Unlike all other devices, changes made to the backlight intensity are made only to RhoElements. Switching native applications or quitting RhoElements will revert the backlight intensity to the system's default level until RhoElements is resumed. Also the method "on" does not work as the backlight settings are application specific, please use the Wake module to keep the screen on.
View
154 docs/rhoelements/rfid.txt
@@ -50,42 +50,42 @@ For more details on the event syntax and parameters see the <a href="/rhoelement
Items listed in this section indicate methods or, in some cases, indicate parameters which will be retrieved.
-<table class="re-table"><col width="10%" /><col width="68%" /><col width="22%" /><tr><th class="tableHeading">Name</th><th class="tableHeading">Description</th><th class="tableHeading">Default Value</th></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enumerate</b></td><td class="clsSyntaxCells clsOddRow">Returns a list of RFID readers present on the device, and their respective capabilities via enumRFIDEvent.For the supported devices,this method will return the number of RFID readers in the device as 1.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>connect</b></td><td class="clsSyntaxCells clsEvenRow">Creates connection to the default RFID reader.By default,the plugin attempts to connect to the RFID Reader whenever the plugin is loaded.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>disconnect</b></td><td class="clsSyntaxCells clsOddRow">Disconnects the current RFID connection and flushes all properties of the "rfid" module,except for the events.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>stop</b></td><td class="clsSyntaxCells clsEvenRow">Soft trigger to stop a runnning inventory or locateTag operation.All the pending tag reports are discarded. </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>performInventory</b></td><td class="clsSyntaxCells clsOddRow">Performs an inventory operation on the RFID reader which is started and stopped according to the trigger settings done by the application.
- By default, performInventory starts an inventory operation immediately and there is no default stop trigger.So, an explicit "stop" call must be made
- to stop the running Inventory in the default case.Any pre filters that have been added will be applied for the inventory operation.
- Tags will be reported as part of the TagData Array in the tagEvent's JSON object. When the property "invMemBank" is set(to either Reserved/EPC/TID/User) prior to calling performInventory,
- the corresponding memory-bank's data shall also be read for the tags being inventoried. For the inventoried tags, additional fields may be reported as part
+<table class="re-table"><col width="10%" /><col width="68%" /><col width="22%" /><tr><th class="tableHeading">Name</th><th class="tableHeading">Description</th><th class="tableHeading">Default Value</th></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enumerate</b></td><td class="clsSyntaxCells clsOddRow">Returns a list of RFID readers present on the device, and their respective capabilities via enumRFIDEvent. For the supported devices, this method will return the number of RFID readers in the device as 1.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>connect</b></td><td class="clsSyntaxCells clsEvenRow">Creates connection to the default RFID reader. By default, the plugin attempts to connect to the RFID Reader whenever the plugin is loaded.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>disconnect</b></td><td class="clsSyntaxCells clsOddRow">Disconnects the current RFID connection and flushes all properties of the "rfid" module,except for the events.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>stop</b></td><td class="clsSyntaxCells clsEvenRow">Soft trigger to stop a runnning inventory or locateTag operation. All the pending tag reports are discarded. </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>performInventory</b></td><td class="clsSyntaxCells clsOddRow">Performs an inventory operation on the RFID reader which is started and stopped according to the trigger settings done by the application.
+ By default, performInventory starts an inventory operation immediately and there is no default stop trigger. So, an explicit "stop" call must be made
+ to stop the running Inventory in the default case. Any pre filters that have been added will be applied for the inventory operation.
+ Tags will be reported as part of the TagData Array in the tagEvent's JSON object. When the property "invMemBank" is set(to either Reserved/EPC/TID/User) prior to calling performInventory,
+ the corresponding memory-bank's data shall also be read for the tags being inventoried. For the inventoried tags, additional fields may be reported as part
of tagEvent JSON by setting to true properties such as "enableTagCRC", "enableTagPC", "enableTagSeenCount", "enableTagRSSI", "enableTagAntennaID",etc.
As long as inventory operation is running, the plugin cannot process those Meta-tags that could initiate a RFID operation like performInventory, locateTag, readTag and other Access operations.
The plugin returns an error string describing that it is busy and it can perform other RFID operations only when the inventory is stopped.
- </td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>locateTag</b></td><td class="clsSyntaxCells clsEvenRow">Configures the locateTag operation which will look for a specific Tag ID on a specific antennaID, and will keep reporting tagEvents if the tag is found along with relative distance (In a scale of 0-100.100 being the closest) to help locate the requested tag.
- Also if the beepOnRead is enabled(Default state), the beep frequency varies proportionate to the relative distance(Geiger counter).The tagLocationing algorithms can use only one antenna to locate a tagID. Thus, antennaSelected cannot take the take default value 0, but one of the antenna IDs supported by the device.
- As with performInventory,the start and stop trigger settings can autonomously invoke and stop the locateTag operation.Please note that
- while the properties "reportUniqueTags","reportTrigger" are not relevant here,the tag field settings "enableTagAntennaID","enableTagRssi",etc are still applicable</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>killTag</b></td><td class="clsSyntaxCells clsOddRow">Kills the currently selected tag referenced by tagID, or kills tags that match the filter criteria.Requires tagKillPassword.
- tagID property is ignored if useAccessFilter property is set to true.If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
- If tagID is empty and useAccessFilter is false(i.e the default value),the kill operation will be attempted on all the tags in the field of view.
- </td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>getRadioPowerState</b></td><td class="clsSyntaxCells clsEvenRow">Returns a boolean value (1 or 0)representing the radio power state via radioPowerStateEvent.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>addPreFilter</b></td><td class="clsSyntaxCells clsOddRow">Adds a preconfigured filter to the currently selected antenna. It is used to sort out the subset of tags to participate in the next RFID operations.
- Multiple preFilters may be added,limited by the RFID reader. Each of them should be referenced by a unique value (which should be assigned to preFilterID property) before calling addPreFilter method.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>deletePreFilter</b></td><td class="clsSyntaxCells clsEvenRow">Deletes a pre-filter of the index set by preFilterID property.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>clearPreFilters</b></td><td class="clsSyntaxCells clsOddRow">Deletes ALL preFilters</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>radioPowerStateOn</b></td><td class="clsSyntaxCells clsEvenRow">Sets the radio power of the RFID module on</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>radioPowerStateOff</b></td><td class="clsSyntaxCells clsOddRow">Sets the radio power of the RFID module off</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagRead</b></td><td class="clsSyntaxCells clsEvenRow">Reads from a tag or a set of tags (defined by Access filter) using the preconfigured read Parameters.The tag data is returned via a tagEvent.The read data is available in tagData.memoryBankData field of the JSON object passed to tagEvent handler.
- tagID property is ignored if useAccessFilter property is set to true.If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.If the tagID is empty and useAccessFilter is false, the read operation will be performed on all the tags in field of view.
- </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagWrite</b></td><td class="clsSyntaxCells clsOddRow">Writes data to a tag or a set of tags(defined by Access filter) using the preconfigured Write parameters.
- tagID property is ignored if useAccessFilter property is set to true.If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
- If the tagID is empty and useAccessFilter is false, the write operation will be attempted on all the tags in field of view</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setTagID</b></td><td class="clsSyntaxCells clsEvenRow">Writes a preconfigured new tag ID to the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>setTagAccessPassword</b></td><td class="clsSyntaxCells clsOddRow">Writes a preconfgured new tag access password to the currently selected tag.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setTagKillPassword</b></td><td class="clsSyntaxCells clsEvenRow">Writes a preconfigured new kill password to the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>setSingulation</b></td><td class="clsSyntaxCells clsOddRow">sets the preconfigured singulation parameters on all the antenna(e).Atleast one of Session or TagPopulation parameters must be properly set before calling this method.
- When state-aware singulation is desired,performStateAwareSingulation is to be set to true and the configured values for SL flag and Inventory state will be matched during singulation of tags.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>getSingulation</b></td><td class="clsSyntaxCells clsEvenRow">Requests the current singulation parameters (session and tag population) for the antenna(e).
- The result is returned in a singulationEvent.Note that all antennae share the same singulation settings.
- </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getRFParams</b></td><td class="clsSyntaxCells clsOddRow">gets the current RF Mode, Transmit power parameter for the currently selected antenna. The result is return in rfParamsEvent..The property antennaSelected cannot take default value(0) because the RF Params are returned only for one antennaID.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagLock</b></td><td class="clsSyntaxCells clsEvenRow">Locks a tag (or tags) according to the lockPrivilege and lockField, requires tagPassword.tagID property is ignored if useAccessFilter property is set to true.If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
+ </td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>locateTag</b></td><td class="clsSyntaxCells clsEvenRow">Configures the locateTag operation which will look for a specific Tag ID on a specific antennaID, and will keep reporting tagEvents if the tag is found along with relative distance (In a scale of 0-100, 100 being the closest) to help locate the requested tag.
+ Also if the beepOnRead is enabled (Default state), the beep frequency varies proportionate to the relative distance (Geiger counter). The tagLocationing algorithms can use only one antenna to locate a tagID. Thus, antennaSelected cannot take the take default value 0, but one of the antenna IDs supported by the device.
+ As with performInventory, the start and stop trigger settings can autonomously invoke and stop the locateTag operation. Please note that
+ while the properties "reportUniqueTags","reportTrigger" are not relevant here, the tag field settings "enableTagAntennaID", "enableTagRssi", etc are still applicable</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>killTag</b></td><td class="clsSyntaxCells clsOddRow">Kills the currently selected tag referenced by tagID, or kills tags that match the filter criteria. Requires tagKillPassword.
+ tagID property is ignored if useAccessFilter property is set to true. If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
+ If tagID is empty and useAccessFilter is false (i.e the default value),the kill operation will be attempted on all the tags in the field of view.
+ </td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>getRadioPowerState</b></td><td class="clsSyntaxCells clsEvenRow">Returns a boolean value (1 or 0) representing the radio power state via radioPowerStateEvent.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>addPreFilter</b></td><td class="clsSyntaxCells clsOddRow">Adds a preconfigured filter to the currently selected antenna. It is used to sort out the subset of tags to participate in the next RFID operations.
+ Multiple preFilters may be added,limited by the RFID reader. Each of them should be referenced by a unique value (which should be assigned to preFilterID property) before calling addPreFilter method.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>deletePreFilter</b></td><td class="clsSyntaxCells clsEvenRow">Deletes a pre-filter of the index set by preFilterID property.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>clearPreFilters</b></td><td class="clsSyntaxCells clsOddRow">Deletes ALL preFilters</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>radioPowerStateOn</b></td><td class="clsSyntaxCells clsEvenRow">Sets the radio power of the RFID module on</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>radioPowerStateOff</b></td><td class="clsSyntaxCells clsOddRow">Sets the radio power of the RFID module off</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagRead</b></td><td class="clsSyntaxCells clsEvenRow">Reads from a tag or a set of tags (defined by Access filter) using the preconfigured read Parameters. The tag data is returned via a tagEvent. The read data is available in tagData.memoryBankData field of the JSON object passed to tagEvent handler.
+ tagID property is ignored if useAccessFilter property is set to true. If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation. If the tagID is empty and useAccessFilter is false, the read operation will be performed on all the tags in field of view.
+ </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagWrite</b></td><td class="clsSyntaxCells clsOddRow">Writes data to a tag or a set of tags (defined by Access filter) using the preconfigured Write parameters.
+ tagID property is ignored if useAccessFilter property is set to true. If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
+ If the tagID is empty and useAccessFilter is false, the write operation will be attempted on all the tags in field of view</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setTagID</b></td><td class="clsSyntaxCells clsEvenRow">Writes a preconfigured new tag ID to the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>setTagAccessPassword</b></td><td class="clsSyntaxCells clsOddRow">Writes a preconfgured new tag access password to the currently selected tag.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setTagKillPassword</b></td><td class="clsSyntaxCells clsEvenRow">Writes a preconfigured new kill password to the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>setSingulation</b></td><td class="clsSyntaxCells clsOddRow">sets the preconfigured singulation parameters on all the antenna(e). At least one of Session or TagPopulation parameters must be properly set before calling this method.
+ When state-aware singulation is desired, performStateAwareSingulation is to be set to true and the configured values for SL flag and Inventory state will be matched during singulation of tags.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>getSingulation</b></td><td class="clsSyntaxCells clsEvenRow">Requests the current singulation parameters (session and tag population) for the antenna(e).
+ The result is returned in a singulationEvent. Note that all antennae share the same singulation settings.
+ </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getRFParams</b></td><td class="clsSyntaxCells clsOddRow">gets the current RF Mode, Transmit power parameter for the currently selected antenna. The result is return in rfParamsEvent. The property antennaSelected cannot take default value(0) because the RF Params are returned only for one antennaID.</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagLock</b></td><td class="clsSyntaxCells clsEvenRow">Locks a tag (or tags) according to the lockPrivilege and lockField, requires tagPassword.tagID property is ignored if useAccessFilter property is set to true. If useAccessFilter is set to true, then tagPatternA, tagPatternB and matchPattern will be used to filter out tags to perform the operation.
If the tagID is empty and useAccessFilter is false, the lock operation will be attempted on all the tags in field of view
- </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getRFModeInfo</b></td><td class="clsSyntaxCells clsOddRow">gets the RF mode information for the given RFMode index. The result is returned in a rfModeInfoEvent</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setRFParams</b></td><td class="clsSyntaxCells clsEvenRow">sets the RF mode and/or transmit power of a selected antenna</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getLastAccessResult</b></td><td class="clsSyntaxCells clsOddRow">gets the result of the last access operation in the lastAccessResultEvent.The result consists of numbers of tags on which the last access operation succeeded and failed.Note that this method can give valid results only after a operationCompleteEvent is received indicating that the last operation has ended.</td><td class="clsSyntaxCells clsOddRow" /></tr></table>
+ </td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getRFModeInfo</b></td><td class="clsSyntaxCells clsOddRow">gets the RF mode information for the given RFMode index. The result is returned in a rfModeInfoEvent</td><td class="clsSyntaxCells clsOddRow" /></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>setRFParams</b></td><td class="clsSyntaxCells clsEvenRow">sets the RF mode and/or transmit power of a selected antenna</td><td class="clsSyntaxCells clsEvenRow" /></tr><tr><td class="clsSyntaxCells clsOddRow"><b>getLastAccessResult</b></td><td class="clsSyntaxCells clsOddRow">gets the result of the last access operation in the lastAccessResultEvent. The result consists of numbers of tags on which the last access operation succeeded and failed. Note that this method can give valid results only after a operationCompleteEvent is received indicating that the last operation has ended.</td><td class="clsSyntaxCells clsOddRow" /></tr></table>
##Parameters
Items listed in this section indicate parameters, or attributes which can be set.
<table class="re-table"><col width="20%" /><col width="20%" /><col width="38%" /><col width="22%" /><tr><th class="tableHeading">Name</th><th class="tableHeading">Possible Values</th><th class="tableHeading">Description</th><th class="tableHeading">Default Value</th></tr><tr><td class="clsSyntaxCells clsOddRow"><b>antennaSelected:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">0-N</td><td class="clsSyntaxCells clsOddRow">Index of the antenna being selected for the subsequent data or configuration operations.A '0' indicates all antennas to be selected.</td><td class="clsSyntaxCells clsOddRow">0(ALL)</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>beepOnRead:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">true,false,1,0</td><td class="clsSyntaxCells clsEvenRow">Specifies if the device should beep whenever a tag is reported.</td><td class="clsSyntaxCells clsEvenRow">true</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enableTagAccessStatus:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">true, false, 1, 0</td><td class="clsSyntaxCells clsOddRow">Enable/Disable the access status field in the tag reports.Contains valid values for Read/Write/Lock/Kill operations</td><td class="clsSyntaxCells clsOddRow">false</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>enableTagAntennaID:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">0-N</td><td class="clsSyntaxCells clsOddRow">Index of the antenna being selected for the subsequent data or configuration operations. A '0' indicates all antennas to be selected.</td><td class="clsSyntaxCells clsOddRow">0(ALL)</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>beepOnRead:[Value]
+</b></td><td class="clsSyntaxCells clsEvenRow">true, false, 1, 0</td><td class="clsSyntaxCells clsEvenRow">Specifies if the device should beep whenever application receives a tag.</td><td class="clsSyntaxCells clsEvenRow">true</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enableTagAccessStatus:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">true, false, 1, 0</td><td class="clsSyntaxCells clsOddRow">Enable/Disable the access status field in the tag reports. Contains valid values for Read/Write/Lock/Kill operations</td><td class="clsSyntaxCells clsOddRow">false</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>enableTagAntennaID:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">true, false, 1, 0</td><td class="clsSyntaxCells clsEvenRow">Enable/Disable the antenna ID field in the tag reports</td><td class="clsSyntaxCells clsEvenRow">false</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enableTagCRC:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">true, false, 1, 0</td><td class="clsSyntaxCells clsOddRow">Enable/Disable the CRC field in the tag reports</td><td class="clsSyntaxCells clsOddRow">false</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>enableTagXPC:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">true, false, 1, 0</td><td class="clsSyntaxCells clsEvenRow">Enable/Disable the XPC field in the tag reports</td><td class="clsSyntaxCells clsEvenRow">false</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>enableTagPC:[Value]
@@ -107,18 +107,18 @@ N/A
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>performStateAwareSingulation:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">true, false, 1, 0</td><td class="clsSyntaxCells clsEvenRow">If set to true,the tags will henceforth be singulated based on the configured inventory states/SL flags rather than the reader defaults.
- Besides,the subsequently added pre-filters should indicate the desired inventory state/SL flags of the matching/non-matching tags.
- If this property is set to false,the tags are singulated based on the Reader defaults.</td><td class="clsSyntaxCells clsEvenRow">false</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>preFilterStateAwareAction:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">INV_A_NOT_INV_B,ASRT_SL_NOT_DSRT_SL,INV_A,ASRT_SL,NOT_INV_B,NOT_DSRT_SL,INV_A2BB2A_NOT_INV_A,NEG_SL_NOT_ASRT_SL,INV_B_NOT_INV_A,DSRT_SL_NOT_ASRT_SL,INV_B,DSRT_SL,NOT_INV_A,NOT_ASRT_SL,NOT_INV_A2BB2A,NOT_NEG_SL</td><td class="clsSyntaxCells clsOddRow">Sets the State-aware Action(s) for the current pre-filter's matching and/or non-matching tags.This property is considered only when performStateAwareSingulation is true.
+ Besides, the subsequently added pre-filters should indicate the desired inventory state/SL flags of the matching/non-matching tags.
+ If this property is set to false, the tags are singulated based on the Reader defaults.</td><td class="clsSyntaxCells clsEvenRow">false</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>preFilterStateAwareAction:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">INV_A_NOT_INV_B, ASRT_SL_NOT_DSRT_SL, INV_A,ASRT_SL, NOT_INV_B, NOT_DSRT_SL, INV_A2BB2A_NOT_INV_A, NEG_SL_NOT_ASRT_SL, INV_B_NOT_INV_A, DSRT_SL_NOT_ASRT_SL, INV_B, DSRT_SL, NOT_INV_A, NOT_ASRT_SL, NOT_INV_A2BB2A, NOT_NEG_SL</td><td class="clsSyntaxCells clsOddRow">Sets the State-aware Action(s) for the current pre-filter's matching and/or non-matching tags. This property is considered only when performStateAwareSingulation is true.
All actions indicating asserting/de-asserting SL flags are valid only when preFilterTarget is SL.
All actions indicating changes to the inventoried states(i.e A/B) are valid only when preFilterTarget is INV_S0/INV_S1/INV_S2/INV_S3</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>preFilterTarget:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">SL,INV_S0,INV_S1,INV_S2,INV_S3</td><td class="clsSyntaxCells clsEvenRow">Indicates which flag(i.e SL/INV_S0/INV_S1/INV_S2/INV_S3) shall be affected when the current state-Aware prefilter is applied.This property will be considered only when performStateAwareSingulation is true.</td><td class="clsSyntaxCells clsEvenRow">
+</b></td><td class="clsSyntaxCells clsEvenRow">SL, INV_S0, INV_S1, INV_S2, INV_S3</td><td class="clsSyntaxCells clsEvenRow">Indicates which flag(i.e SL/INV_S0/INV_S1/INV_S2/INV_S3) shall be affected when the current state-Aware prefilter is applied. This property will be considered only when performStateAwareSingulation is true.</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>preFilterStateUnawareAction:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">SELECT_NOT_UNSELECT,SELECT,NOT_UNSELECT,UNSELECT,UNSELECT_NOT_SELECT,NOT_SELECT</td><td class="clsSyntaxCells clsOddRow">Sets the State-unaware Action for the current pre-filter's matching and/or non-matching tags.This property is considered only when performStateAwareSingulation is false.
- This determines whether to select and/or unselect matching tags /non-matching tags when the current pre-filter is applied.</td><td class="clsSyntaxCells clsOddRow">SELECT_NOT_UNSELECT</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>preFilterBitCount:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">SELECT_NOT_UNSELECT, SELECT, NOT_UNSELECT, UNSELECT, UNSELECT_NOT_SELECT, NOT_SELECT</td><td class="clsSyntaxCells clsOddRow">Sets the State-unaware Action for the current pre-filter's matching and/or non-matching tags. This property is considered only when performStateAwareSingulation is false.
+ This determines whether to select and/or unselect matching tags/non-matching tags when the current pre-filter is applied.</td><td class="clsSyntaxCells clsOddRow">SELECT_NOT_UNSELECT</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>preFilterBitCount:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">Number of applicable bits in the filterHexPattern</td><td class="clsSyntaxCells clsEvenRow">Specifies the number of bits within the preFilterHexPattern to match in a subsequent call to addFilter()</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>preFilterBitOffset:[Value]
@@ -129,14 +129,12 @@ N/A
</b></td><td class="clsSyntaxCells clsOddRow">unsigned integer</td><td class="clsSyntaxCells clsOddRow">Specifies the ID of the filter to apply in a subsequent call to addFilter()`or deleteFilter()</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>preFilterMemBank:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">Reserved,EPC,TID,User</td><td class="clsSyntaxCells clsEvenRow">Specifies the memory bank to apply in a subsequent call to addFilter()</td><td class="clsSyntaxCells clsEvenRow">EPC</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>startPeriod:[Value]
+</b></td><td class="clsSyntaxCells clsEvenRow">Reserved, EPC, TID, User</td><td class="clsSyntaxCells clsEvenRow">Specifies the memory bank to apply in a subsequent call to addFilter()</td><td class="clsSyntaxCells clsEvenRow">EPC</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>startPeriod:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">milliseconds</td><td class="clsSyntaxCells clsOddRow">Sets the repeat period for a subsequent inventory</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>reportTrigger:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">0-N</td><td class="clsSyntaxCells clsEvenRow">This property controls the reporting of tags from the plugin.Setting this property to N indicate to the plugin that it
- should report tags on seeing N tags.0 indicates to report tags only at
- the end of inventory.
- </td><td class="clsSyntaxCells clsEvenRow">1</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>reportUniqueTags:[Value]
+</b></td><td class="clsSyntaxCells clsEvenRow">0-N</td><td class="clsSyntaxCells clsEvenRow">This property controls the reporting of tags from the plugin. Setting this property to N indicate to the plugin that it
+ should report tags on seeing N tags. 0 indicates to report tags only at the end of inventory.</td><td class="clsSyntaxCells clsEvenRow">1</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>reportUniqueTags:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">true, false, 1, 0</td><td class="clsSyntaxCells clsOddRow">Specifies to report only unique tags</td><td class="clsSyntaxCells clsOddRow">true</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>RFMode:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">One of the supported RF Modes listed in the capabilities (see enumRFIDEvent)</td><td class="clsSyntaxCells clsEvenRow">Sets the RFMode of the currently selected antenna(e)</td><td class="clsSyntaxCells clsEvenRow">
N/A
@@ -147,10 +145,10 @@ N/A
</b></td><td class="clsSyntaxCells clsEvenRow">unsigned short integer</td><td class="clsSyntaxCells clsEvenRow">Sets the singulation tag population parameter</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>singulationInventoryState:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">INV_A,INV_B</td><td class="clsSyntaxCells clsOddRow">Indicates the inventory state [A or B] to be matched during the singulation.</td><td class="clsSyntaxCells clsOddRow">
+</b></td><td class="clsSyntaxCells clsOddRow">INV_A, INV_B</td><td class="clsSyntaxCells clsOddRow">Indicates the inventory state [A or B] to be matched during the singulation.</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>singulationSLFlag:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">SL_ASSERTED,SL_DEASSERTED</td><td class="clsSyntaxCells clsEvenRow">Indicates the SL bit [asserted or deasserted] to be matched during the singulation.</td><td class="clsSyntaxCells clsEvenRow">
+</b></td><td class="clsSyntaxCells clsEvenRow">SL_ASSERTED, SL_DEASSERTED</td><td class="clsSyntaxCells clsEvenRow">Indicates the SL bit [asserted or deasserted] to be matched during the singulation.</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>startTriggerType:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">immediate, triggerPress, triggerRelease, periodicStart</td><td class="clsSyntaxCells clsOddRow">Specifies the start triggers allowed for performInventory and tagLocate methods</td><td class="clsSyntaxCells clsOddRow">immediate</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>stopDuration:[Value]
@@ -170,7 +168,7 @@ N/A
</b></td><td class="clsSyntaxCells clsOddRow">hex kill password</td><td class="clsSyntaxCells clsOddRow">sets the password to use when calling the killTag method</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagMemBank:[Value]
-</b></td><td class="clsSyntaxCells clsEvenRow">Reserved,EPC,TID,User</td><td class="clsSyntaxCells clsEvenRow">sets the memory bank to access within the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow">EPC</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPassword:[Value]
+</b></td><td class="clsSyntaxCells clsEvenRow">Reserved, EPC, TID, User</td><td class="clsSyntaxCells clsEvenRow">sets the memory bank to access within the currently selected tag.</td><td class="clsSyntaxCells clsEvenRow">EPC</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPassword:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">hex password</td><td class="clsSyntaxCells clsOddRow">Sets the access password to use when accessing the currently selected tag.</td><td class="clsSyntaxCells clsOddRow">00000000</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagPatternAByteOffset:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">Offset from the start of the memory bank in bytes</td><td class="clsSyntaxCells clsEvenRow">Specifies the offset into the memory bank (position) </td><td class="clsSyntaxCells clsEvenRow">4</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPatternAHexMask:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">Hex Mask</td><td class="clsSyntaxCells clsOddRow">Specifies the mask for above pattern</td><td class="clsSyntaxCells clsOddRow">
@@ -179,15 +177,15 @@ N/A
</b></td><td class="clsSyntaxCells clsEvenRow">Hex Pattern</td><td class="clsSyntaxCells clsEvenRow">Specifies a hex pattern to be used for comparing memory bank data</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPatternAMemBank:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">Reserved,EPC,TID,User</td><td class="clsSyntaxCells clsOddRow">Specifies the memory bank for the tag pattern A</td><td class="clsSyntaxCells clsOddRow">EPC</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagPatternBByteOffset:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">Reserved, EPC, TID, User</td><td class="clsSyntaxCells clsOddRow">Specifies the memory bank for the tag pattern A</td><td class="clsSyntaxCells clsOddRow">EPC</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagPatternBByteOffset:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">Offset from the start of the memory bank in bytes</td><td class="clsSyntaxCells clsEvenRow">Specifies the offset into the memory bank (position) </td><td class="clsSyntaxCells clsEvenRow">4</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPatternBHexMask:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">Hex Mask</td><td class="clsSyntaxCells clsOddRow">Specifies the mask for above pattern</td><td class="clsSyntaxCells clsOddRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagPatternBHexPattern:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">Hex Pattern</td><td class="clsSyntaxCells clsEvenRow">Specifies a hex pattern to be used for comparing memory bank data</td><td class="clsSyntaxCells clsEvenRow">
N/A
</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagPatternBMemBank:[Value]
-</b></td><td class="clsSyntaxCells clsOddRow">Reserved,EPC,TID,User</td><td class="clsSyntaxCells clsOddRow">Specifies the memory bank for the tag pattern B</td><td class="clsSyntaxCells clsOddRow">EPC</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagReadSize:[Value]
+</b></td><td class="clsSyntaxCells clsOddRow">Reserved, EPC, TID, User</td><td class="clsSyntaxCells clsOddRow">Specifies the memory bank for the tag pattern B</td><td class="clsSyntaxCells clsOddRow">EPC</td></tr><tr><td class="clsSyntaxCells clsEvenRow"><b>tagReadSize:[Value]
</b></td><td class="clsSyntaxCells clsEvenRow">0 (all) - N bytes</td><td class="clsSyntaxCells clsEvenRow">sets the number of bytes to read in the tagRead method.</td><td class="clsSyntaxCells clsEvenRow">0 (all)</td></tr><tr><td class="clsSyntaxCells clsOddRow"><b>tagWriteData:[Value]
</b></td><td class="clsSyntaxCells clsOddRow">hex data</td><td class="clsSyntaxCells clsOddRow">sets the data to write in the tagWrite method</td><td class="clsSyntaxCells clsOddRow">
N/A
@@ -209,15 +207,15 @@ Enumerates the RFID readers present on the device (normally only one) along with
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>numberOfDevices</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">returns total number of device enumerated, returns always 1</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>readerID</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">ID assigned to reader</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">3</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>firmwareVersion</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Firmware version of the reader</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">4</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>modelName</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Model FX, MC</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">5</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>numberOfAntennas</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Antennas supported/connected by/to reader</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">6</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>numberOfPreFilters</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Total number of pre-filters available </td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">7</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>countryCode</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">region configured</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">8</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>communicationStandard</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">country/region frequency band standards</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">9</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>transmitPowerMin</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Minimum transmit power supported by reader 500dbm</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">10</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>transmitPowerMax</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Maximum transmit power supported by reader 3000dbm</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">11</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>transmitPowerStep</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Transmit power can be set in multiple of value - step</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">12</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>numberOfRFModes</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Number of supported RFModes</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">13</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>stateAwareSingulationSupported</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Indicates whether Inventory State Aware Singulation is supported by the Reader.</td></tr></table>
<br />
###rfParamsEvent
-Returns RF Parameter values- Transmit Power and RF Mode of a selected antenna
+Returns RF Parameter values - Transmit Power and RF Mode of a selected antenna
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>transmitPower</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">radiated power in db</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>RFMode</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">RF Mode Table Index</td></tr></table>
<br />
###rfModeInfoEvent
Returns the RF Characteristics for a particular RF Mode
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>modeIdentifier</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>divideRatio</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Refer to EPC-Global's definition</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">3</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>bdrValue</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">4</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>modulation</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Refer to EPC-Global's definition</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">5</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>forwardLinkModulationType</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">6</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>pieValue</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Refer to EPC-Global's definition</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">7</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>minTariValue</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">8</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>maxTariValue</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Refer to EPC-Global's definition</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">9</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>stepTariValue</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">10</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>spectralMaskIndicator</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Refer to EPC-Global's definition</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">11</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>epcHAGTCConformance</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Refer to EPC-Global's definition</td></tr></table>
<br />
###tagEvent
-Returns received RFID tag data from N tags,where N = reportTrigger. Typically methods like performInventory,tagLocate,readTag/writeTag/lockTag/killTag(performed on one or more tags) generate tagEvents with necessary data.
+Returns received RFID tag data from N tags, where N = reportTrigger. Typically methods like performInventory, tagLocate, readTag/writeTag/lockTag/killTag (performed on one or more tags) generate tagEvents with necessary data.
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>TagData (tagID, PC, tagSeenCount, memoryBankData, XPC, CRC, antennaID,
RSSI, accessStatus, relativeDistance, firstSeenTimeStamp)</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Tag data array with various parameter of read tag TagData[1..N] </td></tr></table>
<br />
@@ -240,22 +238,70 @@ Returns singulation values
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>singulationSession</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Indicates the session in which the antenna singulates</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>singulationTagPopulation</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Indicates the tag-population that the reader considers is in an antenna's field of view</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">3</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>performStateAwareSingulation</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Indicates whether the antennas perform stateAware-singulation.</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">4</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>singulationSLFlag</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Indicates which SL bit(asserted or deasserted) will be matched during singulation</td></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">5</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>singulationInventoryState</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Indicates which inventory state [A or B] will be matched during the singulation</td></tr></table>
<br />
###operationCompleteEvent
-Indicates the currently running operation(Inventory/Access/Locationing) is complete and there are no more tags to report.
+Indicates the currently running operation (Inventory/Access/Locationing) is complete and there are no more tags to report.
<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr></table>
<br />
###lastAccessResultEvent
Returns results of the last Access operation
-<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>tagsSucceeded</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Number of tags on which the access operation succeeded.</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>tagsFailed</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">umber of tags on which the access operation failed.</td></tr></table>
+<table class="re-table"><col width="3%" /><col width="20%" /><col width="77%" /><tr><th class="tableHeading">ID</th><th class="tableHeading">Name</th><th class="tableHeading">Description</th></tr><tr><td style="text-align:left;" class="clsSyntaxCells clsOddRow">1</td><td style="text-align:left;" class="clsSyntaxCells clsOddRow"><b>tagsSucceeded</b></td><td style="text-align:left;" class="clsSyntaxCells clsOddRow">Number of tags on which the access operation succeeded.</td></tr><tr><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">2</td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;"><b>tagsFailed</b></td><td class="clsSyntaxCells clsEvenRow" style="text-align:left;">Number of tags on which the access operation failed.</td></tr></table>
+##Remarks
+
+
+###Installation
+The RFID plugin package for RhoElements 2.2 SP1 must be downloaded separately from *** TODO - INCLUDE DOWNLOAD LINK *** and installed on the device. Please refer to the RFID plugin release notes for installation instructions.
+
+
+###General
+By default the plugin, when loaded, is already connected to RFID Module. In order to disconnect, one may use disconnect() method call on rfid object. After a successful disconnection, the connect() method may be used to make a new connection to the RFID Module. For a plugin method to be successfully invoked, all of its associated non-default properties must be successfully set prior to making the call.
+
+
+###Waiting for operationCompleteEvent
+When RhoElements finishes execution of a plugin method call, the corresponding RFID operation may not have been completed, rather it may have just been started. Specifically, for performInventory, tagLocate, tag access operations (readTag/writeTag/lockTag/killTag) using access-filter or performed on all tags, the corresponding method call just initiates the corresponding RFID operation. These operations generate Tag-reports, and once all the reports are completely sent to the application, the plugin sends a operationCompleteEvent. The disconnect() method also gives an operationCompleteEvent back to the application. It is important that the application register for operationCompleteEvent and further method calls will have to be made only after the reception of this event.
+
+
+###Handling the TagEvent
+TagEvent should be assigned to a Callback that handles the tag-reports arising out of Inventory/Locationing/Read/Write/Lock/Kill operations. Every tagEvent callback should usually result in JSON TagData Array object of length equalling to the reportTrigger property set. However, in the contingency that the RFID operation has ended and the plugin hasn't accumulated reportTrigger number of tagData objects, then the pending tags are all sent to the tagEvent callback.
+
+
+###Access Operation Status Codes
+For an access operation performed by using an access filter or an access operation performed on all tags, the status code only indicates that the operation has been successfully started. Setting enableTagAccessStatus to true generates Tag reports with the tagID and status of the access operation on the corresponding tagID. However, for a single tag access operation, the statusEvent indicates the result of the access operation for the given tagID.
+
+
+###Handling the operationCompleteEvent
+When RhoElements finishes execution of a plugin method call, the corresponding RFID operation may not have been completed, rather it may have just been started. Specifically, for performInventory, tagLocate, tag access operations (readTag/writeTag/lockTag/killTag) using access-filter or performed on all tags, the corresponding method call just initiates the corresponding RFID operation. These operations generate Tag-reports, and once all the reports are completely sent to the application, the plugin sends a operationCompleteEvent.
+
+
+###Plugin Busy
+The Plugin can perform only one RFID protocol operation (Inventory/Read/Write/Locate/Kill) at a time. Trying to invoke a new operation when an existing one is still running, will generate a "Plugin Busy" error. Irrespective whether stop method is called or not, the plugin is ready to initiate a new operation only after it sends the operationCompleteEvent. Trying to start a new operation before the event is received will return a "Plugin Busy error".
+
+
+###Deleting Prefilters
+Once a prefilter is added with a particular ID, the same ID should be used to reference it when deleting it.
+
+
+###Tag Locating
+Tag Locating can be performed only a particular antennaID.
+
+
+###Access Operations On All Visible Tags
+One can perform an access operation on all tags in the field of view by setting rfid.tagID to an empty string("")
+
+
+###Access Filters
+Access-filter can take up to tag-patterns. By default, match pattern used is Pattern-A alone and settings for tagPattern B are not considered unless specified by the appropriate matchPattern.
+
+
+
##Requirements
<table class="re-table"><tr><th class="tableHeading">RhoElements Version</th><td class="clsSyntaxCell clsEvenRow">2.2 SP1 - Additional Download Required or above
-</td></tr><tr><th class="tableHeading">Supported Devices</th><td class="clsSyntaxCell clsOddRow">All devices</td></tr><tr><th class="tableHeading">Minimum Requirements</th><td class="clsSyntaxCell clsOddRow">Hardware for reading RFID Tags</td></tr><tr><th class="tableHeading">Persistence</th><td class="clsSyntaxCell clsEvenRow">Not Persistent - Changes to this module will not persist when navigating to a new page.</td></tr></table>
+</td></tr><tr><th class="tableHeading">Supported Devices</th><td class="clsSyntaxCell clsOddRow">MC 3190Z, MC 9190Z</td></tr><tr><th class="tableHeading">Minimum Requirements</th><td class="clsSyntaxCell clsOddRow">Hardware for reading RFID Tags</td></tr><tr><th class="tableHeading">Persistence</th><td class="clsSyntaxCell clsEvenRow">Not Persistent - Changes to this module will not persist when navigating to a new page.</td></tr></table>
##HTML/Javascript Examples
@@ -274,7 +320,7 @@ This example starts an inventory using HTTP Meta Tags and tags are sent to a jav
</script>
-This example runs inventory as long as trigger button is pressed. By default,the plugin reports unique tags to tagEvent callback in JSON format and beeps for every unique tag encountered.By default, only one tagID is reported per the JSON tagReport. Besides,this JSON contains only the field tagID.
+This example runs inventory as long as trigger button is pressed. By default, the plugin reports unique tags to tagEvent callback in JSON format and beeps for every unique tag encountered. By default, only one tagID is reported per the JSON tagReport. Besides, this JSON contains only the field tagID.
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -309,7 +355,7 @@ This example runs inventory as long as trigger button is pressed. By default,the
</script>
-This example performs inventory with start and stop triggers configured.Here all the tag-reads are reported to tagEvent callback with 5 reports per callback. Besides,the tagSeenCount and the UTCTtimestamp at which tag was first seen is also reported.Note:It will still beep for only unique tags read.
+This example performs inventory with start and stop triggers configured. Here all the tag-reads are reported to tagEvent callback with 5 reports per callback. Besides, the tagSeenCount and the UTCTtimestamp at which tag was first seen is also reported. Note:It will still beep for only unique tags read.
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -328,7 +374,7 @@ This example performs inventory with start and stop triggers configured.Here all
rfid.performInventory();
}
- // Function to handle tagReports containing tagID,seenCount and firstSeenTimeStamp fields.
+ // Function to handle tagReports containing tagID, seenCount and firstSeenTimeStamp fields.
function TagHandlerAdvanced1(tagReportJSON)
{
objGeneric.Log("TagID :"+tagReportJSON.TagData[0].tagID+" Seen Count: "+tagReportJSON.TagData[0].tagSeenCount+" First seen Timestamp:"+tagReportJSON.TagData[0].firstSeenTimeStamp,3);
@@ -344,7 +390,7 @@ This example performs inventory with start and stop triggers configured.Here all
}
</script>
-This example performs inventory and reads the Reserved memory Bank of all tags inventoried.The tags are selected to match a particular pre-filter pattern(EPC starts with "9742") The tagEvent handler extracts both tagID and memoryBankData fields. Inventory is stopped after 10 tag-reads are observed
+This example performs inventory and reads the Reserved memory Bank of all tags inventoried. The tags are selected to match a particular pre-filter pattern (EPC starts with "9742") The tagEvent handler extracts both tagID and memoryBankData fields. Inventory is stopped after 10 tag-reads are observed
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -365,7 +411,7 @@ This example performs inventory and reads the Reserved memory Bank of all tags i
rfid.performInventory();
}
- // Function to handle tagReports containing tagID,seenCount and firstSeenTimeStamp fields.
+ // Function to handle tagReports containing tagID, seenCount and firstSeenTimeStamp fields.
function TagHandlerAdvanced2(tagReportJSON)
{
objGeneric.Log("TagID :"+tagReportJSON.TagData[0].tagID+" Reserved MemoryBank Data: "+tagReportJSON.TagData[0].memoryBankData,1);
@@ -475,7 +521,7 @@ This example performs TagLocationing operation and reports the real-time relativ
}
</script>
-This example performs Read operation on a particular tagID .
+This example performs Read operation on a particular tagID.
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -501,7 +547,7 @@ This example performs Read operation on a particular tagID .
}
</script>
-This example performs Read operation on all tags that match a particular tagPattern(access-filter).Reads User memory bank of all tags whose EPC start with "9742".
+This example performs Read operation on all tags that match a particular tagPattern(access-filter). Reads User memory bank of all tags whose EPC start with "9742".
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -541,7 +587,7 @@ This example performs Read operation on all tags that match a particular tagPatt
}
</script>
-This example shows the usage of State aware pre-filters and operationCompleteEvent.This function tries to search for a tag whose EPC starts with "56780000"
+This example shows the usage of State aware pre-filters and operationCompleteEvent. This function tries to search for a tag whose EPC starts with "56780000"
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
@@ -599,7 +645,7 @@ This example shows the usage of State aware pre-filters and operationCompleteEve
}
</script>
-This example shows the usage of getLastAccessResult method.At the completion of a multiple tag Write operation,the latter method is called to find out how many tags the operation succeeded and failed.
+This example shows the usage of getLastAccessResult method. At the completion of a multiple tag Write operation, the latter method is called to find out how many tags the operation succeeded and failed.
<script>
var objGeneric = new ActiveXObject("PocketBrowser.Generic");
View
2 indicators.rb
@@ -70,7 +70,7 @@ class Indicators
{"visible" => true, "category" => "", "version_supported" => "2.2", "api"=>"RawSensors", "file"=>"/rhoelements/RawSensors/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"true", "rhoe"=>true, "rhodes"=>false, "msionly"=>false,"ios" => true,"android"=>true,"wm"=>false,"wince"=>false,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
{"visible" => true, "category" => "", "version_supported" => "1.0", "api"=>"Registry", "file"=>"/rhoelements/registry/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"lic", "rhoe"=>true, "rhodes"=>false, "msionly"=>true,"ios" => false,"android"=>false,"wm"=>true,"wince"=>true,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
{"visible" => true, "category" => "", "version_supported" => "1.0", "api"=>"Reload Button", "file"=>"/rhoelements/reloadbutton/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"lic", "rhoe"=>true, "rhodes"=>false, "msionly"=>true,"ios" => false,"android"=>true,"wm"=>true,"wince"=>true,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
-{"visible" => false, "category" => "", "version_supported" => "2.2", "api"=>"Rfid", "file"=>"/rhoelements/rfid/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"lic", "rhoe"=>true, "rhodes"=>false, "msionly"=>true,"ios" => false,"android"=>false,"wm"=>true,"wince"=>true,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
+{"visible" => true, "category" => "", "version_supported" => "2.2 SP1", "api"=>"Rfid", "file"=>"/rhoelements/rfid/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"lic", "rhoe"=>true, "rhodes"=>false, "msionly"=>true,"ios" => false,"android"=>false,"wm"=>true,"wince"=>true,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
{"visible" => true, "category" => "", "version_supported" => "1.0", "api"=>"Reboot", "file"=>"/rhoelements/reboot/", "description"=>"", "html"=>"lic", "js"=>"lic", "ruby"=>"lic", "rhoe"=>true, "rhodes"=>false, "msionly"=>true,"ios" => false,"android"=>false,"wm"=>true,"wince"=>true,"win32"=>false,"win7"=>false,"bb"=>false,"rhosim"=>false},
{"visible" => true, "category" => "", "version_supported" => "2.0", "api"=>"RhoApplication", "file"=>"/rhodesapi/rhoapplication-api/", "description"=>"", "html"=>"false", "js"=>"lic", "ruby"=>"true", "rhoe"=>true, "rhodes"=>true, "msionly"=>false,"ios" => true,"android"=>true,"wm"=>true,"wince"=>true,"win32"=>true,"win7"=>true,"bb"=>true,"rhosim"=>true},
View
1 toc.rb
@@ -132,6 +132,7 @@
topic 'rhoelements/registry', 'Registry'
topic 'rhoelements/reloadbutton', 'ReloadButton'
topic 'rhoelements/reboot', 'Reboot'
+ topic 'rhoelements/rfid', 'Rfid'
topic 'rhodesapi/rhoapplication-api', 'RhoApplication'
topic 'rhodesapi/rhoconfig-api', 'RhoConfig'
topic 'rhodesapi/rhocontact-api', 'RhoContact'

0 comments on commit c75cfb2

Please sign in to comment.