Eclipse.org Eclipse.org RfidInventoryProfile org.eclipse.soda.dk.rfid.inventory

external RfidInventoryProfile External

Provider Eclipse.org
Vendors IBM
Version 1.2.0
Specification title EPCglobal Low Level Reader Protocol (LLRP)
Specification URL http://www.epcglobalinc.org/standards/llrp
Specification version 1.0.1
Specification data August 13, 2007
Specification vendor EPCglobal
Specification comment Ratified
Specification title EPCglobal Application Level Events (ALE) Specification
Specification URL http://www.epcglobalinc.org/standards/ale/
Specification version 1.1
Specification data February 27, 2008
Specification vendor EPCglobal
Specification comment Ratified

The RFID Inventory Profile controls Radio Frequency Identification (RFID) tag reading, tag filtering, and aggregation reporting. This profile supports starting and stopping the reading mode, providing tag data in a common format, filtering tags as duplicates or by interest masks, collecting tags into an aggregation report, and marking tag reports with meta data called data extensions. The RfidInventoryProfile can be configured to trigger reading, filtering, and aggregating behavior based on events published by the GpioProfile and ControlProfile. While the main focus of this profile is RFID related devices, this profile can also be implemented by other kinds of devices with "tag"s. For example, Bar Code Readers can implement this profile.

Aggregation filter expression (RfidInventory/AggregationFilterExpression) String

The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "AggregationMaskSetting" and the result of the LDAP expression is true, then the tag will be reported in the "TagAggregationReport". If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Aggregation final filter expression (RfidInventory/AggregationFinalFilterExpression) String

The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". Before the "TagAggregationReport" is published, this LDAP filter will be applied to all tags in the current tag aggregation. If the result of the LDAP filter is true, then the tag will be included in the report. If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.

Aggregation mask setting (RfidInventory/AggregationMaskSetting) String

The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a place holder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is themask value specified as a hex string with each byte (two characters) separated by a blank.It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semicolon.

Antenna count (RfidInventory/AntennaCount) Integer

The "AntennaCount" is maximum number of antennas supported by this reader.

Confidence script (RfidInventory/ConfidenceScript) Integer

The "ConfidenceScript" is script to compute the "confidence" value.

Data extensions (RfidInventory/DataExtensions) Map

The DataExtensions measurement is a map of meta data to be associated with tag data. Data extensions are applied to TagReport data as the signal is published. Data extensions are applied to a TagAggregationReport at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current DataExtensions value. Setting the value of the measurement to an empty map clears the value.

Duplicate filtering (RfidInventory/DuplicateFiltering) Boolean

The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior. When the measurement value is true, the profile signals only the initial report of each tag read during the filtering cycle. When the measurement value is updated to false, the profile clears the cache of tags it has seen during the filtering cycle. While the measurement value is false, the profile does not filter out duplicate tags or cache incoming tags. If an LDAP expression is specified for the DuplicateFilteringExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Duplicate filtering expression (RfidInventory/DuplicateFilteringExpression) String

The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.

Read operations (RfidInventory/ReadOperations) String

The ReadOperations specifies the definition of read operations block against the tag(s). A read operation block can contain multiple read operations separated by the character ",". A read operation is specified by parameters based on the operation, the parameters are separated by the character ";". The first parameter specifies the kind of read operation. <ul > </li> <li>Operation Read: Defines the read operation on the specified memory bank on the tags. Format: Read;MemoryBank;Pointer;WordCount;Password;OpCount;Timeout[;OperationId] <ol> <li> Read: Reserved name for the read operation. </li> <li> MemoryBank: An integer to specify the memory bank to read from. </li> <li> Pointer: The first location (zero based) in the memory bank to start the read operation. </li> <li> Password: The password for the read operation. </li> <li> OpCount: An integer to specify the times this read operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the read operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the read operation. </li> </ol> </li> </ul>

Read operations count (RfidInventory/ReadOperationsCount) Integer

The ReadOperationsCount measurement defines the number of read operations supported by this profile.

Super cache maximum size (RfidInventory/SuperCacheMaximumSize) Integer

The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size. A zero value means that the super cache will not be used.

Tag aggregating (RfidInventory/TagAggregating) Boolean

The "TagAggregating" measurement specifies the state of aggregating behavior. When the measurement value is true, the profile is collecting all tags which pass the Aggregation Mask. When the measurement value is updated to false, the profile publishes the TagAggregationReport signal, clears the aggregation cache, and stops collecting incoming tags. If an LDAP expression is specified for the TagAggregatingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Tag aggregating expression (RfidInventory/TagAggregatingExpression) String

The "TagAggregatingExpression" is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.

Tag aggregation report (RfidInventory/TagAggregationReport) Map

The "TagAggregationReport" is a signal containing a collection of tag data in a map structure. The report can contain zero to many tags stored at the "tags" key. It may include data extension meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

confidence The value stored at the "confidence" key of the read-event map is the optional confidence value. The higher the confidence value the more likely the tag was meant to be included in the aggregation. If the confidence is zero, then we are unsure if the tag should be included. If the confidence is less than zero, it is unlikely that the tag should be included. The more negative the confidence value, then less likely the tag should be included.

Tag antenna report level (RfidInventory/TagAntennaReportLevel) Integer

The TagAntennaReportLevel measurement specifies the level of tag antenna reporting. The higher the value, the more tag antenna information is reported in tag data on the "TagReport" and "TagAggregationReport" signals but the extra processing is required which may effect performance.

Tag filter expression (RfidInventory/TagFilterExpression) String

The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "TagMaskSetting" and the results of the LDAP expression is true, then the tag will be reported in the "TagReport".

Tag mask setting (RfidInventory/TagMaskSetting) String

The "TagMaskSetting" specifies the definition of tags that should be published on the "TagReport" signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a place holder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is themask value specified as a hex string with each byte (two characters) separated by a blank.It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semicolon.

Tag position (RfidInventory/TagPosition) Map

The "TagPosition" measurement is a map of meta data to be associated with tag data. "TagPosition" extensions are applied to "TagReport" data as the signal is published. "TagPosition" are applied to a "TagAggregationReport" at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current "TagPosition" value. Setting the value of the measurement to an empty map clears the value.

Tag reading (RfidInventory/TagReading) Boolean

The "TagReading" measurement specifies the state of reading behavior. When the measurement is true, the reader is reading tags in autonomous mode and the profile reports tag data on the TagReport signal. When the measurement is false, the reader's autonomous mode is not enabled and any unexpected tag data reported by the reader is published on the TagReport error signal. If an LDAP expression is specified for the TagReadingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.

Tag reading expression (RfidInventory/TagReadingExpression) String

The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.

Tag report (RfidInventory/TagReport) Map

The "TagReport" is a signal containing tag data in a map structure. The report contains one to many tags stored at the "tags" key. It may include data extension meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.

accessPwd The value stored at the "accessPwd" key of the read-event map is the optional access password value.
afi The value stored at the "afi" key of the read-event map is the optional ISO Application Family Identifier (AFI) value.
antenna The value stored at the "antenna" key of the read-event map is the antenna value, based on a starting index of 1. It is included in the read-event map if the reader is configured to report which antenna read the tag.
antenna1 The value stored at the "antenna1" key of the read-event map is the antenna 1 optional information.
antenna2 The value stored at the "antenna2" key of the read-event map is the antenna 2 optional information.
antenna3 The value stored at the "antenna3" key of the read-event map is the antenna 3 optional information.
antenna4 The value stored at the "antenna4" key of the read-event map is the antenna 4 optional information.
antennaReportCount The value stored at the "antennaReportCount" key of the read-event map is the count of how many antenna reported information reporting cycle.
antennasMap The value stored at the "antennasMap" key is map containing information about each antenna.
battery The value stored at the "battery" key of the read-event map is the optional battery information.
New batteryChargeLevel The value stored at the "batteryChargeLevel" key of the "battery" map is the optional battery charge level information. The value is a percent of the charge level with 0 being no charge and 1.0 being charge level full.
New batteryRemainingCapacity The value stored at the "batteryRemainingCapacity" key of the "battery" map is the optional battery remaining capacity information.
New batteryRemainingTime The value stored at the "batteryRemainingTime" key of the "battery" map is the optional battery remaining time information.
C1G2CRC The value stored at the "llrpC1G2CRC" key of the llrpAirProtocolTagData map is the CRC value of the tag.[Optional]
C1G2PC The value stored at the "llrpC1G2PC" key of the llrpAirProtocolTagData map is the PC Bits value of the tag.[Optional]
channelIndex The value stored at the "channelIndex" key of the read-event map is the index of the channel the tag was seen. [Optional]
count The value stored at the "count" key of the read-event map is the number of times this tag was read during the reporting cycle.
countAverage The value stored at the "countAverage" key is the count of all tag reads divided by the tag count.
dataExtensions The value stored at the "dataExtensions" key of the TagReport or read-event map is a nested map of meta data as specified in the DataExtensions measurement.
duration The value stored at the "duration" key of the read-event map is the last timestamp minus the initial timestamp that this tag was read during the reporting cycle.
epcBank The value stored at the "epcBank" key of the read-event map is the optional epc bank value.
epcURI The value stored at the "epcURI" key of the read-event map is the optional EPC URI value.
key The value stored at the "key" key of the read-event map is the key used in the map. Currently, this value is only available when using the LDAP expressions.
killPwd The value stored at the "killPwd" key of the read-event map is the optional kill password value.
llrpAccessSpecId The value stored at the "llrpAccessSpecId" key of the read-event map is the AccessSpecId related to the LLRP tag report. [Optional]
llrpAirProtocolTagData The value stored at the "llrpAirProtocolTagData" key of the read-event map is nested map which contains the air protocol tag data such as C1G2EPC-PC and C1G2EPC-CRC for C1G2, keyed by the tag data name.[Optional]
llrpInventoryParameterSpecId The value stored at the "llrpInventoryParameterSpecId" key of the read-event map is the InventoryParameterSpecId related to the LLRP tag report. [Optional]
llrpOpSpecNumWordsWritten The value stored at the "llrpOpSpecNumWordsWritten" key of the llrpOpSpecResult map is the number of the words written by the air opSpec.[Optional]
llrpOpSpecReadData The value stored at the "llrpOpSpecReadData" key of the llrpOpSpecResult map is the data read by the air opSpec.[Optional]
llrpOpSpecResult The value stored at the "llrpOpSpecResult" key of the read-event map is nested map which contains the results of air protocol OpSpecs such as C1G2, keyed by OpSpecID[Optional]
llrpOpSpecResultCode The value stored at the "llrpOpSpecResultCode" key of the llrpOpSpecResult map is the result code of the air opSpec.[Optional]
llrpROSpecId The value stored at the "llrpROSpecId" key of the read-event map is the ROSpecId related to the LLRP tag report. [Optional]
llrpSpecIndex The value stored at the "llrpSpecIndex" key of the read-event map indicates the item within ROSpec that is related to the LLRP tag report. [Optional]
nsi The value stored at the "nsi" key of the read-event map is the optional Numbering System Identifier (NSI) bank value.
ParameterSubtype The value stored at the "ParameterSubtype" key of customParameter map is the SubType in the custom parameter.
peakRSSI The value stored at the "peakRSSI" key of the read-event map is the peak received power of the EPC backscatter in dBM. See the "PeakRSSI Parameter" section of the LLRP Specification. [Optional]
peakRSSIAverage The value stored at the "peakRSSIAverage" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMaximum The value stored at the "peakRSSIMaximum" key of the read-event map is the maximum peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMaximumAverage The value stored at the "peakRSSIMaximumAverage" key of the read-event map is the maximum peak average received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMaximumMedian The value stored at the "peakRSSIMaximumMedian" key of the read-event map is the maximum peak received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMaximumStandardDeviation The value stored at the "peakRSSIMaximumStandardDeviation" key of the read-event map is the maximum peak standard deviation. [Optional]
peakRSSIMaximumStandardScore The value stored at the "peakRSSIMaximumStandardScore" key of the read-event map is the maximum peak standard score (z-score). [Optional]
peakRSSIMinimum The value stored at the "peakRSSIMinimum" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMinimumAverage The value stored at the "peakRSSIMinimumAverage" key of the read-event map is the minimum peak average received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMinimumMedian The value stored at the "peakRSSIMinimumMedian" key of the read-event map is the peak received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMinimumStandardDeviation The value stored at the "peakRSSIMinimumStandardDeviation" key of the read-event map is the minimum peak standard deviation. [Optional]
peakRSSIMinimumStandardScore The value stored at the "peakRSSIMinimumStandardScore" key of the read-event map is the minimum peak standard score (z-score). [Optional]
peakRSSIRange The value stored at the "peakRSSIRange" key of the read-event map is maximum minus minimum the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSITotal The value stored at the "peakRSSITotal" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
position The value stored at the "position" key of the TagReport or read-event map is a nested map of meta data as specified in the "TagPositon" measurement.
reader The value stored at the "reader" key of the read-event map is the ID property configured for this instance of the inventory profile.
readersMap The value stored at the "readersMap" key is map containing information about each reader.
reportsMap The value stored at the "reportsMap" key is map containing information about each reader report.
New subCycleNum If the tagReadingSubCycleMode is not "null", the value stores the sub cycle number the tag is read.
summary The value stored at the "summary" key of the TagReport is a map which contains the summary information about the tags.
tagCount The value stored at the "tagCount" key is the count of tags included in the report.
tagType The value stored at the "tagType" key of the read-event map is the optional tag type value. If the tag type is an RFID Tag, then the value should start with "rfid". if the tag type is a barcode, then the value should start with a "barcode".
tags The value stored at the "tags" key of the TagReport is a nested map which contains tag data, keyed by tag ID string. Each tag ID is the index for a nested map structure containing details about the read-events for that tag. The event data map may include the keys "antenna", "count", "reader", "timestampFirst", "timestampLast", and "dataExtensions".
tid The value stored at the "tid" key of the read-event map is the TID of the tag.
tidBank The value stored at the "tidBank" key of the read-event map is the optional TID bank value.
timestampFirst The value stored at the "timestampFirst" key of the read-event map is the initial timestamp that this tag was read during the reporting cycle.
timestampFirstUptime The value stored at the "timestampFirst" key of the read-event map is the initial uptime timestamp that this tag was read during the reporting cycle.[Optional]
timestampLast The value stored at the "timestampLast" key of the read-event map is the final timestamp that this tag was read during the reporting cycle.
timestampLastUptime The value stored at the "timestampLast" key of the read-event map is the last uptime timestamp that this tag was read during the reporting cycle.[Optional]
New totalSubCycles If the tagReadingSubCycleMode is not "null", the value stores the total sub cycle numbers.
userBank The value stored at the "userBank" key of the read-event map is the optional user bank value.
userdata The value stored at the "userdata" key of the read-event map is the user data of the tag.
vendorExtensions The value stored at the "vendorExtensions" key of the read-event map is the List of custom parameters. The value of each element is a Map with keys "VendorIdentifier", "ParameterSubtype" and "VendorParameterValue".
VendorIdentifier The value stored at the "VendorIdentifier" key of customParameter map is the Vendor ID in the custom parameter.
VendorParameterValue The value stored at the "VendorParameterValue" key of customParameter map is the VendorParameter Value in the custom parameter.
External Key Data Units Description
Aggregation filter expression String The optional AggregationFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "AggregationMaskSetting" and the result of the LDAP expression is true, then the tag will be reported in the "TagAggregationReport". If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.
prefix/RfidInventory/AggregationFilterExpression String
prefix/RfidInventory/AggregationFilterExpression/ get
prefix/RfidInventory/AggregationFilterExpression/ read
prefix/RfidInventory/AggregationFilterExpression/ write String
prefix/RfidInventory/AggregationFilterExpression/ error
Aggregation final filter expression String The optional AggregationFinalFilterExpression specifies the definition of tags that should be published on the "TagAggregationReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". Before the "TagAggregationReport" is published, this LDAP filter will be applied to all tags in the current tag aggregation. If the result of the LDAP filter is true, then the tag will be included in the report. If the filtering can be done by the "AggregationMaskSetting", then this would be better than using this LDAP filter.
prefix/RfidInventory/AggregationFinalFilterExpression String
prefix/RfidInventory/AggregationFinalFilterExpression/ get
prefix/RfidInventory/AggregationFinalFilterExpression/ read
prefix/RfidInventory/AggregationFinalFilterExpression/ write String
prefix/RfidInventory/AggregationFinalFilterExpression/ error
Aggregation mask setting String The AggregationMaskSetting specifies the definition of tags that should be published on the TagAggregationReport signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a place holder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value specified as a hex string with each byte (two characters) separated by a blank. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semicolon.
prefix/RfidInventory/AggregationMaskSetting String
prefix/RfidInventory/AggregationMaskSetting/ get
prefix/RfidInventory/AggregationMaskSetting/ read
prefix/RfidInventory/AggregationMaskSetting/ write String
prefix/RfidInventory/AggregationMaskSetting/ error
Antenna count Integer The "AntennaCount" is maximum number of antennas supported by this reader.
prefix/RfidInventory/AntennaCount Integer
prefix/RfidInventory/AntennaCount/ get
prefix/RfidInventory/AntennaCount/ read
prefix/RfidInventory/AntennaCount/ write Integer
prefix/RfidInventory/AntennaCount/ error
Confidence script Integer The "ConfidenceScript" is script to compute the "confidence" value.
prefix/RfidInventory/ConfidenceScript Integer
prefix/RfidInventory/ConfidenceScript/ get
prefix/RfidInventory/ConfidenceScript/ read
prefix/RfidInventory/ConfidenceScript/ write Integer
prefix/RfidInventory/ConfidenceScript/ error
Data extensions Map The DataExtensions measurement is a map of meta data to be associated with tag data. Data extensions are applied to TagReport data as the signal is published. Data extensions are applied to a TagAggregationReport at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current DataExtensions value. Setting the value of the measurement to an empty map clears the value.
prefix/RfidInventory/DataExtensions Map
prefix/RfidInventory/DataExtensions/ get
prefix/RfidInventory/DataExtensions/ read
prefix/RfidInventory/DataExtensions/ write Map
prefix/RfidInventory/DataExtensions/ error
Duplicate filtering Boolean The DuplicateFiltering measurement specifies the state of duplicate tag filtering behavior. When the measurement value is true, the profile signals only the initial report of each tag read during the filtering cycle. When the measurement value is updated to false, the profile clears the cache of tags it has seen during the filtering cycle. While the measurement value is false, the profile does not filter out duplicate tags or cache incoming tags. If an LDAP expression is specified for the DuplicateFilteringExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.
prefix/RfidInventory/DuplicateFiltering Boolean
prefix/RfidInventory/DuplicateFiltering/ get
prefix/RfidInventory/DuplicateFiltering/ read
prefix/RfidInventory/DuplicateFiltering/ write Boolean
prefix/RfidInventory/DuplicateFiltering/ error
Duplicate filtering expression String The DuplicateFilteringExpression is an LDAP expression to trigger the behavior of duplicate tag filtering based on input pin and control values.
prefix/RfidInventory/DuplicateFilteringExpression String
prefix/RfidInventory/DuplicateFilteringExpression/ get
prefix/RfidInventory/DuplicateFilteringExpression/ read
prefix/RfidInventory/DuplicateFilteringExpression/ write String
prefix/RfidInventory/DuplicateFilteringExpression/ error
Read operations String The ReadOperations specifies the definition of read operations block against the tag(s). A read operation block can contain multiple read operations separated by the character ",". A read operation is specified by parameters based on the operation, the parameters are separated by the character ";". The first parameter specifies the kind of read operation. <ul > </li> <li>Operation Read: Defines the read operation on the specified memory bank on the tags. Format: Read;MemoryBank;Pointer;WordCount;Password;OpCount;Timeout[;OperationId] <ol> <li> Read: Reserved name for the read operation. </li> <li> MemoryBank: An integer to specify the memory bank to read from. </li> <li> Pointer: The first location (zero based) in the memory bank to start the read operation. </li> <li> Password: The password for the read operation. </li> <li> OpCount: An integer to specify the times this read operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the read operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the read operation. </li> </ol> </li> </ul>
prefix/RfidInventory/ReadOperations String
prefix/RfidInventory/ReadOperations/ get
prefix/RfidInventory/ReadOperations/ read
prefix/RfidInventory/ReadOperations/ write String
prefix/RfidInventory/ReadOperations/ error
Read operations count Integer The ReadOperationsCount measurement defines the number of read operations supported by this profile.
prefix/RfidInventory/ReadOperationsCount Integer
prefix/RfidInventory/ReadOperationsCount/ get
prefix/RfidInventory/ReadOperationsCount/ read
prefix/RfidInventory/ReadOperationsCount/ write Integer
prefix/RfidInventory/ReadOperationsCount/ error
Super cache maximum size Integer The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size. A zero value means that the super cache will not be used.
prefix/RfidInventory/SuperCacheMaximumSize Integer
prefix/RfidInventory/SuperCacheMaximumSize/ get
prefix/RfidInventory/SuperCacheMaximumSize/ read
prefix/RfidInventory/SuperCacheMaximumSize/ write Integer
prefix/RfidInventory/SuperCacheMaximumSize/ error
Tag aggregating Boolean The "TagAggregating" measurement specifies the state of aggregating behavior. When the measurement value is true, the profile is collecting all tags which pass the Aggregation Mask. When the measurement value is updated to false, the profile publishes the TagAggregationReport signal, clears the aggregation cache, and stops collecting incoming tags. If an LDAP expression is specified for the TagAggregatingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.
prefix/RfidInventory/TagAggregating Boolean
prefix/RfidInventory/TagAggregating/ get
prefix/RfidInventory/TagAggregating/ read
prefix/RfidInventory/TagAggregating/ write Boolean
prefix/RfidInventory/TagAggregating/ error
Tag aggregating expression String The "TagAggregatingExpression" is an LDAP expression to trigger the behavior of aggregating based on input pin and control values.
prefix/RfidInventory/TagAggregatingExpression String
prefix/RfidInventory/TagAggregatingExpression/ get
prefix/RfidInventory/TagAggregatingExpression/ read
prefix/RfidInventory/TagAggregatingExpression/ write String
prefix/RfidInventory/TagAggregatingExpression/ error
Tag aggregation report Map The "TagAggregationReport" is a signal containing a collection of tag data in a map structure. The report can contain zero to many tags stored at the "tags" key. It may include data extension meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.
prefix/RfidInventory/TagAggregationReport Map
prefix/RfidInventory/TagAggregationReport/ trigger Map
prefix/RfidInventory/TagAggregationReport/ error
Tag antenna report level Integer The TagAntennaReportLevel measurement specifies the level of tag antenna reporting. The higher the value, the more tag antenna information is reported in tag data on the "TagReport" and "TagAggregationReport" signals but the extra processing is required which may effect performance.
prefix/RfidInventory/TagAntennaReportLevel Integer
prefix/RfidInventory/TagAntennaReportLevel/ get
prefix/RfidInventory/TagAntennaReportLevel/ read
prefix/RfidInventory/TagAntennaReportLevel/ write Integer
prefix/RfidInventory/TagAntennaReportLevel/ error
Tag filter expression String The optional TagFilterExpression specifies the definition of tags that should be published on the "TagReport" signal. The filter expression is an LDAP expression. The keys in the LDAP expression are the keys defined in the "TagReport". If the tag passes the "TagMaskSetting" and the results of the LDAP expression is true, then the tag will be reported in the "TagReport".
prefix/RfidInventory/TagFilterExpression String
prefix/RfidInventory/TagFilterExpression/ get
prefix/RfidInventory/TagFilterExpression/ read
prefix/RfidInventory/TagFilterExpression/ write String
prefix/RfidInventory/TagFilterExpression/ error
Tag mask setting String The "TagMaskSetting" specifies the definition of tags that should be published on the "TagReport" signal. A mask is specified by four comma-delimited parameters. The first parameter of a tag mask is a place holder for future use, and the value is ignored. The second parameter is the pointer value. It is the first bit location of the tag id against which to compare the mask. The third parameter is the length. It specifies the number of bits of the tag id to compare against the mask. The final parameter is the mask value specified as a hex string with each byte (two characters) separated by a blank. It is the pattern against which the specified section of the tag id must match to pass the filter. Multiple masks can be specified by separating them with a semicolon.
prefix/RfidInventory/TagMaskSetting String
prefix/RfidInventory/TagMaskSetting/ get
prefix/RfidInventory/TagMaskSetting/ read
prefix/RfidInventory/TagMaskSetting/ write String
prefix/RfidInventory/TagMaskSetting/ error
Tag position Map The "TagPosition" measurement is a map of meta data to be associated with tag data. "TagPosition" extensions are applied to "TagReport" data as the signal is published. "TagPosition" are applied to a "TagAggregationReport" at the beginning and end of the aggregation cycle. Writing a value to this measurement merges the new map with the current "TagPosition" value. Setting the value of the measurement to an empty map clears the value.
prefix/RfidInventory/TagPosition Map
prefix/RfidInventory/TagPosition/ get
prefix/RfidInventory/TagPosition/ read
prefix/RfidInventory/TagPosition/ write Map
prefix/RfidInventory/TagPosition/ error
Tag reading Boolean The "TagReading" measurement specifies the state of reading behavior. When the measurement is true, the reader is reading tags in autonomous mode and the profile reports tag data on the TagReport signal. When the measurement is false, the reader's autonomous mode is not enabled and any unexpected tag data reported by the reader is published on the TagReport error signal. If an LDAP expression is specified for the TagReadingExpression, a publication to write a value to this measurement will result in an exception and will not update the measurement value.
prefix/RfidInventory/TagReading Boolean
prefix/RfidInventory/TagReading/ get
prefix/RfidInventory/TagReading/ read
prefix/RfidInventory/TagReading/ write Boolean
prefix/RfidInventory/TagReading/ error
Tag reading expression String The "TagReadingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the state of tag reading based on input pin and control values.
prefix/RfidInventory/TagReadingExpression String
prefix/RfidInventory/TagReadingExpression/ get
prefix/RfidInventory/TagReadingExpression/ read
prefix/RfidInventory/TagReadingExpression/ write String
prefix/RfidInventory/TagReadingExpression/ error
Tag report Map The "TagReport" is a signal containing tag data in a map structure. The report contains one to many tags stored at the "tags" key. It may include data extension meta data stored at the "dataExtensions" key. See the tags and dataExtensions descriptions for details.
prefix/RfidInventory/TagReport Map
prefix/RfidInventory/TagReport/ trigger Map
prefix/RfidInventory/TagReport/ error
External Key Data Units Description
accessPwd string (String) The value stored at the "accessPwd" key of the read-event map is the optional access password value.
afi unsigned int (Number) The value stored at the "afi" key of the read-event map is the optional ISO Application Family Identifier (AFI) value.
antenna long (Number) The value stored at the "antenna" key of the read-event map is the antenna value, based on a starting index of 1. It is included in the read-event map if the reader is configured to report which antenna read the tag.
antenna1 Map The value stored at the "antenna1" key of the read-event map is the antenna 1 optional information.
antenna2 Map The value stored at the "antenna2" key of the read-event map is the antenna 2 optional information.
antenna3 Map The value stored at the "antenna3" key of the read-event map is the antenna 3 optional information.
antenna4 Map The value stored at the "antenna4" key of the read-event map is the antenna 4 optional information.
antennaReportCount long (Number) The value stored at the "antennaReportCount" key of the read-event map is the count of how many antenna reported information reporting cycle.
antennasMap Map The value stored at the "antennasMap" key is map containing information about each antenna.
battery Map The value stored at the "battery" key of the read-event map is the optional battery information.
New batteryChargeLevel float (Number) The value stored at the "batteryChargeLevel" key of the "battery" map is the optional battery charge level information. The value is a percent of the charge level with 0 being no charge and 1.0 being charge level full.
New batteryRemainingCapacity long (Number) The value stored at the "batteryRemainingCapacity" key of the "battery" map is the optional battery remaining capacity information.
New batteryRemainingTime long (Number) milliseconds The value stored at the "batteryRemainingTime" key of the "battery" map is the optional battery remaining time information.
C1G2CRC long (Number) The value stored at the "llrpC1G2CRC" key of the llrpAirProtocolTagData map is the CRC value of the tag.[Optional]
C1G2PC long (Number) The value stored at the "llrpC1G2PC" key of the llrpAirProtocolTagData map is the PC Bits value of the tag.[Optional]
channelIndex long (Number) The value stored at the "channelIndex" key of the read-event map is the index of the channel the tag was seen. [Optional]
count long (Number) The value stored at the "count" key of the read-event map is the number of times this tag was read during the reporting cycle.
countAverage int (Number) The value stored at the "countAverage" key is the count of all tag reads divided by the tag count.
dataExtensions Map The value stored at the "dataExtensions" key of the TagReport or read-event map is a nested map of meta data as specified in the DataExtensions measurement.
duration long (Number) milliseconds The value stored at the "duration" key of the read-event map is the last timestamp minus the initial timestamp that this tag was read during the reporting cycle.
epcBank byte[] The value stored at the "epcBank" key of the read-event map is the optional epc bank value.
epcURI string (String) The value stored at the "epcURI" key of the read-event map is the optional EPC URI value.
key string (String) The value stored at the "key" key of the read-event map is the key used in the map. Currently, this value is only available when using the LDAP expressions.
killPwd string (String) The value stored at the "killPwd" key of the read-event map is the optional kill password value.
llrpAccessSpecId long (Number) The value stored at the "llrpAccessSpecId" key of the read-event map is the AccessSpecId related to the LLRP tag report. [Optional]
llrpAirProtocolTagData string (String) The value stored at the "llrpAirProtocolTagData" key of the read-event map is nested map which contains the air protocol tag data such as C1G2EPC-PC and C1G2EPC-CRC for C1G2, keyed by the tag data name.[Optional]
llrpInventoryParameterSpecId long (Number) The value stored at the "llrpInventoryParameterSpecId" key of the read-event map is the InventoryParameterSpecId related to the LLRP tag report. [Optional]
llrpOpSpecNumWordsWritten byte[] The value stored at the "llrpOpSpecNumWordsWritten" key of the llrpOpSpecResult map is the number of the words written by the air opSpec.[Optional]
llrpOpSpecReadData byte[] The value stored at the "llrpOpSpecReadData" key of the llrpOpSpecResult map is the data read by the air opSpec.[Optional]
llrpOpSpecResult string (String) The value stored at the "llrpOpSpecResult" key of the read-event map is nested map which contains the results of air protocol OpSpecs such as C1G2, keyed by OpSpecID[Optional]
llrpOpSpecResultCode long (Number) The value stored at the "llrpOpSpecResultCode" key of the llrpOpSpecResult map is the result code of the air opSpec.[Optional]
llrpROSpecId long (Number) The value stored at the "llrpROSpecId" key of the read-event map is the ROSpecId related to the LLRP tag report. [Optional]
llrpSpecIndex long (Number) The value stored at the "llrpSpecIndex" key of the read-event map indicates the item within ROSpec that is related to the LLRP tag report. [Optional]
nsi unsigned int (Number) The value stored at the "nsi" key of the read-event map is the optional Numbering System Identifier (NSI) bank value.
ParameterSubtype int (Number) The value stored at the "ParameterSubtype" key of customParameter map is the SubType in the custom parameter.
peakRSSI long (Number) The value stored at the "peakRSSI" key of the read-event map is the peak received power of the EPC backscatter in dBM. See the "PeakRSSI Parameter" section of the LLRP Specification. [Optional]
peakRSSIAverage float (Number) The value stored at the "peakRSSIAverage" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMaximum long (Number) The value stored at the "peakRSSIMaximum" key of the read-event map is the maximum peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMaximumAverage long (Number) The value stored at the "peakRSSIMaximumAverage" key of the read-event map is the maximum peak average received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMaximumMedian long (Number) The value stored at the "peakRSSIMaximumMedian" key of the read-event map is the maximum peak received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMaximumStandardDeviation float (Number) The value stored at the "peakRSSIMaximumStandardDeviation" key of the read-event map is the maximum peak standard deviation. [Optional]
peakRSSIMaximumStandardScore float (Number) The value stored at the "peakRSSIMaximumStandardScore" key of the read-event map is the maximum peak standard score (z-score). [Optional]
peakRSSIMinimum long (Number) The value stored at the "peakRSSIMinimum" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIMinimumAverage long (Number) The value stored at the "peakRSSIMinimumAverage" key of the read-event map is the minimum peak average received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMinimumMedian long (Number) The value stored at the "peakRSSIMinimumMedian" key of the read-event map is the peak received power of the EPC backscatter in dBM mean value. [Optional]
peakRSSIMinimumStandardDeviation float (Number) The value stored at the "peakRSSIMinimumStandardDeviation" key of the read-event map is the minimum peak standard deviation. [Optional]
peakRSSIMinimumStandardScore float (Number) The value stored at the "peakRSSIMinimumStandardScore" key of the read-event map is the minimum peak standard score (z-score). [Optional]
peakRSSIRange long (Number) The value stored at the "peakRSSIRange" key of the read-event map is maximum minus minimum the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSITotal long (Number) The value stored at the "peakRSSITotal" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
position Map The value stored at the "position" key of the TagReport or read-event map is a nested map of meta data as specified in the "TagPositon" measurement.
reader string (String) The value stored at the "reader" key of the read-event map is the ID property configured for this instance of the inventory profile.
readersMap Map The value stored at the "readersMap" key is map containing information about each reader.
reportsMap Map The value stored at the "reportsMap" key is map containing information about each reader report.
New subCycleNum int (Number) If the tagReadingSubCycleMode is not "null", the value stores the sub cycle number the tag is read.
summary Map The value stored at the "summary" key of the TagReport is a map which contains the summary information about the tags.
tagCount int (Number) The value stored at the "tagCount" key is the count of tags included in the report.
tagType string (String) The value stored at the "tagType" key of the read-event map is the optional tag type value. If the tag type is an RFID Tag, then the value should start with "rfid". if the tag type is a barcode, then the value should start with a "barcode".
tags Map The value stored at the "tags" key of the TagReport is a nested map which contains tag data, keyed by tag ID string. Each tag ID is the index for a nested map structure containing details about the read-events for that tag. The event data map may include the keys "antenna", "count", "reader", "timestampFirst", "timestampLast", and "dataExtensions".
tid int (Number) The value stored at the "tid" key of the read-event map is the TID of the tag.
tidBank byte[] The value stored at the "tidBank" key of the read-event map is the optional TID bank value.
timestampFirst long (Number) The value stored at the "timestampFirst" key of the read-event map is the initial timestamp that this tag was read during the reporting cycle.
timestampFirstUptime long (Number) The value stored at the "timestampFirst" key of the read-event map is the initial uptime timestamp that this tag was read during the reporting cycle.[Optional]
timestampLast long (Number) The value stored at the "timestampLast" key of the read-event map is the final timestamp that this tag was read during the reporting cycle.
timestampLastUptime long (Number) The value stored at the "timestampLast" key of the read-event map is the last uptime timestamp that this tag was read during the reporting cycle.[Optional]
New totalSubCycles int (Number) If the tagReadingSubCycleMode is not "null", the value stores the total sub cycle numbers.
userBank byte[] The value stored at the "userBank" key of the read-event map is the optional user bank value.
userdata byte[] The value stored at the "userdata" key of the read-event map is the user data of the tag.
vendorExtensions List The value stored at the "vendorExtensions" key of the read-event map is the List of custom parameters. The value of each element is a Map with keys "VendorIdentifier", "ParameterSubtype" and "VendorParameterValue".
VendorIdentifier int (Number) The value stored at the "VendorIdentifier" key of customParameter map is the Vendor ID in the custom parameter.
VendorParameterValue byte[] The value stored at the "VendorParameterValue" key of customParameter map is the VendorParameter Value in the custom parameter.
confidence int (Number) The value stored at the "confidence" key of the read-event map is the optional confidence value. The higher the confidence value the more likely the tag was meant to be included in the aggregation. If the confidence is zero, then we are unsure if the tag should be included. If the confidence is less than zero, it is unlikely that the tag should be included. The more negative the confidence value, then less likely the tag should be included.

prefix

The prefix section of the topic is an optional section that can be set via configuration settings.

get

If get is specified at the end of the topic, then this is a request to get the current value from the measurement.

read

If read is specified at the end of the topic, then this is a request to read the measurement.

write

If write is specified at the end of the topic, then this is a request to write a value to the measurement.

trigger

If trigger is specified at the end of the topic, then this is a request to trigger the signal.

execute

If execute is specified at the end of the topic, then this is a request to excute the command.

Configuration Information

Configuration Key Data Units Default Description
New readStopTimeout Integer 2000 readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgment from the reader after commanding the reader to stop reading. The profile updates the TagReading measurement to "false" after either a response is received from the reader device or the time specified in readStopTimeout elapses.
New tagReadingSubCycleMode String null tagReadingSubCycleMode is a configuration parameter to specify that if one tag reading cycle should contain sub cycles. The value options: "null", "auto", "period". null: the feature is disabled. auto: the sub cycles are turned on and off based on the repeated tag reports. period: each sub cycle is turned on for a fixed period of time.
New tagReadingSubCycleNum Integer -1 tagReadingSubCycleNum is a configuration parameter to specify the number of the sub cycles in each reading cycle, it is only applicable when "tagReadingSubCycleMode" is not "null". There will be unlimited cycles if the number is less than or equal to 0.
New tagReadingSubCycleLength Long 1500 tagReadingSubCycleLength is a configuration parameter to specify the period length in milliseconds for each sub cycle, for "auto" mode, it is the timeout value.
New tagReadingSubCycleDelta Long 1000 tagReadingSubCycleDelta specifies that if the time between the two reports of any tag exceeds this parameter, the sub cycle will be stopped.
New tagReadingSubCycleInterval Long 100 tagReadingSubCycleInterval specifies the period length of the interval between sub cycles, no interval if the value is less than or equal to 0.

Bugzilla: https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Equinox&component=Incubator.DeviceKit
CVS File:
  org.eclipse.equinox
    incubator
      soda
        dk
          org.eclipse.soda.dk.rfid.inventory
            org.eclipse.soda.dk.rfid.inventory.profile
              dk
                profile.xml
(1.69)
Tag(s) Timestamp Revision Comment
V1_2_0_2010_01_22 .. Root_Eclipse3_4 2009-08-18 1.69 Add sub cycle function
V1_2_0_2009_06_02 .. V1_2_0_2008_01_05_E3_3_2 2009-01-05 1.68
V1_2_0_2008_12_14_E3_3_2 .. V1_2_0_2008_12_03 2008-12-03 1.67
V1_2_0_2008_11_16 2008-11-16 1.65
V1_2_0_2008_11_14 .. V1_2_0_2008_09_30 2008-09-29 1.64
Eclipse3_3 2008-09-15 1.63
V1_1_0_2009_09_10 .. V1_1_0_2008_09_10 2008-09-10 1.62
V1_1_0_2008_09_09 .. V1_1_0_2008_09_03 2008-09-03 1.61
2009-02-25 1.63.2.1

Copyright (c) 2010 IBM. See license in Legal section. 2010-01-26 RfidInventoryProfile External 1.2.0