Eclipse.org|
Eclipse.org |
group | Rfid Write |
<group> examples |
Rfid Write Attributes Elements XML Reference |
<group> example from the profile.xml sample.
<?xml version="1.0" encoding="UTF-8"?>
<group id="RfidWrite">
<measurement id="AntennaConfiguration" type="Map">
<description>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.
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<measurement id="DataWriteExtensions" type="Map">
<description>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.
</description>
<method/>
</measurement>
<signal id="TagWriteReport" type="Map">
<description>
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.
</description>
<data id="tags" type="Map">
<description>The value stored at the "tags" key of the TagWriteReport is a nested map which
contains tag data, keyed by tag ID string. Each tag ID is the index for a nested map which in turn
contains write operation results, keyed by the operation ID string, value structure contains details
about the write-events for that tag. The event data map may include the keys "antenna", "count",
"reader", "timestampFirst", "timestampLast", "dataExtensions", "resultCode" and "readData".
</description>
</data>
<data id="antenna" type="long">
<description>The value stored at the "antenna" key of the write-event map is the antenna value,
based on a starting index of 1. It is included in the write-event map if the reader is
configured to report which antenna wrote the tag.</description>
</data>
<data id="count" type="long">
<description>The value stored at the "count" key of the write-event map is the number of times
this tag was written during the reporting cycle.
</description>
</data>
<data id="reader" type="string">
<description>The value stored at the "reader" key of the read-event map is the ID property
configured for this instance of the inventory profile.</description>
</data>
<data id="timestampFirst" type="long">
<description>The value stored at the "timestampFirst" key of the write-event map is the
initial timestamp that this tag was read during the reporting cycle.</description>
</data>
<data id="timestampLast" type="long">
<description>The value stored at the "timestampLast" key of the write-event map is the
final timestamp that this tag was read during the reporting cycle.</description>
</data>
<data id="dataExtensions" type="Map">
<description>The value stored at the "dataExtensions" key of the TagWriteReport or write-event map
is a nested map of meta data as specified in the DataWriteExtensions measurement.</description>
</data>
<data id="peakRSSI" type="long">
<description>The value stored at the "peakRSSI" key of the read-event map is the peak received power of the
EPC backscatter in dBM. [Optional]</description>
</data>
<data id="resultCode" type="int">
<description>The value stored at the "resultCode" key of the TagWriteReport is the result code of
the access operation.
</description>
</data>
<data id="readData" type="byte[]">
<description>The value stored at the "readData" key of the write-event map is the data of one of
the tag memory bank requested by the read operation.
</description>
</data>
<data id="antenna1" type="Map">
<description>The value stored at the "antenna1" key of the read-event map is the antenna 1 optional information.
</description>
</data>
<data id="antenna2" type="Map">
<description>The value stored at the "antenna2" key of the read-event map is the antenna 2 optional information.
</description>
</data>
<data id="antenna3" type="Map">
<description>The value stored at the "antenna3" key of the read-event map is the antenna 3 optional information.
</description>
</data>
<data id="antenna4" type="Map">
<description>The value stored at the "antenna4" key of the read-event map is the antenna 4 optional information.
</description>
</data>
</signal>
<measurement id="TagWriteMaskSetting" type="String">
<description>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 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.
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<signal id="TagWriteAggregationReport" type="Map">
<description>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.
</description>
<data idref="tags"/>
<data idref="antenna"/>
<data idref="count"/>
<data idref="reader"/>
<data idref="timestampFirst"/>
<data idref="timestampLast"/>
<data idref="DataWriteExtensions"/>
<data idref="resultCode"/>
<data idref="readData"/>
</signal>
<measurement id="TagAggregationWriteMaskSetting" type="String">
<description>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 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.
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<measurement id="TagWriteAggregatingExpression" type="String">
<description>The "TagWriteAggregatingExpression" is an Lightweight Directory Access Protocol (LDAP) expression to trigger the behavior of
aggregating based on input pin and control values.
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<measurement id="TagWriteAggregating" type="Boolean" listen="true">
<description>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.
</description>
<method/>
<value>
<boolean>false</boolean>
</value>
</measurement>
<measurement id="WriteOperations" type="String">
<description><![CDATA[
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.
&lt;ul &gt;
&lt;li&gt;Operation Filter: Defines the tag filter to apply on the rest of the operations.
Format: Filter;MemoryBank;Match;BitPointer;TagMask;TagData
&lt;ol&gt;
&lt;li&gt;
Filter: Reserved name for the filter operation.
&lt;/li&gt;
&lt;li&gt;
MemoryBank: An integer to specify the memory bank to be used for the filter.
&lt;/li&gt;
&lt;li&gt;
Match: A boolean to specify if "match" or "not match" is applied for the filter.
&lt;/li&gt;
&lt;li&gt;
BitPointer: It is the first bit location (zero based) of the data against
which to compare the mask.
&lt;/li&gt;
&lt;li&gt;
TagMask: A hex String as the mask for the filter.
&lt;/li&gt;
&lt;li&gt;
TagData: The the pattern against which the specified section of the tag data must match (or not match)
to pass the filter.
&lt;/li&gt;
&lt;/ol&gt;
&lt;/li&gt;
&lt;li&gt;Operation Write: Defines the write operation on the specified memory bank on the tags.
Format: Write;MemoryBank;Pointer;WriteData;Password;OpCount;Timeout[;OperationId]
&lt;ol&gt;
&lt;li&gt;
Write: Reserved name for the write operation.
&lt;/li&gt;
&lt;li&gt;
MemoryBank: An interger to specify the memory bank to written on.
&lt;/li&gt;
&lt;li&gt;
Pointer: The first location (zero based) in the memory bank to start the write operation.
&lt;/li&gt;
&lt;li&gt;
WriteData: The data for the write operation.
&lt;/li&gt;
&lt;li&gt;
Password: The password for the write operation.
&lt;/li&gt;
&lt;li&gt;
OpCount: An integer to specify the times this write operation will be executed, it will be unlimited if the value is 0.
&lt;/li&gt;
&lt;li&gt;
Timeout: The timeout value (milliseconds) for the write operation, no timeout if the value is 0.
&lt;/li&gt;
&lt;li&gt;
OperationId: The optional parameter to assign an id to the write operation.
&lt;/li&gt;
&lt;/ol&gt;
&lt;/li&gt;
&lt;li&gt;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]
&lt;ol&gt;
&lt;li&gt;
Increment Write: Reserved name for the increment write operation.
&lt;/li&gt;
&lt;li&gt;
MemoryBank: An interger to specify the memory bank to written on.
&lt;/li&gt;
&lt;li&gt;
Pointer: The first location (zero based) in the memory bank to start the write operation.
&lt;/li&gt;
&lt;li&gt;
WriteData: The base data for the write operation.
&lt;/li&gt;
&lt;li&gt;
Increment: An integer to specify the incremental value for each tag writing.
&lt;/li&gt;
&lt;li&gt;
Password: The password for the write operation.
&lt;/li&gt;
&lt;li&gt;
Repeat: An integer to specify the times the increment write operation will be executed,
it will be unlimited if the value is 0.
&lt;/li&gt;
&lt;li&gt;
Timeout: The timeout value (milliseconds) for the increment write operation, no timeout if the value is 0.
&lt;/li&gt;
&lt;li&gt;
OperationId: The optional parameter to assign an id to the increment write operation.
&lt;/li&gt;
&lt;/ol&gt;
&lt;/li&gt;
&lt;li&gt;Operation Read: Defines the read operation on the specified memory bank on the tags.
Format: Read;MemoryBank;Pointer;WordCount;Password;OpCount;Timeout[;OperationId]
&lt;ol&gt;
&lt;li&gt;
Read: Reserved name for the read operation.
&lt;/li&gt;
&lt;li&gt;
MemoryBank: An interger to specify the memory bank to read from.
&lt;/li&gt;
&lt;li&gt;
Pointer: The first location (zero based) in the memory bank to start the read operation.
&lt;/li&gt;
&lt;li&gt;
Password: The password for the read operation.
&lt;/li&gt;
&lt;li&gt;
OpCount: An integer to specify the times this read operation will be executed, it will be unlimited if the value is 0.
&lt;/li&gt;
&lt;li&gt;
Timeout: The timeout value (milliseconds) for the read operation, no timeout if the value is 0.
&lt;/li&gt;
&lt;li&gt;
OperationId: The optional parameter to assign an id to the read operation.
&lt;/li&gt;
&lt;/ol&gt;
&lt;/li&gt;
&lt;/ul&gt;
]]>
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<measurement id="WriteOperationsExpression" type="String">
<description>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.
</description>
<configuration type="String">true</configuration>
<method/>
</measurement>
<command id="WriteOperationsExecuteRequest" type="String">
<description>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.
</description>
<method/>
</command>
<command id="WriteOperationsStopRequest" type="String">
<description>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.
</description>
<method/>
</command>
<measurement id="WriteOperationsExecuteStatus" type="Boolean" executewrite="false"
setvalue="false">
<description>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.
</description>
<method/>
<value>
<boolean>false</boolean>
</value>
</measurement>
<measurement id="TagWriteAntennaReporting" type="Boolean">
<description>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.
</description>
<method/>
<value>
<boolean>false</boolean>
</value>
</measurement>
</group>
| Copyright (c) 2010 IBM. See license in Legal section. | 2010-01-26 | Rfid Write XML Reference 1.2.0 |