Metratec devices library 3.1.1.0
Public Member Functions | Protected Member Functions | List of all members
MetraTecDevices.PulsarLR Class Reference

The right tool for the hardest UHF RFID applications. With the new Impinj E710 at the heart of the reader, this product can reach a reading distance of up to 12m with a modern UHF RFID transponder and easily scan a few hundred tags per second. More...

Inheritance diagram for MetraTecDevices.PulsarLR:
MetraTecDevices.UhfReaderGen2 MetraTecDevices.MetratecReaderGen2< UhfTag >

Public Member Functions

 PulsarLR (string ipAddress, int tcpPort)
 Creates a new MetraTecDevices.PulsarLR instance.
 
 PulsarLR (string ipAddress, int tcpPort, ILogger logger)
 Creates a new MetraTecDevices.PulsarLR instance.
 
int GetAntennaPower (int antenna)
 Gets the current antenna power.
 
void SetAntennaPower (int antenna, int power)
 Sets the antenna power.
 
int GetMultiplexer (int antennaPort)
 Get the connected multiplexer (connected antennas per antenna port)
 
void SetMultiplexer (int antennaPort, int multiplexer)
 Sets the connected multiplexer (connected antennas per antenna port)
 
void SetHighOnTag (HighOnTagSetting settings)
 Enable the "high on tag" feature which triggers the selected output to go to the "high" state, when a tag is found. This allows to trigger an external device whenever a tag is in the field. This corresponds to the blue LED.
 
HighOnTagSetting GetHighOnTag ()
 Gets the current high on tag feature setting.
 
- Public Member Functions inherited from MetraTecDevices.UhfReaderGen2
 UhfReaderGen2 (ICommunicationInterface connection)
 The reader class for all Metratec reader.
 
 UhfReaderGen2 (ICommunicationInterface connection, ILogger logger)
 The reader class for all Metratec reader.
 
 UhfReaderGen2 (ICommunicationInterface connection, string id)
 The reader class for all Metratec reader.
 
 UhfReaderGen2 (ICommunicationInterface connection, string id, ILogger logger)
 The reader class for all Metratec reader.
 
InventorySettings GetInventorySettings ()
 Return the current inventory settings.
 
void SetInventorySettings (InventorySettings settings)
 Sets the inventory settings.
 
TagCountSetting GetTagCountSetting ()
 Returns the tag count setting.
 
void SetTagCountSettings (TagCountSetting settings)
 Sets the expected tag count.
 
override void SetPower (int power)
 Set the reader power.
 
int GetPower ()
 Get the current reader power.
 
void SetRegion (REGION_GEN2 region)
 Set the region.
 
REGION_GEN2 GetRegion ()
 Get the current region.
 
override List< UhfTagGetInventory ()
 Scan for the current inventory.
 
List< UhfTagGetInventoryReport ()
 Get the current inventory report.
 
override void StartInventory ()
 Starts the continuous inventory scan. Make sure that the inventory is set.
 
void StartInventoryReport ()
 Start the continuous inventory report scan.
 
void StopInventoryReport ()
 Stops the continuous inventory report scan.
 
void SetMask (MEMBANK_GEN2 membank, int startAddress, string mask)
 Set the reader mask.
 
void SetEpcMask (string mask)
 Set the epc mask.
 
void SetEpcMask (int startAddress, string mask)
 Set the epc mask.
 
void ResetMask ()
 Reset/Disable the current reader mask.
 
void SetBitmask (MEMBANK_GEN2 membank, int startAddress, string mask)
 Set the reader bit mask.
 
void ResetBitmask ()
 Reset/Disable the current reader bitmask.
 
List< UhfTagReadTagData (MEMBANK_GEN2 memory, int startAddress, int length, String epcMask="")
 Read tag data.
 
List< UhfTagReadTagTid (int startAddress, int length, String epcMask="")
 Read the tag TIDs.
 
List< UhfTagReadTagUsrData (int startAddress, int length, String epcMask="")
 Read the tag user data.
 
List< UhfTagWriteTagData (MEMBANK_GEN2 memory, int startAddress, string data, string epcMask="")
 Write data to a tag.
 
- Public Member Functions inherited from MetraTecDevices.MetratecReaderGen2< UhfTag >
 MetratecReaderGen2 (ICommunicationInterface connection)
 The reader class for all Metratec reader.
 
 MetratecReaderGen2 (ICommunicationInterface connection, ILogger logger)
 The reader class for all Metratec reader.
 
 MetratecReaderGen2 (ICommunicationInterface connection, string id)
 The reader class for all Metratec reader.
 
 MetratecReaderGen2 (ICommunicationInterface connection, string id, ILogger logger)
 The reader class for all Metratec reader.
 
override string ExecuteCommand (string command, int timeout=10000)
 Send a command and returns the response.
 
override bool GetInput (int pin)
 Returns true if the input pin is high, otherwise false.
 
void EnableInputEvents (bool enable=true)
 Enable or disable input events.
 
override void SetOutput (int pin, bool value)
 Sets a output pin.
 
bool GetOutput (int pin)
 Returns true if the output pin is high, otherwise false.
 
override void SetAntenna (int antennaPort)
 Sets the current antenna to use.
 
int GetAntenna ()
 Gets the current used single antenna.
 
override void SetAntennaMultiplex (int antennasToUse)
 Sets the number of antennas to be multiplexed.
 
void SetAntennaMultiplex (List< int > antennaSequence)
 Sets the antenna multiplex sequence. Set the order in which the antennas are activated.
 
virtual List< int > GetAntennaMultiplex ()
 Gets the number of antennas to be multiplexed.
 
override void StopInventory ()
 Stops the continuous inventory scan.
 

Protected Member Functions

override void ConfigureReader ()
 Configure the reader. The base implementation must be called after success.
 
List< int > GetCurrentAntennaPowers ()
 the power value per antenna (index 0 == antenna 1)
 
void SetCurrentAntennaPowers (List< int > antennaPowers)
 set the power values for the antennas
 
List< int > GetCurrentConnectedMultiplexer ()
 Gets the configured multiplexer size per antenna (index 0 == antenna 1)
 
void SetCurrentConnectedMultiplexer (List< int > connectedMultiplexer)
 set the power values for the antennas
 
- Protected Member Functions inherited from MetraTecDevices.UhfReaderGen2
override void PrepareReader ()
 Configure the reader. The base implementation must be called after success.
 
override void ConfigureReader ()
 Configure the reader. The base implementation must be called after success.
 
override void HandleInventoryEvent (string response)
 Parse the inventory event (+CINV, +CMINV, +CINVR)
 
- Protected Member Functions inherited from MetraTecDevices.MetratecReaderGen2< UhfTag >
void SetCommand (String command)
 Send a command and check if the response contains "OK".
 
String GetCommand (String command)
 Send a command and check if the response contains "OK".
 
string[] SplitResponse (string response)
 Split a multiline response (and check the crc)
 
string[] SplitLine (string responseLine)
 Split a line response (and check the crc)
 
void FireInputChangeEvent (int inputPin, bool isHigh)
 Fire a inventory event.
 
override void HandleResponse (string response)
 Process the reader response...override for event check The base implementation must be called after success.
 
abstract void HandleInventoryEvent (string response)
 Parse the inventory event (+CINV, +CMINV, +CINVR)
 
override void PrepareReader ()
 Configure the reader. The base implementation must be called after success.
 
override void ConfigureReader ()
 Configure the reader. The base implementation must be called after success.
 
InvalidOperationException ParseErrorResponse (String response)
 Parse the error response and throw a InvalidOperationException with a detailed message.
 
override void SetHeartBeatInterval (int intervalInSec)
 Set the HeartBeatInterval ... override for send the heartbeat command. The base implementation must be called after success.
 
override void UpdateDeviceRevisions ()
 Returns the firmware revision ({firmware} {version})
 

Additional Inherited Members

- Properties inherited from MetraTecDevices.MetratecReaderGen2< UhfTag >
int CurrentAntennaPort [get, set]
 Current antenna port.
 
bool SingleAntennaInUse [get, set]
 True, if a single antenna is in use.
 
- Events inherited from MetraTecDevices.MetratecReaderGen2< UhfTag >
EventHandler< InputChangedEventArgs >? InputChanged
 Input change event handler.
 

Detailed Description

The right tool for the hardest UHF RFID applications. With the new Impinj E710 at the heart of the reader, this product can reach a reading distance of up to 12m with a modern UHF RFID transponder and easily scan a few hundred tags per second.

he four antenna ports give you the flexibility to build complex RFID devices, such as RFID gates and tunnels. The number of antennas can further be extended using our multiplexers to up to 64 read points if you want to build an RFID smart shelve or a similar application.

Constructor & Destructor Documentation

◆ PulsarLR() [1/2]

MetraTecDevices.PulsarLR.PulsarLR ( string  ipAddress,
int  tcpPort 
)

Creates a new MetraTecDevices.PulsarLR instance.

Parameters
ipAddressThe device IP address
tcpPortThe device TCP port used

◆ PulsarLR() [2/2]

MetraTecDevices.PulsarLR.PulsarLR ( string  ipAddress,
int  tcpPort,
ILogger  logger 
)

Creates a new MetraTecDevices.PulsarLR instance.

Parameters
ipAddressThe device IP address
tcpPortThe device TCP port used
loggerthe logger

Member Function Documentation

◆ GetAntennaPower()

int MetraTecDevices.PulsarLR.GetAntennaPower ( int  antenna)

Gets the current antenna power.

Parameters
antennathe antenna
Returns
the current antenna power
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ GetCurrentAntennaPowers()

List< int > MetraTecDevices.PulsarLR.GetCurrentAntennaPowers ( )
protected

the power value per antenna (index 0 == antenna 1)

Returns
List with the power values
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ GetCurrentConnectedMultiplexer()

List< int > MetraTecDevices.PulsarLR.GetCurrentConnectedMultiplexer ( )
protected

Gets the configured multiplexer size per antenna (index 0 == antenna 1)

Returns
List with the configured multiplexer size
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ GetHighOnTag()

HighOnTagSetting MetraTecDevices.PulsarLR.GetHighOnTag ( )

Gets the current high on tag feature setting.

Returns
the current high on tag setting
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error
T:System.TimeoutExceptionThrown if the reader does not responding in time
T:System.ObjectDisposedExceptionIf the reader is not connected or the connection is lost

◆ GetMultiplexer()

int MetraTecDevices.PulsarLR.GetMultiplexer ( int  antennaPort)

Get the connected multiplexer (connected antennas per antenna port)

Parameters
antennaPortthe antenna port to which the multiplexer is connected
Returns
the multiplexer size
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ SetAntennaPower()

void MetraTecDevices.PulsarLR.SetAntennaPower ( int  antenna,
int  power 
)

Sets the antenna power.

Parameters
antennathe antenna
powerthe rfid power to set
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ SetCurrentAntennaPowers()

void MetraTecDevices.PulsarLR.SetCurrentAntennaPowers ( List< int >  antennaPowers)
protected

set the power values for the antennas

Parameters
antennaPowerslist with the multiplexer size for each antenna
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ SetCurrentConnectedMultiplexer()

void MetraTecDevices.PulsarLR.SetCurrentConnectedMultiplexer ( List< int >  connectedMultiplexer)
protected

set the power values for the antennas

Parameters
connectedMultiplexerlist with the multiplexer size for each antenna
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

◆ SetHighOnTag()

void MetraTecDevices.PulsarLR.SetHighOnTag ( HighOnTagSetting  settings)

Enable the "high on tag" feature which triggers the selected output to go to the "high" state, when a tag is found. This allows to trigger an external device whenever a tag is in the field. This corresponds to the blue LED.

Parameters
settingsthe high on tag parameter
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error
T:System.TimeoutExceptionThrown if the reader does not responding in time
T:System.ObjectDisposedExceptionIf the reader is not connected or the connection is lost

◆ SetMultiplexer()

void MetraTecDevices.PulsarLR.SetMultiplexer ( int  antennaPort,
int  multiplexer 
)

Sets the connected multiplexer (connected antennas per antenna port)

Parameters
antennaPortthe antenna port to which the multiplexer is connected
multiplexerthe multiplexer size
Exceptions
T:System.InvalidOperationExceptionIf the reader return an error

The documentation for this class was generated from the following file: