The reader class for all Metratec reader.
More...
|
| MetratecReader (ICommunicationInterface connection) |
| The reader class for all Metratec reader.
|
|
| MetratecReader (ICommunicationInterface connection, ILogger logger) |
| The reader class for all Metratec reader.
|
|
| MetratecReader (ICommunicationInterface connection, string id) |
| The reader class for all Metratec reader.
|
|
| MetratecReader (ICommunicationInterface connection, string id, ILogger logger) |
| The reader class for all Metratec reader.
|
|
void | Connect () |
| Connect the reader.
|
|
void | Connect (int timeout) |
| Connect the reader and wait for the connection established.
|
|
void | Disconnect () |
| Disconnect the reader.
|
|
abstract string | ExecuteCommand (string command, int timeout=10000) |
| Send a command and returns the response.
|
|
abstract void | SetPower (int power) |
| Set the reader power.
|
|
abstract void | SetAntenna (int antennaPort) |
| Sets the current antenna to use.
|
|
abstract void | SetAntennaMultiplex (int antennasToUse) |
| Sets the number of antennas to be multiplexed.
|
|
abstract List< T > | GetInventory () |
| Scan for the current inventory.
|
|
abstract void | StartInventory () |
| Starts the continuous inventory scan. If the inventory event handler is set, any transponder found will be delivered via it. If the event handler is not set, the found transponders can be fetched via the method FetchInventory
|
|
abstract void | StopInventory () |
| Stops the continuous inventory scan.
|
|
abstract bool | GetInput (int pin) |
| Returns true if the input pin is high, otherwise false.
|
|
abstract void | SetOutput (int pin, bool value) |
| Sets a output pin.
|
|
List< T > | FetchInventory () |
| Can be called when an inventory has been started and no inventory callback is set. Returns a list with the currently found transponders.
|
|
|
void | SetEndOfFrame (String endOfFrame) |
| Set the connection end of frame string.
|
|
virtual void | SendCommand (string command) |
| Send a command.
|
|
virtual string | GetResponse () |
| Returns the next response.
|
|
List< string > | ClearResponseBuffer () |
| Deletes the currently waiting responses from the buffer and returns them.
|
|
virtual void | SetHeartBeatInterval (int intervalInSec) |
| Set the HeartBeatInterval ... override for send the heartbeat command. The base implementation must be called after success.
|
|
virtual void | PrepareReader () |
| Configure the reader. The base implementation must be called after success.
|
|
abstract void | ConfigureReader () |
| Configure the reader. The base implementation must be called after success.
|
|
abstract void | UpdateDeviceRevisions () |
| Update the the firmware name and version ({firmware} {version})
|
|
virtual void | HandleResponse (string response) |
| Process the reader response...override for event check The base implementation adds the response to the responses queue.
|
|
void | FireInventoryEvent (List< T > tags, bool continuous) |
| Fire a inventory event.
|
|
|
string | id |
| Reader id.
|
|
readonly ILogger | Logger |
| Logger.
|
|
|
bool | FireEmptyInventories [get, set] |
| If the event handler for new inventory is set and this value is true, an empty inventory also triggers the event handler.
|
|
int | ResponseTimeout [get, set] |
| Reader response timeout.
|
|
string? | FirmwareName [get, protected set] |
| Reader firmware name.
|
|
string? | HardwareName [get, protected set] |
| Reader hardware name.
|
|
string? | FirmwareVersion [get, protected set] |
| Reader firmware version.
|
|
int? | FirmwareMajorVersion [get, set] |
| Reader major firmware version.
|
|
int? | FirmwareMinorVersion [get, set] |
| Firmware minor firmware version.
|
|
string? | HardwareVersion [get, protected set] |
| Reader hardware version.
|
|
string? | SerialNumber [get, protected set] |
| Reader serial number.
|
|
bool | Connected [get] |
| The reader connection state.
|
|
The reader class for all Metratec reader.
◆ MetratecReader() [1/4]
The reader class for all Metratec reader.
- Parameters
-
connection | The connection interface |
◆ MetratecReader() [2/4]
The reader class for all Metratec reader.
- Parameters
-
connection | The connection interface |
logger | The connection interface |
◆ MetratecReader() [3/4]
The reader class for all Metratec reader.
- Parameters
-
connection | The connection interface |
///
- Parameters
-
◆ MetratecReader() [4/4]
The reader class for all Metratec reader.
- Parameters
-
connection | The connection interface |
id | The reader id |
logger | The connection interface |
◆ ClearResponseBuffer()
Deletes the currently waiting responses from the buffer and returns them.
- Returns
- The currently waiting responses
◆ ConfigureReader()
◆ Connect()
Connect the reader and wait for the connection established.
- Parameters
-
timeout | the connection timeout |
◆ ExecuteCommand()
Send a command and returns the response.
- Parameters
-
command | the command |
timeout | the response timeout, defaults to 2000ms |
- Returns
- Exceptions
-
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ FetchInventory()
Can be called when an inventory has been started and no inventory callback is set. Returns a list with the currently found transponders.
- Returns
- A list with the currently found transponders
◆ FireInventoryEvent()
Fire a inventory event.
- Parameters
-
tags | the founded tags |
continuous | set to true if it came from a continuous scan |
◆ GetInput()
Returns true if the input pin is high, otherwise false.
- Parameters
-
pin | The requested input pin number |
- Returns
- True if the input pin is high, otherwise false
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ GetInventory()
Scan for the current inventory.
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
◆ GetResponse()
Returns the next response.
- Returns
- Exceptions
-
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
◆ HandleResponse()
◆ PrepareReader()
◆ SendCommand()
◆ SetAntenna()
Sets the current antenna to use.
- Parameters
-
antennaPort | the antenna to use |
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ SetAntennaMultiplex()
Sets the number of antennas to be multiplexed.
- Parameters
-
antennasToUse | the antenna count to use |
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ SetEndOfFrame()
Set the connection end of frame string.
- Parameters
-
endOfFrame | the new end of frame string |
◆ SetHeartBeatInterval()
Set the HeartBeatInterval ... override for send the heartbeat command. The base implementation must be called after success.
- Parameters
-
intervalInSec | Heartbeat interval in seconds. 0 for disable |
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Reimplemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ SetOutput()
Sets a output pin.
- Parameters
-
pin | The output pin number |
value | True for set the pin high |
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ SetPower()
Set the reader power.
- Parameters
-
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
◆ StartInventory()
Starts the continuous inventory scan. If the inventory event handler is set, any transponder found will be delivered via it. If the event handler is not set, the found transponders can be fetched via the method FetchInventory
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
◆ StopInventory()
◆ UpdateDeviceRevisions()
Update the the firmware name and version ({firmware} {version})
- Exceptions
-
T:System.InvalidOperationException | If the reader return an error |
T:System.TimeoutException | Thrown if the reader does not responding in time |
T:System.ObjectDisposedException | If the reader is not connected or the connection is lost |
Implemented in MetraTecDevices.MetratecReaderGen1< T >, and MetraTecDevices.MetratecReaderGen2< T >.
◆ FireEmptyInventories
If the event handler for new inventory is set and this value is true, an empty inventory also triggers the event handler.
Fire also empty inventories. Defaults to false
◆ FirmwareName
◆ FirmwareVersion
◆ HardwareName
◆ HardwareVersion
◆ ResponseTimeout
Reader response timeout.
Response timeout in millisecond. Defaults to 2000
◆ SerialNumber
The documentation for this class was generated from the following file:
- MetratecDevices/MetratecReader.cs