Eclipse.org

RfidInventoryProfile

org.eclipse.soda.dk.rfid.inventory

 RfidInventoryProfile External

RfidInventoryProfile controls 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 withmeta 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.

 Aggregation filter expression (RfidInventory/AggregationFilterExpression)

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)

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)

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. 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)

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

 Confidence script (RfidInventory/ConfidenceScript)

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

Data extensions (RfidInventory/DataExtensions)

The DataExtensions measurement is a map of meta data tobe 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)

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 measurementwill result in an exception and will not update the measurement value.

Duplicate filtering expression (RfidInventory/DuplicateFilteringExpression)

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)

The ReadOperations specifies the definition of write operations block against the tag(s). A write operation block can contain multiple write operations separated by the character ":". A write 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 interger 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)

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

 Super cache maximum size (RfidInventory/SuperCacheMaximumSize)

The "SuperCacheMaximumSize" is maximum number of tags supported by the super cache size.

Tag aggregating (RfidInventory/TagAggregating)

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 thismeasurementwill result in an exception and will not update the measurement value.

Tag aggregating expression (RfidInventory/TagAggregatingExpression)

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

Tag aggregation report (RfidInventory/TagAggregationReport)

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 metadata 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)

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)

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)

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. 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)

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)

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 measurementwill result in an exception and will not update the measurement value.

Tag reading expression (RfidInventory/TagReadingExpression)

The TagReadingExpression is an LDAP expression to trigger the state of tag reading based on input pin and control values.

Tag report (RfidInventory/TagReport)

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.

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".
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.
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.
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.
antennaReportCount	The value stored at the "antennaReportCount" key of the read-event map is the count of how many antenna reported information reporting cycle.
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.
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.
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.
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.
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.
tid	The value stored at the "tid" key of the read-event map is the TID of the tag.
userdata	The value stored at the "userdata" key of the read-event map is the user data of the tag.
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]
llrpInventoryParameterSpecId	The value stored at the "llrpInventoryParameterSpecId" key of the read-event map is the InventoryParameterSpecId related to the LLRP tag report. [Optional]
peakRSSI	The value stored at the "peakRSSI" key of the read-event map is the peak received power of the EPC backscatter in dBM. [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]
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]
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]
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]
channelIndex	The value stored at the "channelIndex" key of the read-event map is the index of the channel the tag was seen. [Optional]
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]
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]
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]
C1G2PC	The value stored at the "llrpC1G2PC" key of the llrpAirProtocolTagData map is the PC Bits value of the tag.[Optional]
C1G2CRC	The value stored at the "llrpC1G2CRC" key of the llrpAirProtocolTagData map is the CRC value of the tag.[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]
llrpOpSpecReadData	The value stored at the "llrpOpSpecReadData" key of the llrpOpSpecResult map is the data read by the air opSpec.[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]
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.
battery	The value stored at the "battery" key of the read-event map is the optional battery information.
epcURI	The value stored at the "epcURI" key of the read-event map is the optional epc URI value.
killPwd	The value stored at the "killPwd" key of the read-event map is the optional kill password value.
accessPwd	The value stored at the "accessPwd" key of the read-event map is the optional access password value.
epcBank	The value stored at the "epcBank" key of the read-event map is the optional epc bank value.
tidBank	The value stored at the "tidBank" key of the read-event map is the optional TID bank value.
userBank	The value stored at the "userBank" key of the read-event map is the optional user bank value.
afi	The value stored at the "afi" key of the read-event map is the optional ISO Application Family Identifier (AFI) value.
nsi	The value stored at the "nsi" key of the read-event map is the optional Numbering System Identifier (NSI) bank value.
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".
peakRSSIMinimumStandardScore	The value stored at the "peakRSSIMinimumStandardScore" key of the read-event map is the minimum peak standard score (z-score). [Optional]
peakRSSIMaximumStandardScore	The value stored at the "peakRSSIMaximumStandardScore" key of the read-event map is the maximum peak standard score (z-score). [Optional]
summary	The value stored at the "summary" key of the TagReport is a map which contains the summary information about the tags.
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]
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]
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]
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]
peakRSSIMinimumStandardDeviation	The value stored at the "peakRSSIMinimumStandardDeviation" key of the read-event map is the minimum peak standard deviation. [Optional]
peakRSSIMaximumStandardDeviation	The value stored at the "peakRSSIMaximumStandardDeviation" key of the read-event map is the maximum peak standard deviation. [Optional]
tagCount	The value stored at the "tagCount" key is the count of tags included in the report.
countAverage	The value stored at the "countAverage" key is the count of all tag reads divided by the tag count.
readersMap	The value stored at the "readersMap" key is map containing information about each reader.
antennasMap	The value stored at the "antennasMap" key is map containing information about each antenna.
reportsMap	The value stored at the "reportsMap" key is map containing information about each reader report.
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.
ParameterSubtype	The value stored at the "ParameterSubtype" key of customParameter map is the SubType 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. 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 write operations block against the tag(s). A write operation block can contain multiple write operations separated by the character ":". A write 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 interger 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.
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			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 metadata 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. 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 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			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		The value stored at the "accessPwd" key of the read-event map is the optional access password value.
afi	uint		The value stored at the "afi" key of the read-event map is the optional ISO Application Family Identifier (AFI) value.
antenna	long		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		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.
C1G2CRC	long		The value stored at the "llrpC1G2CRC" key of the llrpAirProtocolTagData map is the CRC value of the tag.[Optional]
C1G2PC	long		The value stored at the "llrpC1G2PC" key of the llrpAirProtocolTagData map is the PC Bits value of the tag.[Optional]
channelIndex	long		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		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		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	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		The value stored at the "epcURI" key of the read-event map is the optional epc URI value.
killPwd	string		The value stored at the "killPwd" key of the read-event map is the optional kill password value.
llrpAccessSpecId	long		The value stored at the "llrpAccessSpecId" key of the read-event map is the AccessSpecId related to the LLRP tag report. [Optional]
llrpAirProtocolTagData	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		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		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		The value stored at the "llrpOpSpecResultCode" key of the llrpOpSpecResult map is the result code of the air opSpec.[Optional]
llrpROSpecId	long		The value stored at the "llrpROSpecId" key of the read-event map is the ROSpecId related to the LLRP tag report. [Optional]
llrpSpecIndex	long		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	uint		The value stored at the "nsi" key of the read-event map is the optional Numbering System Identifier (NSI) bank value.
ParameterSubtype	int		The value stored at the "ParameterSubtype" key of customParameter map is the SubType in the custom parameter.
peakRSSI	long		The value stored at the "peakRSSI" key of the read-event map is the peak received power of the EPC backscatter in dBM. [Optional]
peakRSSIAverage	float		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		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		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		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		The value stored at the "peakRSSIMaximumStandardDeviation" key of the read-event map is the maximum peak standard deviation. [Optional]
peakRSSIMaximumStandardScore	float		The value stored at the "peakRSSIMaximumStandardScore" key of the read-event map is the maximum peak standard score (z-score). [Optional]
peakRSSIMinimum	long		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		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		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		The value stored at the "peakRSSIMinimumStandardDeviation" key of the read-event map is the minimum peak standard deviation. [Optional]
peakRSSIMinimumStandardScore	float		The value stored at the "peakRSSIMinimumStandardScore" key of the read-event map is the minimum peak standard score (z-score). [Optional]
peakRSSIRange	long		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		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		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.
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		The value stored at the "tagCount" key is the count of tags included in the report.
tagType	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		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		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		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		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		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]
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		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		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

get

read

write

trigger

execute

Configuration Information

Configuration Key	Data	Units	Description
readStopTimeout	Integer		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.