Class RFIDReader
Provides the RFIDReader object.
Inheritance
Inherited Members
Namespace: rfid.api
Assembly: rfid.netcore.dll
Syntax
public class RFIDReader
Constructors
RFIDReader(ReaderType)
The constructor
Declaration
public RFIDReader(ReaderType readerType = ReaderType.FX)
Parameters
| Type | Name | Description |
|---|---|---|
| ReaderType | readerType |
RFIDReader(String, SUPPORTED_BAUDRATE)
Constructor takes hostname or IP address, com port and timeout as parameter
Declaration
public RFIDReader(string comport, SUPPORTED_BAUDRATE baudrate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | comport | com port number eg com3. |
| SUPPORTED_BAUDRATE | baudrate | baudrate e.g. 5084 |
RFIDReader(String, Int32)
Constructor takes hostname or IP address, com port and timeout as parameter
Declaration
public RFIDReader(string comport, int baudrate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | comport | com port number eg com3. |
| System.Int32 | baudrate | baudrate e.g. 5084 |
RFIDReader(String, UInt32, UInt32)
Constructor takes hostname or IP address, port and timeout as parameter
Declaration
public RFIDReader(string hostName, uint port, uint timeoutMilliseconds)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | hostName | host name or IP address |
| System.UInt32 | port | port number e.g. 5084 |
| System.UInt32 | timeoutMilliseconds | timeout for the response from there reader specified in miliseconds |
Properties
Actions
Gets the Actions object. This is the core object which exposes the core reader operations such as inventory and access operations of the reader.
Declaration
public Actions Actions { get; }
Property Value
| Type | Description |
|---|---|
| Actions |
BaudRate
Declaration
public SUPPORTED_BAUDRATE BaudRate { get; set; }
Property Value
| Type | Description |
|---|---|
| SUPPORTED_BAUDRATE |
Comport
Declaration
public string Comport { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Config
Gets the configuration object
Declaration
public Config Config { get; }
Property Value
| Type | Description |
|---|---|
| Config |
Events
Gets the event object
Declaration
public Events Events { get; }
Property Value
| Type | Description |
|---|---|
| Events |
HostName
Gets or sets the host name or IP Address of the reader
Declaration
public string HostName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
IsConnected
Returns the current reader connection status
Declaration
public bool IsConnected { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Port
Gets or sets the port number which is used for establishing connection with the reader
Declaration
public uint Port { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
ReaderCapabilities
Gets reader capabilities object
Declaration
public ReaderCapabilities ReaderCapabilities { get; }
Property Value
| Type | Description |
|---|---|
| ReaderCapabilities |
RfidApi4Abstract
Declaration
public RfidApi4Abstract RfidApi4Abstract { get; set; }
Property Value
| Type | Description |
|---|---|
| RfidApi4Abstract |
SecureConnectionInfo
Gets or sets the secure connection information which would be used while making an llrp connection.
Declaration
public SecureConnectionInfo SecureConnectionInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| SecureConnectionInfo |
TimeoutMilliseconds
Gets or set the timeout of the reader connection
Declaration
public uint TimeoutMilliseconds { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
VersionInfo
Gets the RFID class library version information
Declaration
public VersionInfo VersionInfo { get; }
Property Value
| Type | Description |
|---|---|
| VersionInfo |
Methods
AcceptConnection(Socket)
This method accepts the socket to the Reader-Initiated Connection and initializes the RFIDReaderObject just like how Connect() method Initializes
Declaration
public void AcceptConnection(Socket readerSocket)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Net.Sockets.Socket | readerSocket | Socket Object to accept the connection |
Connect()
Connects to the reader
Declaration
public void Connect()
Disconnect()
Disconnect from the reader
Declaration
public void Disconnect()
Dispose()
Disposes the RFIDReader
Declaration
public void Dispose()
Finalize()
The constructor
Declaration
protected void Finalize()
GetAvailableCOMPorts(SUPPORTED_BAUDRATE)
Get available COM ports
Declaration
public static List<string> GetAvailableCOMPorts(SUPPORTED_BAUDRATE baudrate)
Parameters
| Type | Name | Description |
|---|---|---|
| SUPPORTED_BAUDRATE | baudrate |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> | List of available COM ports |
GetAvailableCOMPorts(Int32)
Get available COM ports
Declaration
public static List<string> GetAvailableCOMPorts(int baudrate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | baudrate |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> | List of available COM ports |
Reconnect()
Reconnects to the reader, if the connection is lost.
Declaration
public void Reconnect()