NurApi Class

NurApi class is used to manage connection and communicate with RFID device.

Discover devices: NurDeviceDiscovery
Connect device: Connect(Uri)

Definition

Namespace: NurApiDotNet
Assembly: NordicID.NurApi.Net (in NordicID.NurApi.Net.dll) Version: 4.0.0
C#
public class NurApi : IDisposable
Inheritance
Object    NurApi
Implements
IDisposable

Example

See full sample app NurApiDocSample

Constructors

NurApi Nurapi contructor. Single NurApi handle for single RFID Device at the time.

Properties

AntennaMask Bitmask of enabled antennas. DEPRECATED: Do not use for new designs, use AntennaMaskEx instead.
Obsolete.
AntennaMaskEx Bitmask of enabled antennas, support up to 32 antennas. Value 0x1 - 0xFFFFFFFF.
AntennaPowerEx Per antenna tx level settings. Array with exactly 32 entries must be supplied.
AutoReconnect Enable/disable automatic reconnection on connection loss.
Autotune Runtime antenna tuning settings.
AutotuneEnable Enables the run-time automatic tuning. This feature is supported in the L2 module's FW version 5.0-A and on.
AutotuneThreshold Run-time automatic tuning's threshold value in dBm.
AutotuneThresholdEnable Enable or disable using of the run-time automatic tuning's threshold value. This feature is supported in the L2 module's FW version 5.0-A and on.
AvailablePhysicalAntennas

Get list of available physical antennas supported by connected reader.

BaudRate NUR serial port baudrate index.
Capabilites Get reader capabilities about connected device.
CommCmdRetries Communication cmd re-send retries, if no response received within timeout. Default is 2
CommLongTimeoutMilliSec Communication timeout for possible long runnning commands in milliseconds. Some tag operation commands may take long time to finish, depending on enabled antenna count and/or parameters. Inventory and tag access commands uses this timeout, such as Inventory, InventorySelect, Read, Write, Lock, Kill, Gen2V2 Default is 17000 ms
CommTimeout Set communication timeout in seconds. Range is 3...15.
CommTimeoutMilliSec Communication timeout in milliseconds. Default is 3000 ms
ConnectedDeviceUri Get Uri of currently connected device, null if not connected.
ConnectionStatus Get current transport connection status.
EnabledAntennas Antenna enable. This will internally set AntennaMaskEx
EnabledPhysicalAntennas

Get or sets list of enabled physical antennas in connected reader.

EnableHopEvents Enable frequency hop event generation. OPFLAGS_EN_HOPEVENTS
EnableInvStreamZeros Enable "zero tags found" notification during inventory streams OPFLAGS_INVSTREAM_ZEROS
EnableTagPhaseDiff Tag phase diff. Return tag phase angle difference in units of tenths of degrees in tag meta data timestamp field. Supported only in NUR3 modules. OPFLAGS_EN_PHASE_DIFF
EnableTagPhaseInfo Tag phase info. Return tag phase angle in units of tenths of degrees in tag meta data timestamp field. Supported only in NUR2 modules. OPFLAGS_EN_TAG_PHASE
EnableTuneEvents Enable run-time tuning events OPFLAGS_EN_TUNEEVENTS
FileVersion The NurApi assembly version.
Info Get information about connected device.
InventoryEpcLength Desired EPC Length filter in bytes. All other EPC's will be discarded during inventory.
InventoryQ Default Q used for inventory. Value 0 - 15, where value 0 means automatic Q selection.
InventoryReadCtl Takes the inventory + read into use (true) or turns it off (false). When read tells whether there is a valid inventory + read configuration present in the module or not. Uses the configuration set with InventoryRead(Boolean, UInt32, UInt32, UInt32, UInt32), TIDInventory(UInt32, UInt32) or UserMemInventory(UInt32, UInt32)
InventoryRounds Default rounds for inventory. Value 0 - 10, where 0 means automatic rounds selection. This value specifies full G2 query rounds performed in one inventory command.
InventoryRssiFilter RSSI filters used for inventory operations.
InventorySession Default session for inventory. Value 0 - 3.
InventoryTarget Inventory target.
InventoryTriggerTimeout

Triggered inventory timeout in milliseconds.

Device will scan new tags specified timeout when no new tags are found.

If no new tags found within timeout, triggred inventory is considered done and results are sent to the host.

KillTimeout Kill operation timeout.
LastConnectUri Get Uri of last Connect(Uri) call.
LinkFrequency Tag backscatter link frequency in Hz.
LockTimeout Lock operation timeout.
OpFlags Operation flags.
PeriodSetup Configures inventory stream's duty cycle. Does not save the setting into the module's non-volatile settings.
PeriodSetupSave Configures inventory stream's duty cycle. Setting this value also saves the setting into the module's non-volatile settings.
ReadRssiFilter RSSI filters used for read operations.
ReadTimeout Read operations timeout.
RealBaudRate NUR serial port baudrate in bps.
If value not support, default 115200 bps will be set
Region Operating region.
RfProfile RF profile setting. Device will select best RF settings based on profile.
RxDecoding RX encoding (Miller encoding) value FM0 (0), M2 (1), M4 (2) or M8 (3)
RxSensitivity Receiver sensitivity setting.
ScanSingleTriggerTimeout Triggered single tag scan timeout in milliseconds.
SelectedAntenna Zero based index of selected antenna logical id. ANTENNAID_AUTOSELECT (-1) means auto switch between enabled antennas.
Setup Get current connected device ModuleSetup
Title Title string of NUR module.
TxLevel Transmission level attenuation in 1dB steps.
TxModulation Transmission modulation.
UserData User defined object
WriteRssiFilter RSSI filters used for write operations.
WriteTimeout Write operations timeout.
XPCRemoval XPC removal control.

Methods

AccBarcodeCancel Cancel barcode scan immediately.
AccBarcodeStart Start scan for barcode reader engine
This function only start barcode reading. Use for receiving scan results.
AccBeep Generate simple beep sound for accessory device
AccClearBLEPasskey Clear current passkey from device
AccClearPairingData Clear pairing information from accessory device
Note: if pairings exist then accessory device will be rebooted.
AccGetBatteryInfo Get battery info of accessory
AccGetBLEPasskey Get current BLE passkey
AccGetConfig Get configuration from accessory.
AccGetConnectionInfo Get information about the connection
AccGetFwInfo Get information about the accessory device
AccGetHIDMode Get current HID mode
AccGetHwHealth Get information about HW health
AccGetModelInfo detailed info about model
AccGetPairingMode Get current Pairing mode
AccGetWirelessChargeStatus Get wireless charge status.
AccImagerAim Set Imager aimer on/off
AccImagerCmd Send configuring command to Imager
AccImagerSaveConfig After sending configuration to imager using AccImagerCmd(NurApiImagerType, String), settings are ready to use but next power down causes settings to lost.
Therefore, it’s important to save settings to volatile memory of imager.
AccPowerOff Power off accessory.
Note: Accessory will be disconnect.
AccRestart Restart accessory.
Note: Accessory will be disconnect.
AccSensorEnumerate Get all connected sensors
AccSensorGetConfig Get current sensor configuration.
AccSensorGetFilter Get filter settings of sensor
AccSensorGetValue Get sensor value
AccSensorSetConfig Change sensor configuration (currently only the mode can be changed).
cfg.source is used to identify the sensor.
AccSensorSetFilter Change filter of sensor.
AccSetBLEPasskey Set 6-digit BLE passkey (digits 0-9 only)
AccSetConfig Set accessory configuration.
AccSetHIDMode Set NurApiHIDMode
Note: Accessory restart required after set HID mode.
AccSetLedOp Sets the LED operation mode.
AccSetPairingMode Set NurApiPairingMode
Note: Accessory restart required after set PairingMode mode.
AccSetWirelessCharge Set wireless charge on/off
AccVibrate Use vibra of accessory device
Parameter exception thrown if vibratingTime * count exceeds 2000ms
AllocAuthParam Basic allocation of authentication parameters.
Beep Generate beep sound if beeper device available
Beep(Int32, Int32, Int32) Generate beep sound if beeper device available
BinToHexString Converts byte array to Hex strings and appends delimiter string to end
BitLenToByteLen Get required byte length for given number of bits.
BlockPermalock Do BlockPermalock without selecting any tag. Assume one tag in field.
BlockPermalockByEPC Do BlockPermalock by selecting the tag by its EPC.
BlockPermalockSingulated do BlockPermalock by selecting the tag with specific singulation data.
BlockWriteByEPC Write data to tag by EPC singulation using specific block write.
BlockWriteSingulatedTag(UInt32, Boolean, Byte, UInt32, Byte, Byte, UInt32, Byte, Byte) Write data to tag with specific singulation using specific block write. The Selection mask is assumed to be in byte length i.e. divisible by 8.
BlockWriteSingulatedTag(UInt32, Boolean, Byte, UInt32, Int32, Byte, Byte, UInt32, Byte, Int32, Byte) Write data to tag with specific singulation using specific block write.
BlockWriteTag Write data to tag with no singulation using specific block write.
BuildCustomHoptable Build custom frequency hoptable
Obsolete.
CancelOperation Cancel all pending/queued NurApi operations.
ClearIdBuffer Clear the module's internal ID buffer.
ClearTags Clear NurApi's internal tag storage memory from tags
ClearTagsEx Clear NurApi's internal tag storage and RFID reader memory from tags.
ConfigureXTIDInventory Setup TID content based inventory + read. Configures inventory + read so that the data part is read based on the TID (XTID) contents.
Connect (Re)Connect to last connected device.
Connect(String) Connect to specific reader.
Connect(Uri) Connect to specified reader.
NurApi supportes 'tcp://' and 'mdns://' types by default.
- 'tcp' connect to reader by ip address; tcp://address[:port]
- 'mdns' connect to reader by mdns name; mdns://device_name

Serial port and BLE transports are platform specific and require additional assemblies, such as NordicID.NurApi.Android, NordicID.NurApi.SerialTransport, NordicID.NurApi.SerialTransport.UWP
ConnectSerialPort Connects to COM port using default baudrate (115200 bps)
Obsolete.
ConnectSocket Connects to reader TCP/IP socket.
Obsolete.
ContCarrier Continuous carrier test setup.
CustomCmd(Int32, Byte) Executes NUR API protocol formatted command exchange with the connected reader.
CustomCmd(Int32, Byte, UInt32, Byte, UInt32) Executes NUR API protocol formatted command exchange with the connected reader.
CustomExchange(UInt32, Boolean, NurApiCustomExchangeParams) Exchange a custom bit stream without any singulation using the custom bit stream control structure.
CustomExchange(UInt32, Boolean, UInt16, UInt16, UInt32, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Byte) Exchange a custom bit stream without any singulation specifying all the parameters.
CustomExchangeByEPC(UInt32, Boolean, Byte, NurApiCustomExchangeParams) Exchange a custom bit stream with an EPC singulated tag using the custom bit stream control structure.
CustomExchangeByEPC(UInt32, Boolean, Byte, UInt16, UInt16, UInt32, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Byte) Exchange a custom bit stream with an EPC singulated tag specifying all the parameters.
CustomExchangeSingulated(UInt32, Boolean, Byte, UInt32, Int32, Byte, NurApiCustomExchangeParams) Exchange a custom bit stream with a singulated tag using the custom bit stream control structure.
CustomExchangeSingulated(UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt16, UInt16, UInt32, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Byte) Exchange a custom bit stream with a singulated tag specifying all the parameters.
CustomReadSingulatedTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Byte, UInt32, Byte) Read data from tag with specific singulation, customized read command and bank parameter. Tag can be singluted against desired memory bank and mask.
CustomReadSingulatedTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt32, Int32) Read data from tag with specific singulation. Tag can be singluted against desired memory bank and mask. This command uses custom read command and bank parameters.
CustomReadTag Read data from tag without any singulation data using customized read command and bank parameters. This function can be used for tags that do not have an EPC.
CustomReadTagByEPC Read data from tag singulated by tag's EPC memory using custom read command and custom bank parameter.
CustomWriteSingulatedTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Byte, UInt32, Byte) Write data to tag with specific singulation using customizable write command and bank parameter. Tag can be singluted against desired memory bank and mask.
CustomWriteSingulatedTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt32, Byte) Write data to tag with specific singulation using customizable write command and bank parameter. Tag can be singluted against desired memory bank and mask.
CustomWriteSingulatedTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt32, Byte, Int32, Int32) Write data to tag with specific singulation using customizable write command and bank parameter. Tag can be singluted against desired memory bank and mask.
CustomWriteTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, UInt32, Byte) Write data to tag without any singulation data using customizable write command and bank parameter. This function can be used for tags that do not have an EPC.

Note:If there's more than one tag in range, this function will most likely fail due to the RF collision.

CustomWriteTag(UInt32, Byte, UInt32, Byte, UInt32, Boolean, UInt32, Byte, Int32, Int32) Write data to tag without any singulation data using customizable write command and bank parameter. This function can be used for tags that do not have an EPC.

Note:If there's more than one tag in range, this function will most likely fail due to the RF collision.

CustomWriteTagByEPC(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Byte) Write data to tag singulated by tag's EPC memory using customizable write command and bank parameter.
CustomWriteTagByEPC(UInt32, Byte, UInt32, Byte, UInt32, Boolean, Byte, UInt32, Byte, Int32, Int32) Write data to tag singulated by tag's EPC memory using customizable write command and bank parameter.
DiagGetConfig Get current diagnostics configuration.
DiagGetReport Get diagnostics report from module.
DiagSetConfig Set new diagnostics configuration.
DisablePhysicalAntenna

This function disables the physical antennas that are specified as comma separated string parameter.

Disconnect Disconnect current transport from device
DisconnectAsync Disconnect device async
Dispose Dispose and free all allocated resources.
Dispose(Boolean)Releases the unmanaged resources used by the NurApi and optionally releases the managed resources
DLog(FuncString) Writes to data log.
DLog(String) Writes to data log.
ELog(FuncString) Writes text to log using LOG_ERROR level mask.
ELog(String) Writes text to log using LOG_ERROR level mask.
EnablePhysicalAntenna

This function enables the physical antennas that are specified as comma separated string parameter.

To enable all antennas, use parameter "ALL".

EnterBoot Starts bootloader or Application
Equals
(Inherited from Object)
EraseSingulatedTag Erase block in a tag specifically singulated.
EraseTagByEPC Erase block in a tag singulated by EPC.
ExecuteCommand Excute NUR command
ExecuteCommandAsync Excute NUR command asyncronously
FactoryReset Force RFID module to factory reset
FetchTagAt Fetch a single tag based on "index" in reader tag memory.
FetchTags Fetch tags from reader memory. Meta data of tag is included.
FetchTags(Boolean) Fetch tags from reader memory
FetchTags(Boolean, Int32) Fetch tags from reader memory
Finalize Destructor
(Overrides ObjectFinalize)
Gen2v2Authenticate(NurApiAuthenticateParam) Gen2 version 2 Authenticate command with no tag singulation in open state.
Gen2v2Authenticate(UInt32, NurApiAuthenticateParam) Gen2 version 2 Authenticate command with no tag singulation in secured state.
Gen2v2AuthenticateByEPC(Byte, NurApiAuthenticateParam) Gen2 version 2 Authenticate command with EPC singulation singulation in open state.
Gen2v2AuthenticateByEPC(UInt32, Byte, NurApiAuthenticateParam) Gen2 version 2 Authenticate command with EPC singulation singulation in secured state.
Gen2v2AuthenticateSingulated(Byte, UInt32, Int32, Byte, NurApiAuthenticateParam) Gen2 version 2 Authenticate command with specific singulation parameters in open state.
Gen2v2AuthenticateSingulated(UInt32, Byte, UInt32, Int32, Byte, NurApiAuthenticateParam) Gen2 version 2 Authenticate command with specific singulation parameters in secured state.
Gen2v2ReadBuffer

Gen2 version 2 ReadBuffer command without tag selection.

This is similar to the regular read command but the read data source is the version 2 tag's internal buffer.

Gen2v2ReadBufferByEPC

Gen2 version 2 ReadBuffer command with the tag being selected by its EPC contents.

This is similar to the regular read command but the read data source is the version 2 tag's internal buffer.

Gen2v2ReadBufferSingulated

Gen2 version 2 ReadBuffer command with specific tag selection.

This is similar to the regular read command but the read data source is the version 2 tag's internal buffer.

Gen2v2Untraceable Gen2 version 2 "Untraceable" command with no tag singulation.
Gen2v2UntraceableByEPC Gen2 version 2 "Untraceable" command with EPC selection.
Gen2v2UntraceableSingulated Gen2 version 2 "Untraceable" command with specific singulation parameters.
GetAccessPassword Read access password from tag with specific singulation. Tag can be singluted against desired memory bank and mask.
GetAccessPasswordByEPC Read access password from specific tag singulated by tag's EPC memory.
GetAntennaIdTranslation

Returns the module's internal translation between physical antenna and logical antenna ID.

GetAntennaList List of available antennas
GetBitCount Get count of bits set
GetCacheStats Internal cache stats.
GetCustomHoptable Get custom hoptable
Obsolete.
GetCustomHoptableEx Get extended custom hoptable
GetDeviceCaps Retrieves the device capabilities from the connected module.
GetEpcXpcSpec Get the modified EPC based on the given PC contents.
GetErrorMessage Get Nur error code as string
GetEthConfig Get Ethernet configuration settings from conneted device.
GetFileVersion The NurApi assembly version. Provided for compatibility, use NurApi.FileVersion instead
Obsolete.
GetFWINFO Get FW building information string.
GetGPIOConfig Get NUR module GPIO configuration.
GetGPIOStatus Get single GPIO pin state.
GetHashCode
(Inherited from Object)
GetInventoryRead Get Inventory read information.
GetKillPassword Read kill password from tag with specific singulation. Tag can be singluted against desired memory bank and mask.
GetKillPasswordByEPC Read kill password from specific tag singulated by tag's EPC memory.
GetLogFilePath Get current log file path
GetLogLevel Get Logging level
GetLogToFile Get log to file enabled state.
GetMode Get running mode
GetModuleSetup Get current module setup
GetModuleSetup(Int32) Get current module setup
GetPhysicalAntennaMask This function generates an antennaMask value from the passed physical antenna names. If parameter is invalid, an exception will be thrown
GetReaderInfo Get reader info
GetReflectedPower Get antenna reflected power info
GetReflectedPower(UInt32) Get antenna reflected power info for specific frequency
GetReflectedPowerValue Get the reflected power as a floating point value from current region middle channel's frequency.
GetReflectedPowerValue(UInt32) Returns the reflected power value for given frequency. A return value of -100 indicates that no reflected power was detected. This may indicate broken or bad antenna connection.
GetRegionInfo Get region info
GetSecChipFWINFO Get secondary chip FW building information string.
GetSensorConfig Get sensor configuration
GetSystemInfo Get system information.
GetTagStorage Get NurApi's internal tag storage.
GetTimeStamp Get milliseconds after NurApi initialized
GetTransportStats Internal transport stats.
GetType
(Inherited from Object)
GetVersions Returns the current mode, primary and secondary version information.
HexStringToBin(String) Converts hex string to byte array.
HexStringToBin(String, String) Converts hex string to byte array
Inventory Perform single tag inventory.
This function uses rounds, Q and session values from current module settings.

How it works:

The inventory operation returns information about the last inventory; it does not return tags. The inventory response NurApiInventoryResponse contains namely the number of tags that were found during last inventory and the number of tags that are stored into the module's memory. After exeuting an inventory the tags need to be first retrieved from the module by calling FetchTags or FetchTags(Boolean, Int32) and after that the tags are available in the NurApi's tag storage, NurApiTagStorage that can be retrieved by the get tags storage command, see GetTagStorage. If the inventory needs to be "clean" the method for clearing the module's is ClearTagsEx. Calling this method also clears the NurApi's tag storage and module tag storage.

Inventory(Int32, Int32, Int32) Perform single inventory using specified rounds, Q and session.

What inventory actually returns, see Inventory's summary.

InventoryEx Re-run the extended inventory assuming that the module has stored the parameters earlier.
InventoryEx(NurApiInventoryExParams, NurApiInventoryExFilter) Extended inventory command with multiple select filters.
InventoryEx(NurApiInventoryExParams, NurApiInventoryExFilter) Extended inventory command with multiple select filters.
InventoryRead Setup inventory + read data. Call to this method only configures the inventory + read; it does not start it itself. This means that the inventory + read is done use during the next call to e.g. Inventory or Inventory(Int32, Int32, Int32).
InventorySelect Perform single inventory command with specific tag singulation.

Tags can be singluted against desired memory bank and data mask.

What inventory actually returns, see Inventory's summary.

InventorySelectByEPC Perform single inventory command with tag singulated against EPC.

What inventory actually returns, see Inventory's summary.

IsConnected This function will return only connection state of the transport layer. In order to know that module is responding, you'll need to communicate with module by calling e.g. Ping.
IsInventoryExRunning Return true if streaming extended inventory routine is running.
IsInventoryStreamRunning Check if inventory stream routine is running.
IsNXPAlarmStreamRunning Return true if EAS Alarm stream routine is running on module.
IsPhysicalAntennaEnabled

This function returns true if all physical antennas specified in comma separated string are enabled, otherwise false is returned.

IsTagError Returns whether the given error is a tag backscattered error or not.
IsTraceRunning Return TRUE if tag trace routine is running on module.
KillTag Kill tag with specific singulation. Tag can be singluted against desired memory bank and mask.
KillTagByEPC Kill specific tag singulated by tag's EPC memory.
Log(Int32, FuncString) Writes text to log for specified level.
Log(Int32, String) Writes text to log for specified level.
MemberwiseClone
(Inherited from Object)
MemCompare Comparing memory
ModuleRestart Force RFID module restart
Monza4QTRead Monza4 QT command. Reads the QT_SR bit to reduce and QT_MEM bit to pubmem .
Monza4QTWrite Monza4 QT command. Writes the QT_SR and QT_MEM bits.
NurAntennaIdToPhysicalAntenna

This function maps given logical antenna identifier to a physical name of an antenna.

NurPhysicalAntennaToAntennaId

This function maps given physical antenna name to an logical antenna identifier.

NXPAlarm Send NXP EAS Alarm command. Return true when there's armed EAS tags in range of reader.
NXPResetEAS Reset specific tag's EAS alarm bit to 0 with given singulation data. When tag's EAS alarm bit is set to 1, tag will reply to EAS Alarm command.
NXPResetReadProtect Reset specific tag's read protect with given singulation data.
NXPSetEAS Set specific tag's EAS alarm bit to 1 with given singulation data. When tag's EAS alarm bit is set to 1, tag will reply to EAS Alarm command.
NXPSetReadProtect Set specific tag's read protect with given singulation data.
NXPStartAlarmStream Start NXP EAS Alarm streaming on module. Module will start continuos EAS Alarm stream and sends notification to host when there's armed tags in range.
NXPStopAlarmStream Stop EAS Alarm streaming on module.
OnApiConnectionStatusChanged 
OpenStateLock Set tag lock using specified singulation parameters. Lock is done in open state i.e. without using password access.
OpenStateLockByEPC Set tag lock singulating it by the EPC contents. Lock is done in open state i.e. without using password access.
OpenStateLockRaw Set memory lock for tag with specific singulation in open state i.e. without password access.

Tag can be singluted against desired memory bank and mask.

Lock mask and action parameter are in raw format defined in UHF C1G2 standard section "6.3.2.11.3.5 Lock (mandatory).

Ping Performs ping to connected RFID module
ReadPermalock Read block permalock statuses without selecting a tag. Assume one tag in field.
ReadPermalockByEPC Read block permalock statuses by selecting the tag by its EPC.
ReadPermalockSingulated Read block permalock statuses by selecting the tag with specific singulation data.
ReadSingulatedTag(UInt32, Boolean, Byte, UInt32, Byte, Byte, UInt32, Byte) Read data from tag with specific singulation. Tag can be singluted against desired memory bank and mask.
ReadSingulatedTag(UInt32, Boolean, Byte, UInt32, Int32, Byte, Byte, UInt32, Int32) Read data from tag with specific singulation. Tag can be singluted against desired memory bank and mask.
ReadTag Read data from tag without any singulation data. This function can be used for tags that do not have an EPC.
ReadTagByEPC Read data from tag singulated by tag's EPC memory.
ResetToTarget Reset tag inventoried flag to specific target in selected session. All tags in reader range will be reset.
RestartBLEModuleToDFU Restart the BLE module to DFU (Device Firmware Upgrade) mode.
After the call, another application or built-in updater can upgrade the BLE module's FW.
RestoreTuning Restores the factory tuning to the module. Applies only to the NUR05WL2 and NUR10W modules.
ScanChannels Scan region channels RSSI
ScanChannels(Int32) Scan region channels RSSI
Obsolete.
ScanSingle The single scan is used to read a single tag's EPC contents using a timeout defined in milliseconds.
SetAccessPassword(UInt32, Boolean, Byte, UInt32, Byte, UInt32) Write new access password to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
SetAccessPassword(UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt32) Write new access password to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
SetAccessPasswordByEPC Write new access password to specific tag singulated by tag's EPC memory.
SetAntennaIdTranslation

A method to change the module's internal mapping between the physsical and logical antenna identifiers.

SetConstantChannelIndex Set channel index to use in current hop table. This prevents NUR from hopping in different channel. Use with care: RF frequency is locked as long as this is set. Restore normal channel hopping with parameter -1
SetCustomHoptable Set pre-built custom hop table.
Obsolete.
SetCustomHoptableEx Set pre-built, extended custom hop table (+LBT threshold and maximum TX level).
SetEthConfig Set Ethernet device configuration.
SetExtendedCarrier Causes the module to leave carrier on after a command and not to jump to new frequency. The carrier on time is limited by the maximum channel time.
SetGPIOConfig Set NUR module GPIO configuration.
SetGPIOStatus Set single GPIO pin state. NOTE: GPIO must be configured as output
SetGPIOStatusMask Set state for Gpio's specified by gpioMask
For example: value 0x50 set state for GPIO5 and GPIO7
SetHostFlags Sends host flags to the module.
SetInventoryRead Set Inventory read configuration.
SetKillPassword(UInt32, Boolean, Byte, UInt32, Byte, UInt32) Write new kill password to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
SetKillPassword(UInt32, Boolean, Byte, UInt32, Int32, Byte, UInt32) Write new kill password to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
SetKillPasswordByEPC Write new kill password to specific tag singulated by tag's EPC memory.
SetLock(UInt32, Byte, UInt32, Byte, UInt32, UInt32) Set memory lock for tag with specific singulation.
SetLock(UInt32, Byte, UInt32, Int32, Byte, UInt32, UInt32) Set memory lock for tag with specific singulation.

Tag can be singluted against desired memory bank and mask.

SetLockByEPC Set memory lock for specific tag singulated by tag's EPC memory.
SetLockRaw(UInt32, Byte, UInt32, Byte, UInt32, UInt32) Set memory lock for tag with specific singulation.

Tag can be singluted against desired memory bank and mask.

Lock mask and action parameter are in raw format defined in UHF C1G2 standard section "6.3.2.11.3.5 Lock (mandatory).

SetLockRaw(UInt32, Byte, UInt32, Int32, Byte, UInt32, UInt32) Set memory lock for tag with specific singulation.

Tag can be singluted against desired memory bank and mask.

Lock mask and action parameter are in raw format defined in UHF C1G2 standard section "6.3.2.11.3.5 Lock (mandatory).

SetLogFilePath Set Log file path
See SetLogToFile(Boolean)
SetLogLevel Set Logging level
SetLogToFile Enables log generation to file. Default is "NurApiLog.txt" in to app working folder
To set path use SetLogFilePath(String)
SetLogToStdout Set log to stdout.
SetModuleSetup Set module settings according to given flags.
SetSensorConfig Set sensor configuration
SimpleInventory Use Inventory instead.
Obsolete.
StartInventoryEx(NurApiInventoryExParams, NurApiInventoryExFilter) Start extended inventory streaming command with multiple select filters.
StartInventoryEx(NurApiInventoryExParams, NurApiInventoryExFilter) Start extended inventory streaming command with multiple select filters.
StartInventoryStream Start inventory stream using RFID reader current rounds, Q, session settings. InventoryStreamEvent is fired when data available. To stop inventory stream use StopInventoryStream
StopContCarrier Stop continuous carrier test.
StopContinuous Force stop all NUR module running continuous functions.
StopInventoryEx Stop extended inventory streaming in module.
StopInventoryStream Stop inventory streaming on module.
StoreCurrentSetup Store current module settings to the reader's non-volatile memory.
StoreCurrentSetup(Int32) Store current module setup. Flags indicate which part of settings will be stored.
SwapEndian(UInt16) Swap endianess of 16-bit value
SwapEndian(UInt32) Swap endianess of 32-bit value
TIDInventory Setup TID inventory. Configures inventory + read so that it result only in TID data.
TimeStampToDate Convert NurApi timestamp to DateTime
TimeStampToDateUtc Convert NurApi timestamp to UTC DateTime
ToString
(Inherited from Object)
TraceTag Trace singulated single tag.
TraceTagByEPC Trace single tag singluated against tag's EPC memory.
TuneAntenna Executes antenna tune sequence.
ULog(FuncString) Writes text to log using LOG_USER level mask.
ULog(String) Writes text to log using LOG_USER level mask.
UserMemInventory Setup user memory inventory. Configures inventory + read so that it result only in user memory data.
VLog(FuncString) Writes text to log using LOG_VERBOSE level mask.
VLog(String) Writes text to log using LOG_VERBOSE level mask.
WriteEPC Write new EPC to tag with specific singulation.This function sets also tag PC word correctly for new EPC length. Tag can be singluted against desired memory bank and mask.
WriteEPCByEPC(UInt32, Boolean, Byte, Byte) Write new EPC to specific tag singulated by tag's EPC memory.
WriteEPCByEPC(UInt32, Boolean, String, String) Write new EPC to specific tag singulated by tag's EPC memory.
WriteSingulatedTag(UInt32, Boolean, Byte, UInt32, Byte, Byte, UInt32, Byte) Write data to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
WriteSingulatedTag(UInt32, Boolean, Byte, UInt32, Int32, Byte, Byte, UInt32, Byte) Write data to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
WriteSingulatedTag(UInt32, Boolean, Byte, UInt32, Int32, Byte, Byte, UInt32, Byte, Int32, Int32) Write data to tag with specific singulation. Tag can be singluted against desired memory bank and mask.
WriteTag(UInt32, Boolean, Byte, UInt32, Byte) Write data to tag without any singulation data. This function can be used for tags that do not have an EPC.

Note:If there's more than one tag in range, this function will most likely fail due to the RF collision.

WriteTag(UInt32, Boolean, Byte, UInt32, Byte, Int32, Int32) Write data to tag without any singulation data. This function can be used for tags that do not have an EPC.

Note:If there's more than one tag in range, this function will most likely fail due to the RF collision.

WriteTagByEPC(UInt32, Boolean, Byte, Byte, UInt32, Byte) Write data to tag singulated by tag's EPC memory.
WriteTagByEPC(UInt32, Boolean, Byte, Byte, UInt32, Byte, Int32, Int32) Write data to tag singulated by tag's EPC memory.

Events

BootEvent BootEvent
ConnectedEvent Occurs when the reader is connected.
ConnectionStatusEvent Transport status event fired when change happend in transportation between reader and NurApi
DiagReportEvent DiagReportEvent
DisconnectedEvent Occurs when the reader is disconnected.
HopEvent Frequency hop.
InventoryExEvent Tag data from extended inventory stream.
InventoryStreamEvent Tag data from inventory stream
IOChangeEvent IO Change event
LogEvent Occurs when the notification Log is received.
NXPAlarmStreamEvent NXP EAS Alarm state change.
OnAccBarcodeResult Occurs when the Accessory sensor value range data is received.
OnAccRangeDataEvent Occurs when the Accessory sensor value range data is received.
OnAccSensorChangedEvent Occurs when the sensor is added or removed to/from reader.
OnAccSensorToFFrBfaRawDataEvent Occurs when the Accessory sensor value ToF FR BFA raw data is received.
TraceTagEvent Tag data from trace tag
TriggerReadEvent Triggered tag read.
TuneEvent The automatic tune event.
UnknownNotifyEvent Occurs when the unknown notification is received.

Fields

AccBarcodeEncoding Set/Get Barcode Encoding. Default UTF8
ANTENNAID_1Antenna ID 1
ANTENNAID_10Antenna ID 10
ANTENNAID_11Antenna ID 11
ANTENNAID_12Antenna ID 12
ANTENNAID_13Antenna ID 13
ANTENNAID_14Antenna ID 14
ANTENNAID_15Antenna ID 15
ANTENNAID_16Antenna ID 16
ANTENNAID_17Antenna ID 17
ANTENNAID_18Antenna ID 18
ANTENNAID_19Antenna ID 19
ANTENNAID_2Antenna ID 2
ANTENNAID_20Antenna ID 20
ANTENNAID_21Antenna ID 21
ANTENNAID_22Antenna ID 22
ANTENNAID_23Antenna ID 23
ANTENNAID_24Antenna ID 24
ANTENNAID_25Antenna ID 25
ANTENNAID_26Antenna ID 26
ANTENNAID_27Antenna ID 27
ANTENNAID_28Antenna ID 28
ANTENNAID_29Antenna ID 29
ANTENNAID_3Antenna ID 3
ANTENNAID_30Antenna ID 30
ANTENNAID_31Antenna ID 31
ANTENNAID_32Antenna ID 32
ANTENNAID_4Antenna ID 4
ANTENNAID_5Antenna ID 5
ANTENNAID_6Antenna ID 6
ANTENNAID_7Antenna ID 7
ANTENNAID_8Antenna ID 8
ANTENNAID_9Antenna ID 9
ANTENNAID_AUTOSELECTAuto switch antenna based on supported antenna count.
ANTENNAMASK_1Mask for antenna ID 1.
ANTENNAMASK_10Mask for antenna ID 10.
ANTENNAMASK_11Mask for antenna ID 11.
ANTENNAMASK_12Mask for antenna ID 12.
ANTENNAMASK_13Mask for antenna ID 13.
ANTENNAMASK_14Mask for antenna ID 14.
ANTENNAMASK_15Mask for antenna ID 15.
ANTENNAMASK_16Mask for antenna ID 16.
ANTENNAMASK_17Mask for antenna ID 17.
ANTENNAMASK_18Mask for antenna ID 18.
ANTENNAMASK_19Mask for antenna ID 19.
ANTENNAMASK_2Mask for antenna ID 2.
ANTENNAMASK_20Mask for antenna ID 20.
ANTENNAMASK_21Mask for antenna ID 21.
ANTENNAMASK_22Mask for antenna ID 22.
ANTENNAMASK_23Mask for antenna ID 23.
ANTENNAMASK_24Mask for antenna ID 24.
ANTENNAMASK_25Mask for antenna ID 25.
ANTENNAMASK_26Mask for antenna ID 26.
ANTENNAMASK_27Mask for antenna ID 27.
ANTENNAMASK_28Mask for antenna ID 28.
ANTENNAMASK_29Mask for antenna ID 29.
ANTENNAMASK_3Mask for antenna ID 3.
ANTENNAMASK_30Mask for antenna ID 30.
ANTENNAMASK_31Mask for antenna ID 31.
ANTENNAMASK_32Mask for antenna ID 32.
ANTENNAMASK_4Mask for antenna ID 4.
ANTENNAMASK_5Mask for antenna ID 5.
ANTENNAMASK_6Mask for antenna ID 6.
ANTENNAMASK_7Mask for antenna ID 7.
ANTENNAMASK_8Mask for antenna ID 8.
ANTENNAMASK_9Mask for antenna ID 9.
ANTENNAMASK_ALLAll antennas mask IDs combined
AT_BAND0 Band 0 frequency in kHz
AT_BAND1 Band 1 frequency in kHz
AT_BAND2 Band 2 frequency in kHz
AT_BAND3 Band 3 frequency in kHz
AT_BAND4 Band 4 frequency in kHz
AT_BAND5 Band 5 frequency in kHz
AT_BANDWIDTH A single band's width in kHz
AT_LAST_BAND Last antenna tune band number.
AT_LOWEST_BANDNUM Lowest band number.
AT_NR_OF_BANDS Number of bands that antenna tuning occurs in.
AUTOTUNE_MODE_ENABLEEnable autotune procedure during RF operations.
AUTOTUNE_MODE_THRESHOLD_ENABLEEnable dBm threshold for autotune procedure.
BANK_EPCEPC memory bank.
BANK_PASSWDPassword memory bank.
BANK_TIDTID memory bank.
BANK_USERUser memory bank.
BR_1000000Baudrate 1000 000 bps
BR_115200Baudrate 115200 bps
BR_1500000Baudrate 1500 000 bps
BR_230400Baudrate 230400 bps
BR_38400Baudrate 38400 bps
BR_500000Baudrate 500000 bps
BR_9600Baudrate 9600 bps
CHERR_CHTIME Custom hop table command error code: Invalid custom hoptable channel time
CHERR_COUNT Custom hop table command error code: Invalid custom hoptable channel count
CHERR_FREQ Custom hop table command error code: Encountered invalid frequency in custom hoptable
CHERR_LBT Custom hop table command error code: Encountered invalid LBT threshold
CHERR_LF Custom hop table command error code: Invalid custom hoptable max LF
CHERR_PAUSETIME Custom hop table command error code: Invalid custom hoptable pause time
CHERR_SIZE Custom hop table command error code: Custom hoptable size mismatch
CHERR_TARI Custom hop table command error code: Invalid custom hoptable Tari
CHERR_TXLIMIT Custom hop table command error code: Encountered invalid maximum TX level
CHIPVER_AS3992 Chip version AS3992.
CHIPVER_AS3993 Chip version AS3993.
CHIPVER_E310 Chip version impinj E310
CHIPVER_E510 Chip version impinj E510
CHIPVER_E710 Chip version impinj E710
CHIPVER_E910 Chip version impinj E910
CHIPVER_R2000 Chip version R2000.
CHIPVER_R2000D Chip version R2000 direct
CUSTHT_TARI_125 Custom hoptable's Tari setting 12.5us.
CUSTHT_TARI_25 Custom hoptable's Tari setting 25us.
CXF_ASWRITE Custom exchange flag: Act if this was a write operation
CXF_CRC5 Custom exchange flag: TX uses CRC-5 instead of CRC-16.
CXF_NORXCRC Custom exchange flag: Do not decode RX CRC, return the response as is.
CXF_NORXLEN Custom exchange flag: Unknown RX length. RX length is ignored.
CXF_NOTXCRC Custom exchange flag: No TX CRC.
CXF_SKIPRESEL Custom exchange flag: Skip tag re-selection during the custom exchange.
CXF_STRIPHND Custom exchange flag: Leave out the bacscattered handle in the response.
CXF_TXONLY Custom exchange flag: Transmit only. No response is expected.
CXF_USEHANDLE Custom exchange flag: RN16 resulting from sinulation shall be appended to the bit stream
CXF_XORRN16 Custom exchange flag: if CXF_ASWRITE == '1' and TX bit length == 16, XOR the TX data with RN16 received from the tag access.
DEFAULT_BAUDRATEDefault baudrate 115200 bps
DIAG_CFG_FW_DEBUG_LOG Diagnostics config flag: Module sends verbose debug log messages. Messages are prefixed with "FW:".
DIAG_CFG_FW_ERROR_LOG Diagnostics config flag: Module sends error log messages. Messages are prefixed with "FW:".
DIAG_CFG_NOTIFY_NONE Diagnostics config flag: Never send diagnostics report notification.
DIAG_CFG_NOTIFY_PERIODIC Diagnostics config flag: Send diagnostics report notification periodically.
DIAG_CFG_NOTIFY_WARN Diagnostics config flag: Send diagnostics report notification on warning/error.
DIAG_GETREPORT_NONE Diagnostics get flag: None
DIAG_GETREPORT_RESET_STATS Diagnostics get flag: Reset all diagnostics statistics to zero.
DIAG_REPORT_LOWVOLT Diagnostics return flag: Set in DiagReport.flags if low voltage is detected. All RF operations will fail with error NUR_ERROR_LOW_VOLTAGE in this stage.
DIAG_REPORT_PERIODIC Diagnostics return flag: Set in DiagReport.flags when module sends periodic report.
DIAG_REPORT_TEMP_HIGH Diagnostics return flag: Set in DiagReport.flags if module temperature is high. Host application SHOULD stop performing RF operations for a while.
DIAG_REPORT_TEMP_OVER Diagnostics return flag: Set in DiagReport.flags if module temperature is over limits. All RF operations will fail with error NUR_ERROR_OVER_TEMP in this stage.
FACTION_0 Filter action for extended inventory: Matching tags: assert SL or inventoried session flag -> A. Non-matching: deassert SL or inventoried session flag -> B.
FACTION_1 Filter action for extended inventory: Matching tags: assert SL or inventoried session flag -> A. Non-matching: do nothing.
FACTION_2 Filter action for extended inventory: Matching tags: do nothing. Non-matching: deassert SL or inventoried session -> B.
FACTION_3 Filter action for extended inventory: Matching tags: negate SL or invert inventoried session flag (A->B, B->A). Non-matching: do nothing.
FACTION_4 Filter action for extended inventory: Matching tags: deassert SL or inventoried session flag -> B. Non-matching: assert SL or inventoried session flag -> A.
FACTION_5 Filter action for extended inventory: Matching tags: deassert SL or inventoried session flag -> B. Non-matching: do nothing.
FACTION_6 Filter action for extended inventory: Matching tags: do nothing. Non-matching: assert SL or inventoried session flag -> A.
FACTION_7 Filter action for extended inventory: Matching tags: do nothing. Non-matching: negate SL or invert inventoried session flag (A->B, B->A).
FW_INFO_REQUEST_SEC_CHIP Parameter value used in GetSecChipFWINFO when requesting secondary chip FW info
GEN2V2_MAX_AUTHBITS Gen2 version 2 "Authenticate": maximum bit length of the message.
GEN2V2_MAX_AUTHBYTES Gen 2 version 2 "Authenticate": maximum byte length of the message.
GEN2V2_MIN_AUTHBITS Gen2 version 2 "Authenticate": minimum bit length of the message.
GPIO_ACT_INVENTORY Start inventory on GPIO/sensor change. Result is received with InventoryStreamEvent notification.
GPIO_ACT_NONE No action. GPIO state can be read manually.
GPIO_ACT_NOTIFY Send IOChangeEvent notification on GPIO/sensor change.
GPIO_ACT_SCANTAG Start single tag scan on GPIO/sensor change. Tag result is received with TriggerReadEvent notification.
GPIO_EDGE_BOTH Trigger IO's configured action on both edges of IO
GPIO_EDGE_FALLING Trigger IO's configured action on falling edge of IO
GPIO_EDGE_RISING Trigger IO's configured action on rising edge of IO
GPIO_TYPE_ANTCTL1 GPIO is configured as antenna control 1 (bit0)
GPIO_TYPE_ANTCTL2 GPIO is configured as antenna control 2 (bit1)
GPIO_TYPE_BEEPER GPIO will act as a beeper (high active)
GPIO_TYPE_INPUT GPIO is configured as input pin.
GPIO_TYPE_OUTPUT GPIO is configured as output pin.
GPIO_TYPE_RFIDON GPIO will act as a Sampo S1 RFID on led (high active)
GPIO_TYPE_RFIDREAD GPIO will act as a Sampo S1 RFID read led (high active)
GPIO1 Module GPIO 1
GPIO2 Module GPIO 2
GPIO3 Module GPIO 3
GPIO4 Module GPIO 4
GPIO5 Module GPIO 5
GPIO6 Module GPIO 6
GPIO7 Module GPIO 7
GPIO8 Module GPIO 8
HOSTFLAGS_EN_UNSOL_ACK When set, module sends ACK request with unsolicited packets.
INVALID_HANDLE_VALUEInvalid handle value (-1)
INVTARGET_A Query tags with inventoried flag set to A
INVTARGET_AB Query tags with inventoried flag set to A or B
INVTARGET_B Query tags with inventoried flag set to B
LAST_ANTENNAIDLast valid antenna ID
LOCK_ACCESSPWDAccess password memory lock mask.
LOCK_EPCMEMEPC memory bank lock mask.
LOCK_KILLPWDKill password memory lock mask.
LOCK_OPENAssociated memory bank is readable from open/secured states.
LOCK_PERMALOCKAssociated memory bank is not writable from any state.
LOCK_PERMAWRITEAssociated memory bank is permanently writable from open/secured states and may never be locked.
LOCK_SECUREDAssociated memory bank is writable only from secured state.
LOCK_TIDMEMTID memory bank lock mask.
LOCK_USERMEMUser memory bank lock mask.
LOG_ALLAll items are logged
LOG_DATALog level data. Data items are shown in the log
LOG_ERRORLog level Error. Errors are logged
LOG_USERLog level User. User defined log items
LOG_VERBOSELog level Verbose
MAX_ANTENNASMaximum number of antennas.
MAX_ANTENNAS_EXMaximum number of antennas in extended version.
MAX_AUTHRESPBITS Gen2 version 2 "Authenticate": maximum expected RX length in bits.
MAX_BITSTR_BITS Maximum number of bits in the custom bit stream.
MAX_BLOCKLOCK_WORDS Maximum number of block permalock words in response or lock parameter.
MAX_CONFIG_REGIONS Maximum number of regions.
MAX_CUSTOM_FREQS Maximum number of custom frequencies in custom hop table.
MAX_EE_EPCLEN Maximum length of an enumerated EPC.
MAX_EE_TIDLEN Maximum length of assigned TID data in EPC enumeration.
MAX_EPC_LENGTH Maximum length of EPC data in bytes.
MAX_EPC_LENGTH_EX Maximum length of EPC data in bytes with extended tag data.
MAX_FCCID_LENGTH Max fccId length.
MAX_FILTERS Maximum number of extended inventory filters.
MAX_FREQUENCY Maximum value of custom hop table frequency in kHz.
MAX_GPIO Maximum number of GPIOs.
MAX_HWVER_LENGTH Max hwVer length.
MAX_IRDATA_LENGTH Maximum length of associated inventory read data
MAX_MAPPINGLEN Maximum name of an antenna mapping.
MAX_NAME_LENGTH Max name length.
MAX_PAUSETIME Maximum value of custom hop table pause time.
MAX_REGION_NAME Maximum length of region name in bytes.
MAX_SCRATCHBYTES Maximum number of bytes to write into a scratch page.
MAX_SCRATCHPAGE Last available user scratch data page in the module.
MAX_SELMASK Maximum length of Select mask data in bytes.
MAX_SERIAL_LENGTH Max serial length.
MAX_TAM_OFFSET ISO29167-10 authentication: maximum block offset/address value.
MAX_WLAN_PROFILE_INDEX Maximum allowed WLAN profile index.
MAXN_ANTMAPPINGS Maximum number of antenna mappings.
MIN_FREQUENCY Minimum value of custom hop table frequency in kHz.
MIN_LBT_THRESHOLDMinimum value for the LBT threshold parameter in SetCustomHoptableEx(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, Int32, UInt32).
MIN_LBTTHRESH Minimum LBT threshold
MIN_SCRATCHBYTES Minimum number of bytes to write into a scratch page.
MIN_SCRATCHPAGE First available user scratch data page in the module.
MODULETYPE_NUR05W Module type NUR05W.
MODULETYPE_NUR05WL Module type NUR05WL.
MODULETYPE_NUR05WL2 Module type NUR05WL2.
MODULETYPE_NUR10W Module type NUR10W (1W module).
MODULETYPE_NUR2_01W Module type nanoNUR-01W
MODULETYPE_NUR2_1W Module type NUR2-1W (1W module).
MODULETYPE_NUR3_RSVD Reserved
MODULETYPE_NUR3FR_1W Module type FR22 integrated nur3
MODULETYPE_NUR3MOD_1W Module type NUR3-1W
NUR_AUTOPER_25 Auto-inventory has one second off time.
NUR_AUTOPER_33 Auto-inventory has 500ms off time.
NUR_AUTOPER_50 Auto-inventory has 100ms off time.
NUR_AUTOPER_FORCE_1000MS Force 1s sleep
NUR_AUTOPER_FORCE_100MS Force 100ms sleep
NUR_AUTOPER_FORCE_500MS Force 500ms sleep
NUR_AUTOPER_OFF Auto-inventory off.
NUR_DC_ANTENNAMAP This module provides antenna mapping information.
NUR_DC_ANTPOWER This module supports per antenna power setting.
NUR_DC_ANTTUNE The antenna or antennas in this device can be tuned.
NUR_DC_BEAMANTENNA This module supports beam forming antenna.
NUR_DC_CHSCANNER This module can run channel scan.
NUR_DC_DIAG Bit is set if this module FW supports diagnostics commands.
NUR_DC_FETCHSINGLE This module supports fetching tags one by one.
NUR_DC_GEN2VER2 Bit is set if this module support Gen 2 version 2 commands (at least partly).
NUR_DC_HASBEEP The device has beeper available.
NUR_DC_HASLIGHT The device has light sensor available.
NUR_DC_HASTAP The device has tap sensor available.
NUR_DC_INVREAD This module supports inventory + read.
NUR_DC_POWEROFS This module supports per antenna low power setting offset -1...1.
NUR_DC_RFPROFILE Bit is set if this module FW supports RF profile setting.
NUR_DC_RXDECFM0 RX modulation FM0.
NUR_DC_RXDECM2 RX modulation Miller-2.
NUR_DC_RXDECM4 RX modulation Miller-4.
NUR_DC_RXDECM8 RX modulation Miller-8.
NUR_DC_RXLF160k Backscatter LF of 160kHz.
NUR_DC_RXLF256k Backscatter LF of 256kHz.
NUR_DC_RXLF320k Backscatter LF of 320kHz.
NUR_DC_RXLF40k Backscatter LF of 40kHz.
NUR_DC_RXLF640k Backscatter LF of 640kHz.
NUR_DC_RXLF80k Backscatter LF of 80kHz.
NUR_DC_RXLFres1 Reserved LF 1.
NUR_DC_RXLFres2 Reserved LF 2.
NUR_DC_TAGPHASE Bit is set if this module FW supports tag phase info. see OPFLAGS_EN_TAG_PHASE
NUR_IR_DATAONLY Inventory read is the type of data only (placed into the EPC field).
NUR_IR_EPCDATA Inventory read is the type of EPC + data.
NUR_IR_EPCXTID The XTID based read is appended to the EPC data.
NUR_IR_XTID_EX_FLAG The flag bit in the inventory + read type that tells whether the TID contents is included in whole or serial only.
NUR_IR_XTIDONLY The XTID based read result is returned in place of the EPC data.
OPFLAGS_EN_EXACT_BLF Return exact BLF in Hz in tag meta data frequency field. Supported only in NUR L2 modules.
OPFLAGS_EN_HOPEVENTS Notification NUR_NOTIFICATION_HOPEVENT is enabled.
OPFLAGS_EN_IR_MEM_OVERRUN Inventory read will report EPC even if there is memory overrun error (f.ex. no user mem bank)
OPFLAGS_EN_NXP_BID NXP Brand ID in NXP UCODE8 tag is enabled
OPFLAGS_EN_PHASE_DIFF Return tag phase angle difference in units of tenths of degrees in tag meta data timestamp field. Supported only in NUR3 modules.
OPFLAGS_EN_TAG_PHASE Return tag phase angle in units of tenths of degrees in tag meta data timestamp field. Supported only in NUR2 modules.
OPFLAGS_EN_TUNEEVENTS

Set this flag to enable the run-time tuning events.

See also the , and .

OPFLAGS_INVSTREAM_ZEROS Inventory stream frunction will report zero count inventory rounds also.
REGIONID_AUSTRALIA Region ID: Australia
REGIONID_BRAZIL Region ID: Brazil
REGIONID_CURRENT Region ID: Represent current region set in to module
REGIONID_CUSTOM Region ID: custom
REGIONID_EU Region ID: Europe
REGIONID_FCC Region ID: North-America
REGIONID_HONGKONG Region ID: Hong Kong.
REGIONID_INDIA Region ID: India.
REGIONID_ISRAEL Region ID: Israel.
REGIONID_JA250MW Region ID: Japan 250mW LBT
REGIONID_JA500MW Region ID: Japan 500mW DRM
REGIONID_KOREA Region ID: Korean LBT.
REGIONID_KOREA_LBT Region ID: Korean LBT. For compatibility
REGIONID_LAST Last region ID.
REGIONID_MALAYSIA Region ID: Malaysia
REGIONID_MOROCCO Region ID: Morocco.
REGIONID_NEWZEALAND Region ID: New Zealand
REGIONID_PERU Region ID: Peru.
REGIONID_PHILIPPINES Region ID: Philippines. For compatibility.
REGIONID_PRC Region ID: People's Republic of China (Upper Band)
REGIONID_RUSSIA Region ID: Russian (EU with first channel missing).
REGIONID_SINGAPORE Region ID: Singapore.
REGIONID_THAILAND Region ID: Thailand. For compatibility.
REGIONID_VIETNAM Region ID: Vietnamese.
RFPROFILE_HIGHSPEED High speed RF profile. This profile provides best throughput, but is prone to RF interference.
RFPROFILE_NOMINAL Nominal RF profile. This profile works good in most environments.
RFPROFILE_ROBUST Robust RF profile. This profile is recommended to use in noisy RF environments.
RW_EA1 Extended address 1. In the singulation data the address is extended i.e. 64-bit instead of 32-bit.
RW_EA2 Extended address 2. In the read and write the address is extended i.e. 64-bit instead of 32-bit.
RW_SBP Singulation block present.
RW_SEC Operation is secured.
RXDECODING_FM0 RX modulation FM0.
RXDECODING_M2Miller-2
RXDECODING_M4Miller-4
RXDECODING_M8Miller-8
RXSENS_HIGH Receiver sensitivity "high".
RXSENS_LOW Receiver sensitivity "low".
RXSENS_NOMINAL Receiver sensitivity "nominal".
SELSTATE_ALL G2 Query sel state: All tags respond, ignoring SL flag
SELSTATE_NOTSL G2 Query sel state: Only tags with SL deasserted responds
SELSTATE_SL G2 Query sel state: Only tags with SL asserted responds
SESSION_S0 Session 0
SESSION_S1 Session 1
SESSION_S2 Session 2
SESSION_S3 Session 3
SESSION_SL SL Flag (filter)
SETUP_ALL All setup flags.
SETUP_ANTMASK antennaMask field in struct ModuleSetup is valid
SETUP_ANTMASKEX antennaMaskEx field in struct NUR_MODULESETUP is valid.
SETUP_AUTOPERIOD periodSetup field in struct ModuleSetup is valid.
SETUP_AUTOTUNE autotune field in struct NUR_MODULESETUP is valid (run-time automatic tuning).
SETUP_INVENTORYTO inventoryTriggerTimeout field in struct ModuleSetup is valid
SETUP_INVEPCLEN inventoryEpcLength field in struct ModuleSetup is valid
SETUP_INVQ inventoryQ field in struct ModuleSetup is valid
SETUP_INVROUNDS inventoryRounds field in struct ModuleSetup is valid
SETUP_INVRSSIFILTER inventoryRssiFilter field in struct ModuleSetup is valid
SETUP_INVSESSION inventorySession field in struct ModuleSetup is valid
SETUP_INVTARGET inventoryTarget field in struct ModuleSetup is valid
SETUP_KILLTIMEOUT killTO field in struct ModuleSetup is valid.
SETUP_LINKFREQ linkFreq field in struct ModuleSetup is valid
SETUP_LOCKTIMEOUT lockTO field in struct ModuleSetup is valid.
SETUP_OPFLAGS opFlags field in struct ModuleSetup is valid
SETUP_PERANTOFFSET perAntOffset field in struct ModuleSetup is valid.
SETUP_PERANTPOWER perAntPower field in struct ModuleSetup is valid.
SETUP_PERANTPOWER_EX The antPowerEx field in struct NUR_MODULESETUP is valid.
SETUP_READRSSIFILTER readRssiFilter field in struct ModuleSetup is valid
SETUP_READTIMEOUT readTO field in struct ModuleSetup is valid.
SETUP_REGION regionId field in struct ModuleSetup is valid
SETUP_RFPROFILE rfProfile field in struct NUR_MODULESETUP is valid.
SETUP_RXDEC rxDecoding field in struct ModuleSetup is valid
SETUP_RXSENS rxSensitivity field in struct NUR_MODULESETUP is valid.
SETUP_SCANSINGLETO scanSingleTriggerTimeout field in struct ModuleSetup is valid
SETUP_SELECTEDANTENNA selectedAntenna field in struct ModuleSetup is valid
SETUP_TO_SLEEP_TIME "To sleep time" field in struct NUR_MODULESETUP is valid.
SETUP_TXLEVEL txLevel field in struct ModuleSetup is valid
SETUP_TXMOD txModulation field in struct ModuleSetup is valid
SETUP_WRITERSSIFILTER writeRssiFilter field in struct ModuleSetup is valid
SETUP_WRITETIMEOUT writeTO field in struct ModuleSetup is valid.
STORE_ALL Store all settings to module internal non-volatile memory.
STORE_BAUDRATE Store baudrate settings to module internal non-volatile memory.
STORE_GPIO Store GPIO/Sensor settings to module internal non-volatile memory.
STORE_OPFLAGS Store Opflags settings to module internal non-volatile memory.
STORE_RF Store RF settings to module internal non-volatile memory.
SZ_NUR_DEVCAPS Constant size of the device capabilites.
SZ_TAM2_BLOCKISO29167-10 authentication: size of single custom data block in bytes.
SZ_TAM2_CMACLEN ISO29167-10 authentication: size of protection mode 2,3 CMAC in bytes.
TAM_KEYLEN ISO29167-10 authentication: key length.
TAM_MAXBLOCKS ISO29167-10 authentication: maximum block at once.
TID_HIDE_ALL Gen2 version 2 TID hide policy: hide all.
TID_HIDE_NONE Gen2 version 2 TID hide policy: hide none.
TID_HIDE_SOME Gen2 version 2 TID hide policy: hide some.
TRACETAG_NO_EPCDo not transfer EPC back from trace tag function.
TRACETAG_START_CONTINUOUSStart continuous tag tracing.
TRACETAG_STOP_CONTINUOUSStop continuous tag tracing.
TUNE_REVERT_FACTORY Restore tuning from factory defaults to currently used .
TUNE_REVERT_OVERRIDE Override currently used and user saved tuning with factory defaults.
TUNE_REVERT_USER Restore tuning from user memory.
TUNEBAND_EU EU tuning band definition.
TUNEBAND_FCC1 FCC lower tuning band definition.
TUNEBAND_FCC2 FCC upper tuning band definition.
TUNETYPE_FAST 
TUNETYPE_FULL 
TUNETYPE_MEDIUM 
TUNETYPE_WIDE 
TXMODULATION_ASKTX modulation
TXMODULATION_PRASKPR-ASK
UTRACE_RANGE_NORMAL Gen2 version 2: Untraceable's range reduction policy: normal.
UTRACE_RANGE_REDUCE Gen2 version 2: Untraceable's range reduction policy: reduce.
UTRACE_RANGE_TOGGLEGen2 version 2: Untraceable's range reduction policy: toggle (NOTE: not supported at the moment).
XPC_W1_MASK The XPC_W1 presence mask.
XPC_XEB_MASK The XPC_W2 presence mask.

See Also