Class ReaderManagement

This class encapsulates the Reader Management functionality such as reboot, firmware update. Also, proprietary reader functions such as Antenna Mode (Bi-Static or Mono-static), Enable/Get Read Point status functionality can be performed using this class.

Inheritance

System.Object

ReaderManagement

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 ReaderManagement

Constructors

ReaderManagement()

Reader Management constructor

Declaration

public ReaderManagement()

ReaderManagement(RfidApi4Abstract)

Declaration

public ReaderManagement(RfidApi4Abstract rfidApi4Abstract)

Parameters

Type	Name	Description
RfidApi4Abstract	rfidApi4Abstract

Properties

AntennaMode

Gets or sets the antenna mode to enumerations (Mono-Static or Bi-Static) value sets the specified antenna mode in the reader. Changing the antenna mode take few seconds to perform the required operation

Declaration

public ANTENNA_MODE AntennaMode { get; set; }

Property Value

Type	Description
ANTENNA_MODE

GPIDebounceTimeMilliseconds

Gets or sets the GPI Debounce Time

Declaration

public uint GPIDebounceTimeMilliseconds { get; set; }

Property Value

Type	Description
System.UInt32

IsLoggedIn

Gets the login status whether logged in or not. If logged in to the reader, it returns true, else false.

Declaration

public bool IsLoggedIn { get; }

Property Value

Type	Description
System.Boolean

LLRPConnection

This class contains the LLRP Connection required for LLRP Server/Client connectivity.

Declaration

public LLRPConnection LLRPConnection { get; }

Property Value

Type	Description
LLRPConnection

LocalTime

Reader's Local time

Declaration

public DateTime LocalTime { get; set; }

Property Value

Type	Description
System.DateTime

PowerNegotiationState

To get the Power Negotiatiation State (Enabled or not)

Declaration

public bool PowerNegotiationState { get; set; }

Property Value

Type	Description
System.Boolean

PowerNegotiationStatus

Gets the Power Negotiation current status

Declaration

public POWER_NEGOTIATION_STATUS PowerNegotiationStatus { get; }

Property Value

Type	Description
POWER_NEGOTIATION_STATUS

Profile

This class contains the configuration file

Declaration

public Profile Profile { get; }

Property Value

Type	Description
Profile

RadioConfigUpdate

Gets the Radio Config Update object

Declaration

public RadioConfigUpdate RadioConfigUpdate { get; }

Property Value

Type	Description
RadioConfigUpdate

RadioFirmwareUpdate

Gets the reader firmware update object

Declaration

public RadioFirmwareUpdate RadioFirmwareUpdate { get; }

Property Value

Type	Description
RadioFirmwareUpdate

ReaderInfo

Reader information Login(LoginInfo, READER_TYPE) OperationFailureException

Declaration

public ReaderInfo ReaderInfo { get; set; }

Property Value

Type	Description
ReaderInfo

ReaderRegion

This class contains methods for getting or setting the reader's region

Declaration

public ReaderRegion ReaderRegion { get; }

Property Value

Type	Description
ReaderRegion

ReadPoint

Gets the read point object

Declaration

public ReadPoint ReadPoint { get; }

Property Value

Type	Description
ReadPoint

RfidApi4Abstract

Declaration

public RfidApi4Abstract RfidApi4Abstract { get; }

Property Value

Type	Description
RfidApi4Abstract

SoftwareUpdate

Gets the software Update object

Declaration

public SoftwareUpdate SoftwareUpdate { get; }

Property Value

Type	Description
SoftwareUpdate

Temperature

Gets Temperature

Declaration

public TemperatureStatus Temperature { get; }

Property Value

Type	Description
TemperatureStatus

TimeZone

This class contains the time zone

Declaration

public TimeZone TimeZone { get; }

Property Value

Type	Description
TimeZone

TraceLevel

Gets or sets the trace level

Declaration

public TRACE_LEVEL TraceLevel { get; set; }

Property Value

Type	Description
TRACE_LEVEL

USBOperationMode

USB operation mode of the Reader. Login(LoginInfo, READER_TYPE) OperationFailureException USB operation mode used in reader

Declaration

public USBOperationMode USBOperationMode { get; set; }

Property Value

Type	Description
USBOperationMode

UserApp

Gets the UserAppDeployment object

Declaration

public UserApp UserApp { get; }

Property Value

Type	Description
UserApp

Methods

ChangePassword(UserInfo)

Change password for the given user credentials

Declaration

public void ChangePassword(UserInfo userInfo)

Parameters

Type	Name	Description
UserInfo	userInfo	User Info like user name, old and new Password

ClearReaderStatistics()

Clears the reader statistics maintained in the reader

Declaration

public bool ClearReaderStatistics()

Returns

Type	Description
System.Boolean	Status Clear Reader Statistics Operation

Dispose()

Dispose Reader Management

Declaration

public void Dispose()

Finalize()

Destructor

Declaration

protected void Finalize()

GetCableLossCompensation(UInt32)

Gets the Cable Loss Compensation Info for the given Antenna ID

Declaration

public CableLossCompensation GetCableLossCompensation(uint antennaID)

Parameters

Type	Name	Description
System.UInt32	antennaID	Antenna ID

Returns

Type	Description
CableLossCompensation	Cable Loss Compensation Information

Exceptions

Type	Condition
OperationFailureException	Operation failure is thrown when it is not logged in

See Also

Login(LoginInfo, READER_TYPE)

GetHealthStatus(SERVICE_ID)

Gets Health status

Declaration

public HEALTH_STATUS GetHealthStatus(SERVICE_ID serviceID)

Parameters

Type	Name	Description
SERVICE_ID	serviceID	Specifies services ID such as RM or LLRP

Returns

Type	Description
HEALTH_STATUS	Health Status of the requested Service (up/down)

Remarks

This function gets the health status of the reader

Exceptions

Type	Condition
OperationFailureException	Operation failure is thrown when it is not logged in

See Also

Login(LoginInfo, READER_TYPE)

GetRadioIdleTimeout(ref Int32)

Gets the Radio Idle Timeout configured in the reader

Declaration

public void GetRadioIdleTimeout(ref int Timeout)

Parameters

Type	Name	Description
System.Int32	Timeout	Idle Time out in seconds

GetReaderStatistics(UInt16)

Get Reader Statistics for the given Antenna ID

Declaration

public ReaderStatistics GetReaderStatistics(ushort antennaID)

Parameters

Type	Name	Description
System.UInt16	antennaID	Antenna ID

Returns

Type	Description
ReaderStatistics	Reader Statistics

GetSystemInfo()

Gets the Reader System information.

Declaration

public SystemInfo GetSystemInfo()

Returns

Type	Description
SystemInfo	System Information

Remarks

This function gets the system information related to the Reader like Reader Name, Firmware version, RAM available, Flash available, Up time (how long the reader is running)

Exceptions

Type	Condition
OperationFailureException	Operation failure is thrown when it is not logged in

See Also

Login(LoginInfo, READER_TYPE)

Login(LoginInfo, READER_TYPE)

This method allows to login into the reader.

Declaration

public void Login(LoginInfo loginInfo, READER_TYPE readerType)

Parameters

Type	Name	Description
LoginInfo	loginInfo	Login information is required for Fixed Reader. It can be null for Hand held readers
READER_TYPE	readerType	Specifies the reader type

Remarks

Fixed Reader (FX/XR)

The reader can be made to run in either secured mode(HTTPS) or normal(HTTP). User must be aware of this mode and use it in the secure mode parameter of this method. If the value set wrongly, it will fail to login.

Hand held Reader (MC)

This method must be called to initialize the resources required for other reader management functions.

Exceptions

Type	Condition
OperationFailureException	Operation Failure exception is thrown when the parameter is invalid

Logout()

Logs out from the reader This call performs the logout and clean-up activity in the library Login(LoginInfo, READER_TYPE)

Declaration

public void Logout()

Restart()

This method restarts or reboot the reader. To restart the reader for any reasons, this method allows to restart the reader. After calling this method, it is always necessary to call the logout method to clean up the resources in the library. To reconnect back, call login method again. Login(LoginInfo, READER_TYPE) Logout() OperationFailureException

Declaration

public void Restart()

SetCableLossCompensation(CableLossCompensation[])

Sets Cable Loss Compensentation Info

Declaration

public void SetCableLossCompensation(CableLossCompensation[] cableLossCompensationInfo)

Parameters

Type	Name	Description
CableLossCompensation[]	cableLossCompensationInfo	Array of Cable Loss Compensation parameters for each antenna ID to be configured

Remarks

User can set different Cable Loss Compensation parameters for different antennas, or can apply the same set of parameter for over all antennas. Setting the antenna ID as 0 in the 0th array element of CableLossCompensation will apply the same settings to all the antennas.

Exceptions

Type	Condition
OperationFailureException	Operation failure is thrown when it is not logged in

See Also

Login(LoginInfo, READER_TYPE)

SetUserLED(LedInfo)

Sets the User LED information

Declaration

public void SetUserLED(LedInfo ledInfo)

Parameters

Type	Name	Description
LedInfo	ledInfo	LED information required for the Reader.

Remarks

This function sets the LED information for the Reader

Exceptions

Type	Condition
OperationFailureException	Operation failure is thrown when it is not logged in

See Also

Login(LoginInfo, READER_TYPE)

TurnOffRadioWhenIdle(Int32)

Turns of Radio When Idle

Declaration

public void TurnOffRadioWhenIdle(int Timeout)

Parameters

Type	Name	Description
System.Int32	Timeout	Radio will be turned off after specified Timeout(in seconds) if idle (no radio operation is performed), 0 = disables the Idle Mode