• 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 Config

This class allows to perform reader configuration

Inheritance
System.Object
Config
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 Config

Properties

Antennas

Gets the Antenna object

Declaration
public Antennas Antennas { get; }
Property Value
Type Description
Antennas

DefaultReadTagsCount

Gets or sets the default read tag count

Declaration
public int DefaultReadTagsCount { get; set; }
Property Value
Type Description
System.Int32

DefaultRFSurveyCount

Gets or sets the default read rf survey data count

Declaration
public int DefaultRFSurveyCount { get; set; }
Property Value
Type Description
System.Int32

DutyCycleIndex

Duty cycle of the RFID Radio Module. It is an index to ReaderCapabilities.DutyCycleValues

Declaration
public ushort DutyCycleIndex { get; set; }
Property Value
Type Description
System.UInt16

GPI

Gets the GPI Object

Declaration
public GPIs GPI { get; }
Property Value
Type Description
GPIs

GPO

Gets the GPO Object

Declaration
public GPOs GPO { get; }
Property Value
Type Description
GPOs

RadioPowerState

Gets or sets the Radio power state to on or off state

Declaration
public RADIO_POWER_STATE RadioPowerState { get; set; }
Property Value
Type Description
RADIO_POWER_STATE

SledBatteryLevel

Gets Sled battery level in percantage

Declaration
public uint SledBatteryLevel { get; }
Property Value
Type Description
System.UInt32

SledBatteryStatus

Gets Sled battery status - charging, discharging, critical

Declaration
public BATTERY_STATUS SledBatteryStatus { get; }
Property Value
Type Description
BATTERY_STATUS

TemperatureStatus

get Temperature Status

Declaration
public TemperatureStatus TemperatureStatus { get; }
Property Value
Type Description
TemperatureStatus

TraceLevel

Gets or sets the trace level

Declaration
public TRACE_LEVEL TraceLevel { get; set; }
Property Value
Type Description
TRACE_LEVEL

Zones

Gets the Zones Object

Declaration
public Zones Zones { get; }
Property Value
Type Description
Zones

Methods

GetSaveLlrpConfigStatus()

This function returns the LLRP configuration saved status

Declaration
public bool GetSaveLlrpConfigStatus()
Returns
Type Description
System.Boolean

True if saved or False if not

GetTagStorageSettings()

Get TagStorageSettings.

Declaration
public TagStorageSettings GetTagStorageSettings()
Returns
Type Description
TagStorageSettings

TagStorageSettings

ResetFactoryDefaults()

Restores to factory default settings in the reader.

Declaration
public void ResetFactoryDefaults()
Remarks

Once this method is called, all the settings will be lost. For eg. events, singulation control. This application is required to redo the basic steps for initializing the reader.

SaveLlrpConfig()

This function saves the LLRP configurations

Declaration
public void SaveLlrpConfig()

SetDebugMask(String, UInt16)

Sets the Debug Mask

Declaration
public void SetDebugMask(string debugMask, ushort byteOffSet)
Parameters
Type Name Description
System.String debugMask
System.UInt16 byteOffSet

SetTagStorageSettings(TagStorageSettings)

This method allows configuring the maximum tag-storage capacity and storage to be allocated in the Tag Data object for the memory bank data and Tag ID (EPC). Also, it allows to set the number of tags to be queued in side the Library.

Declaration
public void SetTagStorageSettings(TagStorageSettings tagStorageSettings)
Parameters
Type Name Description
TagStorageSettings tagStorageSettings

Settings like MaxTagCount, MaxMemoryBankSize, MaxEPCID, Selection of Tag Data Fields

Remarks

The application can use this method to customize the tag data size(EPC and Memory Bank) based on the requirements. Also, this method allows to configure the queue size of the Library maintained.

Tags reported from the reader as part of inventory or read-access operation will be queued internally in the library till it is called using GetReadTag. When the number of tags queued in the library exceeds the max tag count, the event enabled for BUFFER_FULL_WARNING_EVENT will be signalled. This event also be signalled when reader internal buffers are full.

It is recommended to use the default settings unless it is explicitly required for advanced user to optimize the performance or necessary to adjust the EPC or memory bank size

Exceptions
Type Condition
OperationFailureException

This exception is thown when the parameters are invalid

Back to top