NurApiDotNet Namespace

NurApi library (.NET Standard 2.0) for controlling NUR protocol based RFID devices.

Recommended module types (or newer) NUR05WL2/NUR1W0 (v5.0-A), All NUR2 (v.7.5-A), All NUR3.

This library is mostly source compatible with previous versions of NurApiDotNet (.NETFramework) library.
Discovering and connecting to reader has changed significantly; See Connect(Uri), NurDeviceDiscovery

Samples available on NordicID github: https://github.com/NordicID/nur_sample_csharp

See NurApi class for more.

Example

See full sample app NurApiDocSample

Classes

AccBarcodeResult Barcode event result
AccessoryConfig Reader may have accessories like Barcode reader, imager, beeper, vibrator etc.
AccessorySensorChanged Nur accessory sensor changed information
AccSensorData Abstract base class for sensor values.
AccSensorRangeData Sensor value from a range sensor
AccSensorToFFrBfaRawData Nur accessory FR BFA ToF raw data.
AccSensorToFFrBfaRawDataAccSensorToFFrBfaRawDataItem Nur accessory FR BFA ToF raw data for one ToF sensor.
AntennaMapping Reader antenna.
Holds information about antenna physical name and ID.
GpioConfig Module GPIO configuration.
GpioEntry Single GPIO configuration.
GpioStatus Single GPIO status.
HopEventData Hop event data for HopEvent event
InventoryStreamData Inventory stream data after InventoryStreamEvent event
IOChangeData I/O change data after IOChangeEvent event
NurApi NurApi class is used to manage connection and communicate with RFID device.

Discover devices: NurDeviceDiscovery
Connect device: Connect(Uri)
NurApiAccessoryBatteryInfo Hold information about battery of accessory
NurApiAccessoryFWInfo Information about accessory firmwares
NurApiAccessorySensorConfig Nur accessory sensor configuration.
NurApiAccessorySensorFilter Nur accessory sensor filter. Configures sensor triggers/debounce parameters.
NurApiAccessorySensorFilterThrehold Nur accessory sensor filter threshold.
NurApiAuthenticateParam Gen2 version 2 Authenticate-command's parameters.
NurApiAuthenticateResp Gen2 version 2 Authenticate-command's response.
NurApiAutotuneSetup AutoTune setup
NurApiBarcodeReadResult Barcode read result
NurApiBootEventArgs Boot event arguments class (BootEvent)
NurApiCacheStats 
NurApiCRC16 
NurApiCRC32 
NurApiCustomExchangeParams 
NurApiCustomExchangeResponse Custom bit stream / exchange response.
NurApiCustomHoptable Extended custom hoptable: added LBT limit and maximum TX level.
NurApiCustomHoptableEx 
NurApiDeviceCapabilites Device capabilities.
NurApiDiagReport Diagnostics report data. , ,
NurApiDiagReportEventArgs Diagnostics report event arguments class.
NurApiEthConfig Holds information about Ethernet settings of connected module if available (GetEthConfig)
NurApiHopEventArgs Hop event arguments class (HopEvent)
NurApiInventoryExFilter Inventory filter parameters. Represents G2 Select command, see UHF G2 standard section 6.3.2.11.1.1.
NurApiInventoryExParams Extended inventory function parameters
NurApiInventoryResponse Last inventory data result
NurApiInventoryStreamEventArgs Inventory Stream Event arguments class (InventoryStreamEvent)
NurApiIOChangeEventArgs I/O change event arguments class (IOChangeEvent)
NurApiIrInformation NUR module inventory + read configuration.
NurApiLogEventArgs Log event arguments class (LogEvent)
NurApiModuleSetup Module settings data.
NurApiModuleVersions Hold information about the module version.
See GetVersions
NurApiNurEventArgs Nur event arguments
NurApiNXPAlarmStreamEventArgs NXP alarm stream event arguments class (NXPAlarmStreamEvent)
NurApiPermalockResp Response to block permalock status read.
NurApiReaderInfo Holds information about connected module.
NurApiReflectedPowerInfo Reflected power data. See GetReflectedPower
NurApiRegionInfo Holds information about specific region
NurApiRssiFilter Tag RSSI filter.
NurApiScanChannelInfo Scannel scan data. See ScanChannels
NurApiSensorConfig Sensor configuration structure see GetSensorConfig, SetSensorConfig(NurApiSensorConfig)
NurApiSystemInfo Holds information about NUR module system.
NurApiTag Class of tag
NurApiTagData 
NurApiTagDataEx Contains single tag inventoried information.
NurApiTagStorage Fast EPC/C# optimized hash based tag data storage class.
NurApiTraceTagData Trace tag data after TraceTagEvent event
NurApiTraceTagEventArgs Trace Tag event arguments class (TraceTagEvent)
NurApiTransportStats 
NurApiTriggerReadEventArgs Trigger Read Event arguments class (TriggerReadEvent)
NurApiTuneEventArgs Tune event arguments class.
NurApiUnknownNotifyEventArgs Unknown Notify Event Arguments class (UnknownNotifyEvent)
NurApiV2ReadBufferResp Response to the Gen2 version 2 ReadBuffer command.
NurApiXPCSpec Holds XPCSpec data.
NurApiDocSample Simple console application showing some of the basic NurApi operations.

Full project available in https://github.com/NordicID/nur_sample_csharp

NurApiErrors Class of NurApiErrors
NurApiException Implements the NUR API specific exception.
NurDeviceDiscovery Class for discovering NUR devices from Network/BLE/Serial NOTE: BLE and serial port support depends on platform and must be explicitly added to project
NurDeviceDiscovery_Integrated 
NurDeviceDiscoveryEventArgs DeviceDiscoveryEvent >arguments
NurEventProgrammingProgress 
NurEventUnknown 
NurIntegratedTransport 
NurRingBuffer General purpose ring buffer
NurSocketTransport 
NurV2ReadBufferParam 
NXPAlarmStreamData NXP EAS Alarm stream data after NXPAlarmStreamEvent event
TriggerReadData Trigger read data after TriggerReadEvent event
TuneEventData Tune event data for TuneEvent event
UntraceableParam Gen2 version 2 Untraceable-command's parameters.

Delegates

Enumerations

AddressType Address type (IP) flags
AntennaId Antenna Id's
AntennaMask Antenna mask bits
AntennaType Antenna type flags
AutoPeriod Auto period flags
Bank Memory Banks
Baudrate Serial baudrate of Nur module
CustomExchangeFlags Custom exchange flags
DiagCfgFlags Diagnostic flags
DiagReportFlags Diagnostic report flags
FilterAction Filter action flags
GPIOAction GPIO Action TODO: fix links
GPIOEdge GPIO Edge
GPIOType GPIO types
HostMode Host mode flags
InventoryReadType Inventory read type flags
InventorySelectState Inventory select state flags
InventoryTarget Inventory target flags
LinkFrequency Enums of Link frequency.
Values Hz
LockAction Lock action flags
LockMemoryMask Memory lock mask flags
LogLevel Logging levels
NurApiAccessoryCommand Accessory commands
NurApiAccessoryEventType Event types of AccessoryEvent
NurApiAccessorySensorFeature Accessory sensor features (used as a bitmask)
NurApiAccessorySensorFilterFlag Accessory sensor mode (used as a bitmask)
NurApiAccessorySensorMode Accessory sensor mode (used as a bitmask)
NurApiAccessorySensorSource Accessory sensor source
NurApiAccessorySensorType Accessory sensor types
NurApiAccWirelessChargeStatus Wireless charging status
NurApiAutotuneSetupMode AutoTune modes
NurApiBarcodeReadStatus Status of Barcode read operation
NurApiDeviceCapabilitesChipVersionCode RFID chip version
NurApiDeviceCapabilitesFlagSet1 Enums of device capabilities flag set 1.
NurApiDeviceCapabilitesFlagSet2 
NurApiDeviceCapabilitesModuleConf Module configuration bits
NurApiDeviceCapabilitesModuleTypeCode Type of NUR module
NurApiHIDMode HID modes of Accessory
NurApiImagerType Imager types
NurApiPairingMode Pairing mode
NurTransportStatus 
OperationFlag Operation flags
RegionId Regions
RfProfile RF profile flags
RxDecoding RX encoding (Miller encoding)
RxSensitivity Rx sensitivity flags
SetupFlags Module setup flags
StoreFlags Store flags when saving setup in to the module internal non-volatile memory
TargetSession Target session flags
TraceTagFlag Trace tag flags
TuneRevertType Tune revert type flags
TxLevel Transmission (TX) power level in 1dB steps. See also the
TxModulation Tx modulation style