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 with metadata 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 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 placeholder 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 semi-colon.

Data extensions (RfidInventory/DataExtensions)

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

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.

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.

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 placeholder 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 semi-colon.

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 metadata 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.
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.
dataExtensions	The value stored at the "dataExtensions" key of the TagReport or read-event map is a nested map of metadata as specified in the DataExtensions 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.

External Key	Data	Description
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.
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.
dataExtensions	string	The value stored at the "dataExtensions" key of the TagReport or read-event map is a nested map of metadata as specified in the DataExtensions 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.
tags	string	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.
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.
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.
userdata	byte[]	The value stored at the "userdata" key of the read-event map is the user data of the tag.

prefix

get

read

write

trigger

execute

Configuration Information

Configuration Key	Data	Description
readStopTimeout	Integer	readStopTimeout is a configuration parameter to specify the timeout period in milliseconds that the profile will wait to receive an acknowledgement 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.