| ModuleAPI C# Version Developer's Guide |
|
Start Inventory
Call the StartReading method to start the asynchronous inventory. Before calling the StartReading method, you must ensure that some parameters have been set correctly, and events related to asynchronous inventory have been registered, otherwise calling this method will throw an exception.
- The ReadPlan parameter of SimpleReadPlan must be set to specify the air interface protocol and the working antenna, otherwise an exception will be thrown.
- The BackReadOption parameter must be set to specify the detailed configuration of the inventory operation, otherwise an exception will be thrown.
- The TagsRead event must be registered, otherwise the tags inventoried cannot be passed to the user program.
- The ReadException event must be registered, otherwise the reader exception state cannot be passed to the user program.
If the reader is currently performing an asynchronous inventory, then calling the StartReading method will throw an exception. If you are not sure about the current state of the reader, you can call the StopReading method first before starting the inventory.
StartReading Method
Start the asynchronous inventory
Method Signature
public void StartReading()
Example
rdr. StartReading();
TagsRead Event
Fires when tags are inventoried to pass the tag data to the user program by the parameter of the TagsReadEventArgs type.
Event Type
EventHandler<TagsReadEventArgs>
ReadException Event
Fires when exception occurs to pass the exception details to the user program by the parameter of the ReadExceptionEventArgs type.
Event Type
EventHandler<ReadExceptionEventArgs>
GpiTrigger Event
If asynchronous Inventory is configured to start by GpiTrigger, fires when gpi trigger condition is met to pass the current gpi states to the user program by the parameter of the GpiTriggerEventArgs type.
Event Type
EventHandler<GpiTriggerEventArgs>
GpiTriggerBoundary Event
If asynchronous Inventory is configured to start by GpiTrigger, fires when starting or stoping asynchronous Inventory to pass the causes of starting or stopping inventory to the user program by the parameter of the GpiTriggerBoundaryEventArgs type.
Event Type
EventHandler<GpiTriggerBoundaryEventArgs>
TagsReadEventArgs Class
The parameter of the TagsRead event, used to pass the tags' data inventoried.
| Attribute | Description |
|---|---|
| Tags | The tags' data inventoried. |
ReadExceptionEventArgs Class
The parameter of the ReadException event, used to pass the exception details.
| Attribute | Description |
|---|---|
| ReaderException | The reader exception. |
GpiTriggerEventArgs Class
The GpiTrigger event parameter, which is used to pass the GPI status and trigger condition number when starting and stopping the asynchronous inventory.
| Attribute | Description |
|---|---|
| GpiStates | The GPI status when triggering start or stop asynchronous inventory. |
| TriggerId | The condition number that triggers the start or stop of the asynchronous inventory. |
GpiTriggerBoundaryEventArgs Class
The parameter of the GpiTriggerBoundary event, used to pass the reason for starting and stopping asynchronous inventory.
| Attribute | Description |
|---|---|
| Reason | The cause of starting or stopping inventory. |
| BoundaryType | Starting or stopping inventory. |