NurApiModuleSetup Class

Module settings data.

Definition

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

Constructors

NurApiModuleSetupInitializes a new instance of the NurApiModuleSetup class

Properties

ReturnedFlags ModuleSetup flags returned when last fetched from NUR.

Methods

Clone 
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
ToString
(Inherited from Object)

Fields

antennaMask Bitmask of enabled antennas. Mask constants in range ANTENNAMASK_1...ANTENNAMASK_32.
antennaMaskEx Extended version of the antenna mask.

Remarks

Supported in L2 module from FW version 5.0-A onwards.

Remarks

Recommedation is to use only this with L2 from FW version 5.0-A onwards.
antPowerEx Extended version per antenna power settings.
autotune Runtime autotuning setup, setup: NurApiAutotuneSetup
inventoryEpcLength

The exact EPC reception length in bytes.

Use even values in range 2...62 or -1 for "accept all".

inventoryQ

Inventory Q (see InventoryQ property).

Range is from 0 to 15 where zero means "automatic Q".

inventoryRounds

Module's Internal inventory rounds per call (see InventoryRounds property).

Range is from 0 to 10 where zero means "automatic rounds".

inventoryRssiFilter

RSSI Filters used for inventory operations.

Required module firmware 2.5-A or later or NUR05WL2 module.

inventorySession

Session (see InventorySession property)

Valid session is 0...3.

inventoryTarget Inventory target, select whether tags whose inventoried flag is: 0 = A, 1 = B, 2 = A or B (dual target).
inventoryTriggerTimeout

Triggered Inventory timeout in milliseconds.

Range is 0...60000, unit is milliseconds.

killTO Tag kill timeout in ms.
linkFreq

Link frequency. See also the link frequency property: LinkFrequency.

160000/256000/320000 = 160/256/320 kHz.

lockTO Tag lock timeout in ms.
opFlags Operation flags.

Enable hop events: OPFLAGS_EN_HOPEVENTS

Enable "zero tags found" notification during inventory streams: OPFLAGS_INVSTREAM_ZEROS

The value can be either of the above flags, none or both. OR-operation can be used as these flags are bits.

perAntOffset DEPRECATED! Per antenna specific power levels. Use antPowerEx instead.
Obsolete.
perAntPower DEPRECATED! Per antenna specific power levels. Use antPowerEx instead.
Obsolete.
periodSetup

Defines how the periodic auto-inventory power saving is configured.

When in use, reader will be power save mode while no tags in view.

Settings: NUR_AUTOPER_OFF, NUR_AUTOPER_25, NUR_AUTOPER_33 and NUR_AUTOPER_50.

readRssiFilter

RSSI Filters used for read operations.

Required module firmware 2.5-A or later or NUR05WL2 module.

readTO Tag read timeout in ms.
regionId

Region ID. See also the Region property.

rfProfile RF Profile: RFPROFILE_ROBUST, RFPROFILE_NOMINAL and RFPROFILE_HIGHSPEED.
rxDecoding

RX encoding (Miller encoding) (seeRxDecoding property)

FM0: RXDECODING_FM0 (least robust reception)

Miller-2: RXDECODING_M2

Miller-4: RXDECODING_M4

Miller-8: RXDECODING_M8

rxSensitivity Receiver sensitivity: RXSENS_LOW, RXSENS_NOMINAL and RXSENS_HIGH.
scanSingleTriggerTimeout Triggered SingleScan scanning timeout in milliseconds.
selectedAntenna Zero based index of selected antenna.

Values are in range ANTENNAID_1...ANTENNAID_32.

Use value ANTENNAID_AUTOSELECT to make the module automativally select the antenna.

toSleepTime Time before module enters deep sleep in milliseconds. 0 disables deep sleep. NOTE: When module is in deep sleep there might be slight (100ms) delay before command is executed.
txLevel Transmission (TX) power level in 1dB steps. See also the TxLevel property)

Range is 0...19: there are 20 (0...19) steps so minimum output power value for 500mW devices is 8dBm (about 6mW) and 11dBm (about 40W) for the 1W devices.

This value is subtracted from the maxiumum TX level producing the actual level as follows:

TX LevelPower dBm / mW (500 mW device)Power dBm / mW (1W device)
027 / 50030 / 1000
126 / 39829 / 794
225 / 31628 / 631
324 / 25127 / 501
423 / 20026 / 398
522 / 15825 / 316
621 / 12624 / 251
720 / 10023 / 200
819 / 7922 / 158
918 / 6321 / 126
1017 / 5020 / 100
1116 / 4019 / 79
1215 / 3218 / 63
1314 / 2517 / 50
1413 / 2016 / 40
1512 / 1615 / 32
1611 / 1314 / 25
1710 / 1013 / 20
189 / 812 / 16
198 / 611 / 13
txModulation

Tx modulation style (seeTxModulation property).

The TX modulation is either ASK (TXMODULATION_ASK) or PR-ASK (TXMODULATION_PRASK).

writeRssiFilter

RSSI Filters used for write operations.

Required module firmware 2.5-A or later or NUR05WL2 module.

writeTO Tag write timeout in ms.

See Also