• Api Documentation
  • Programmer's Guide
Show / Hide Table of Contents
  • rfid.api
    • ACCESS_OPERATION_CODE
    • ACCESS_OPERATION_STATUS
    • AccessFilter
    • AccessOperationResult
    • Actions
    • ALARM_LEVEL
    • ANTENNA_EVENT_TYPE
    • ANTENNA_MODE
    • ANTENNA_STOP_TRIGGER_TYPE
    • AntennaConfig
    • AntennaInfo
    • AntennaPortInfo
    • Antennas
    • Antennas.AntennaProperties
    • Antennas.AntennaRfConfig
    • Antennas.AntennaRfConfig.AntennaStopTrigger
    • Antennas.Config
    • Antennas.PhysicalProperties
    • Antennas.RFMode
    • Antennas.SingulationControl
    • Antennas.SingulationControl.SingulationAction
    • BATTERY_STATUS
    • BrandIDCheck
    • CABLE_LOSS_COMPENSATION
    • CableLossCompensation
    • CAPIEvents
    • CAPIEvents.RFSurveyReadNotifyHandler
    • chan_s
    • CHANNEL_TIMING
    • COMMUNICATION_STANDARD
    • COMMUNICATION_STANDARDS
    • CommunicationsStandardCode
    • CommunicationStandard
    • Config
    • COUNTRY_CODE
    • DISCONNECTION_EVENT_TYPE
    • DIVIDE_RATIO
    • Events
    • Events.AccessStartEventData
    • Events.AccessStopEventData
    • Events.AntennaEventData
    • Events.BufferFullWarningEventData
    • Events.DebugInfoEventData
    • Events.DisconnectionEventData
    • Events.GPIEventData
    • Events.HandheldTriggerEventData
    • Events.InventoryStartEventData
    • Events.InventoryStopEventData
    • Events.NXPEASAlarmEventData
    • Events.ReaderExceptionEventData
    • Events.ReadEventArgs
    • Events.ReadEventData
    • Events.ReadNotifyHandler
    • Events.RFSurvayStartEventData
    • Events.RFSurveyEventArgs
    • Events.RFSurveyEventData
    • Events.RFSurveyStopEventData
    • Events.STATUS_EVENT_TYPE
    • Events.StatusEventArgs
    • Events.StatusEventData
    • Events.StatusNotifyHandler
    • Events.TemperatureAlarmData
    • FILTER_ACTION
    • FORWARD_LINK_MODULATION
    • FrequencyHopInfo
    • FrequencyHopTable
    • Fujitsu
    • Fujitsu.AreaReadLockAccessParams
    • Fujitsu.AreaWriteLockAccessParams
    • Fujitsu.AreaWriteLockWOPasswordAccessParams
    • Fujitsu.BurstEraseAccessParams
    • Fujitsu.BurstWriteAccessParams
    • Fujitsu.ChangeBlockLockAccessParams
    • Fujitsu.ChangeBlockOrAreaGroupPasswordAccessParams
    • Fujitsu.ChangeWordLockAccessParams
    • Fujitsu.ReadBlockLockAccessParams
    • FujitsuBurstEraseResult
    • FujitsuBurstWriteResult
    • FujitsuReadBlockLockResult
    • FujitsuStats
    • GPI_PORT_STATE
    • GPIs
    • GPIs.GPI_PORT_STATE
    • GPIs.Port
    • GPITrigger
    • GPOs
    • GPOs.GPO_PORT_STATE
    • GPOs.Port
    • HANDHELD_TRIGGER_EVENT_TYPE
    • HandheldTrigger
    • HEALTH_STATUS
    • Impinj
    • Impinj.QTData
    • Impinj.QTReadAccessParams
    • Impinj.QTWriteAccessParams
    • ImpinjStats
    • InvalidUsageException
    • Inventory
    • INVENTORY_STATE
    • LED_COLOR
    • LedInfo
    • LLRPConnection
    • LLRPConnectionConfig
    • LocationInfo
    • LOCK_DATA_FIELD
    • LOCK_PRIVILEGE
    • LoginInfo
    • MATCH_PATTERN
    • MATCH_RANGE
    • MEMORY_BANK
    • MODULATION
    • NGE_REGUALTORY_CODE
    • NGE_Regulatory_Configuration
    • NGERegion
    • NgeRegionConfig
    • NXP
    • NXP.ChangeConfigParams
    • NXP.ChangeConfigResult
    • NXP.ReadProtectParams
    • NXP.ResetReadProtectParams
    • NXP.SetEASParams
    • NXPStats
    • OPERATION_QUALIFER
    • OperationFailureException
    • PerAntennaReceiveSensitivityRange
    • PeriodicTrigger
    • PixieEvents
    • PostFilter
    • POWER_NEGOTIATION_STATUS
    • POWER_SOURCE_TYPE
    • PreFilters
    • PreFilters.PreFilter
    • PreFilters.StateAwareActionParams
    • PreFilters.StateUnawareAction
    • Profile
    • RADIO_POWER_STATE
    • RadioConfigUpdate
    • RadioFirmwareUpdate
    • READER_EXCEPTION_EVENT_TYPE
    • READER_ID_TYPE
    • READER_TYPE
    • ReaderCapabilities
    • ReaderCapabilities.ReaderIdentification
    • ReaderInfo
    • ReaderManagement
    • ReaderMinorState
    • ReaderModuleVersion
    • ReaderOperation
    • ReaderRegion
    • ReaderRegion.ActiveRegionInfo
    • ReaderRegion.CommunicationStandardInfo
    • ReaderState
    • ReaderStatistics
    • ReaderType
    • ReadPoint
    • READPOINT_STATUS
    • RECOMMISSION_OPERATION_CODE
    • REG_REGION_DOMAIN
    • REGION_CODE
    • REGION_CONFIG_DATA
    • RegionConfig
    • regLBT
    • regOnOff
    • REGULATORY_CONFIG_DATA
    • REGULATORY_LINKPROFILE_DATA
    • ReportTriggers
    • RFID_EVENT_TYPE
    • RFID_SKU
    • RfidApi4Abstract
    • RfidGlobalData
    • RFIDReader
    • RFIDResults
    • RFIDTransportType
    • RFModes
    • RFModeTable
    • RFModeTableEntry
    • RFSurvey
    • RFSURVEY_EVENT_REPORT_TRIGGER
    • RFSurveyData
    • RFSurveyEventReportInfo
    • RssiRangeFilter
    • SECURE_MODE
    • SecureConnectionInfo
    • SecureModeConfig
    • SeenTime
    • SERVICE_ID
    • SESSION
    • SL_FLAG
    • SoftwareUpdate
    • SoftwareUpdateInfo
    • SPECTRAL_MASK_INDICATOR
    • STANDARD_INFO_LISTW
    • STANDARD_REGION_INFOW
    • START_TRIGGER_TYPE
    • StartTrigger
    • STATE_AWARE_ACTION
    • STATE_UNAWARE_ACTION
    • STOP_TRIGGER_TYPE
    • StopTrigger
    • SUPPORTED_BAUDRATE
    • SystemInfo
    • TAG_EVENT
    • TAG_EVENT_REPORT_TRIGGER
    • TAG_FIELD
    • TagAccess
    • TagAccess.BlockEraseAccessParams
    • TagAccess.BlockPermalockAccessParams
    • TagAccess.KillAccessParams
    • TagAccess.LockAccessParams
    • TagAccess.ReadAccessParams
    • TagAccess.RecommisionAccessParams
    • TagAccess.Sequence
    • TagAccess.Sequence.Operation
    • TagAccess.WriteAccessParams
    • TagAccess.WriteSpecificFieldAccessParams
    • TagData
    • TagEventReportInfo
    • TagLocationing
    • TagPatternBase
    • TagStorageSettings
    • TagZoneInfo
    • TARGET
    • TEMPERATURE_SOURCE
    • TemperatureStatus
    • TimeZone
    • TRACE_LEVEL
    • TriggerInfo
    • TriggerWithTimeout
    • TRUNCATE_ACTION
    • UpdateStatus
    • UpTime
    • USB_OPERATION_MODE
    • USBOperationMode
    • UserApp
    • UserAppInfo
    • UserInfo
    • UTCTime
    • VersionInfo
    • WRITE_FIELD_CODE
    • Zones
    • Zones.ZoneConfig
    • ZoneSequence
    • ZoneSequence.ZoneInfo

Class RFIDReader

Provides the RFIDReader object.

Inheritance
System.Object
RFIDReader
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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()
Back to top