Eclipse.org

RfidWriteProfile

org.eclipse.soda.dk.rfid.write

 RfidWriteProfile External

The RFID Write Profile defined the common method of perform write operation against Radio Frequency Identification (RFID) tags across different RFID readers. We have tried to model some of this profile based the Low Level Reader Protocol (LLRP) write functions. The first set of controls define how the RFID Write Profile will report the tag write information. The next set of controls define how the Write Operations will be performed and how these Write Operations will be triggered. <p> NOTE: This is a very early definition of this profile and will change as we get important feedback from application providers and hardware vendors. </p> <p>RFID Write Profile Questions/Issues </p> <ul> <li>Currently, LLRP does not support auto increment of the Tag ID's being written. This profile currently does not support auto increment. Is this the correct decision for this profile? </li> <li>What other operations (like Kill Tag, Erase Tag) should be supported? </li> <li>What is the best way to handle passwords? </li> <li>Can this profile be made simpler? Can any of these controls be deleted? </li> </ul>

Antenna configuration (RfidWrite/AntennaConfiguration) Map

The "AntennaConfiguration" is the map containing the antenna configuration. The key is the antenna number based on a starting index of 1. The value is another map containing the information about that specific antenna.

Data write extensions (RfidWrite/DataWriteExtensions) Map

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

Tag aggregation write mask setting (RfidWrite/TagAggregationWriteMaskSetting) String

The "TagAggregationWriteMaskSetting" specifies the definition of tags that should be published on the TagWriteAggregationReport 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 write aggregating (RfidWrite/TagWriteAggregating) Boolean

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

Tag write aggregating expression (RfidWrite/TagWriteAggregatingExpression) String

The "TagWriteAggregatingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the behavior of aggregating based on input pin and control values.

Tag write aggregation report (RfidWrite/TagWriteAggregationReport) Map

The "TagWriteAggregationReport" is a signal containing a collection of tag write information 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 "DataWriteExtensions" key. See the tags and DataWriteExtensions descriptions for details.

Tag write antenna reporting (RfidWrite/TagWriteAntennaReporting) Boolean

The "TagWriteAntennaReporting" measurement specifies the state of tag antenna reporting. When the measurement is true, the reader is reporting tag antenna information in tag data on the TagReport signal. When this tag antenna reporting is true, then extra process is required which may effect performance.

Tag write mask setting (RfidWrite/TagWriteMaskSetting) String

The "TagWriteMaskSetting" specifies the definition of tags that should be published on the TagWriteReport 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 write report (RfidWrite/TagWriteReport) Map

The "TagWriteReport" is a signal containing tag write information 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 DataWriteExtensions descriptions for details.

Write operations (RfidWrite/WriteOperations) String

The "WriteOperations" 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 write operation. <ul > <li>Operation Filter: Defines the tag filter to apply on the rest of the operations. Format: Filter;MemoryBank;Match;BitPointer;TagMask;TagData <ol> <li> Filter: Reserved name for the filter operation. </li> <li> MemoryBank: An integer to specify the memory bank to be used for the filter. </li> <li> Match: A boolean to specify if "match" or "not match" is applied for the filter. </li> <li> BitPointer: It is the first bit location (zero based) of the data against which to compare the mask. </li> <li> TagMask: A hex String as the mask for the filter. </li> <li> TagData: The the pattern against which the specified section of the tag data must match (or not match) to pass the filter. </li> </ol> </li> <li>Operation Write: Defines the write operation on the specified memory bank on the tags. Format: Write;MemoryBank;Pointer;WriteData;Password;OpCount;Timeout[;OperationId] <ol> <li> Write: Reserved name for the write operation. </li> <li> MemoryBank: An interger to specify the memory bank to written on. </li> <li> Pointer: The first location (zero based) in the memory bank to start the write operation. </li> <li> WriteData: The data for the write operation. </li> <li> Password: The password for the write operation. </li> <li> OpCount: An integer to specify the times this write operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the write operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the write operation. </li> </ol> </li> <li>Operation Increment Write: Defines an automatic incremental write on the specified memory bank on the tags. Format: Increment Write;MemoryBank;Pointer;WriteData;Increment;Password;Repeat;Timeout[;OperationId] <ol> <li> Increment Write: Reserved name for the increment write operation. </li> <li> MemoryBank: An interger to specify the memory bank to written on. </li> <li> Pointer: The first location (zero based) in the memory bank to start the write operation. </li> <li> WriteData: The base data for the write operation. </li> <li> Increment: An integer to specify the incremental value for each tag writing. </li> <li> Password: The password for the write operation. </li> <li> Repeat: An integer to specify the times the increment write operation will be executed, it will be unlimited if the value is 0. </li> <li> Timeout: The timeout value (milliseconds) for the increment write operation, no timeout if the value is 0. </li> <li> OperationId: The optional parameter to assign an id to the increment write operation. </li> </ol> </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>

Write operations execute request (RfidWrite/WriteOperationsExecuteRequest) String

The "WriteOperationsExecuteRequest" command requests that that tag write operations be executed. If an LDAP expression is specified for the WriteOperationsExpression, a publication to write a value to this command will result in an exception and will not execute the tag write operations.

Write operations execute status (RfidWrite/WriteOperationsExecuteStatus) Boolean

The "WriteOperationsExecuteStatus" specifies if the current WriteOperations are being executed. If the status is true, sending a new WriteOperations or execute request will result in an exception.

Write operations expression (RfidWrite/WriteOperationsExpression) String

The "WriteOperationsExpression" is an LDAP expression to trigger the state of tag writing based on input pin and control values. If the state of this expression changes to true, then the current WriteOperations will be executed once.

Write operations stop request (RfidWrite/WriteOperationsStopRequest) String

The "WriteOperationsStopRequest" command requests that that tag write operations be stopped. If an LDAP expression is specified for the WriteOperationsExpression, a publication to write a value to this command will result in an exception and will not stop the tag write operations.

prefix

get

read

write

trigger

execute

Configuration Information

Configuration Key	Data	Units	Default	Description
executeOnOperationChange	Boolean		true	executeOnOperationChange is a configuration parameter to specify whether to execute once when the writeOperations string is set or changed.