Constructor Detail

• RFIDReader

  public RFIDReader(String sIpAddress,
                    UInt16 iPortNumber, RFID.Reader.TagReadHandler continuousTagReadHandler)

  Group:

  Communications Setup and Control

  Method:

  constructor RFIDReader(String sIpAddress, int iPortNumber, RFID.Reader.TagReadHandler continuousTagReadHandler)

  Summary:

  This method creates an instance of the RFIDReader class and creates the underlying communications class while registering a callback that matches the TagReadHandler interface.

  Parameters:

  sIpAddress - Input parameter with dotted format IP address (e.g. "192.168.1.150").

  iPortNumber - Input parameter with the TCP port that the primary command communication will take place over.

  continuousTagReadHandler - This parameter specifies a callback routine that is called each time tag data is reported during a continuous inventory cycle.

  ReturnType:

  An object instance of the RFIDReader class is returned when a new version of this class is instantiated.

  Exceptions:

  A System.FormatException will be thrown if the IP Address string is not a valid dot notation IP address.

• RFIDReader

  public RFIDReader(Strings IpAddress,
                            UInt16 iPortNumber, RFID.Reader.TagReadHandler2 continuousTagReadHandler)

  Group:

  Communications Setup and Control

  Method:

  constructor RFIDReader(String sIpAddress, int iPortNumber, RFID.Reader.TagReadHandler2 continuousTagReadHandler)

  Summary:

  This method creates an instance of the RFIDReader class and creates the underlying communications class while registering a callback that matches the TagReadHandler2 interface.

  Parameters:

  sIpAddress - Input parameter with dotted format IP address (e.g. "192.168.1.150").

  iPortNumber - Input parameter with the TCP port that the primary command communication will take place over.

  continuousTagReadHandler - This parameter specifies a callback routine that is called each time tag data is reported during a continuous inventory cycle.

  See the definition of TagReadInfo shown above under the description for the constructor that accepts a callback of the TagReadHandler delegate type.

  This handler will pass back the RFIDReader object that the callback is registered with so that the application can determine the specific reader instance corresponding to the received tag data.

  ReturnType:

  An object instance of the RFIDReader class is returned when a new version of this class is instantiated.

  Exceptions:

  A System.FormatException will be thrown if the IP Address string is not a valid dot notation IP address.

• RFIDReader

  public RFIDReader(Strings IpAddress, UInt16 iPortNumber, 
                                          RFID.Reader.SensorDataReadHandler sensorDataReadHandler, Object obj)

  Group:

  Communications Setup and Control

  Method:

  constructor RFIDReader(String sIpAddress, int iPortNumber, RFID.Reader.SensorDataREadHandler SensorDataREadHandler)

  Summary:

  This method creates an instance of the RFIDReader class and creates the underlying communications class while registering a callback that matches the SensorDataREadHandler interface.

  Parameters:

  sIpAddress - Input parameter with dotted format IP address (e.g. "192.168.1.150").

  iPortNumber - Input parameter with the TCP port that the primary command communication will take place over.

  SensorDataReadHandler - This parameter specifies a callback routine that is called each time tag data is reported during a continuous inventory cycle.

  obj

  ReturnType:

  An object instance of the RFIDReader class is returned when a new version of this class is instantiated.

  Exceptions:

  A System.FormatException will be thrown if the IP Address string is not a valid dot notation IP address.

• RFIDReader

  public RFIDReader(Strings IpAddress, UInt16 iPortNumber)

  Group:

  Communications Setup and Control

  Method:

  constructor RFIDReader(String sIpAddress, int iPortNumber)

  Summary:

  This method creates an instance of the RFIDReader class and creates the underlying communications class.

  Parameters:

  sIpAddress - Input parameter with dotted format IP address (e.g. "192.168.1.150").

  iPortNumber - Input parameter with the TCP port that the primary command communication will take place over.

  ReturnType:

  An object instance of the RFIDReader class is returned when a new version of this class is instantiated.

  Exceptions:

  A System.FormatException will be thrown if the IP Address string is not a valid dot notation IP address.

Method Detail

• ClearErrorList

  public RFIDStatus ClearErrorList()

  Method:

  RFIDStatus ClearErrorList()

  Summary:

  This command clears the internal error list held by the sensor

  Returns:

  This function will return RFIDStatus.OK if it is able to clear the sensor's errorlist. It will return RFIDStatus.Failed otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The error list accumulates from the time the sensor starts or from the time the list is cleared. To conserve space, up to 32 errors will be recorded. Once the list is full, it overwrite the oldest error keeping the most recent 32 errors.

• ClearInventoryFilter

  public RFIDStatus ClearInventoryFilter(boolean makePersistent)

  Method:

  RFIDStatus ClearInventoryFilter(Boolean makePersistent)

  Summary:

  This method clears the filter used during tag inventory cycles.

  Parameters:

  makePersistent - This parameter specifies whether or not any filter saved in the module should be permanently cleared. If set to false, the next time the module reboots, the prior saved filter will become active again.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the filter. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  This is a convenience method that simply calls SetInventoryFilter(filter) with 0 values.

• Get24VStatus

  public RFIDStatus Get24VStatus(ref Boolean V24State, ref Boolean V24OnAtStartup)

  Method:

  RFIDStatus Get24VStatus(ref Boolean V24State, ref Boolean V24OnAtStartup)

  Summary:

  This method returns the current setup of the 24V DC output on the GPIO connector as well as what its state is when the sensor is started or restarted.

  Parameters:

  V24State - This output parameter is true if the 24VDC power is turned on, and false when it is turned off.

  V24OnAtStartup - This output parameter is true if the 24VDC power is turned on, and false when it is turned off.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the status of the 24V DC power supply. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• GetAntennaPowers

  public RFIDStatus GetPowerSettings(ref Double[] readPower, ref Double[] writePower)

  Methods:

  RFIDStatus GetPowerSetting(ref Double[] readPower, ref Double[] writePower)

  Summary:

  Returns the read power and write power level settings in dBm of the internal antenna (index 0) and the three external antennas (indexes 1, 2, and 3)

  Parameters:

  ReadPower - Four element array returning the read power levels in dBm for each of the readers antennas.

  WritePower - Four element array returning the write power levels in dBm for each of the readers antennas.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the antennas read power and write power. It will return RFIDStatus.FAILED otherwise

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  This method will always return both arrays with four elements even when interrogating a 2-port device. In that situation, the last 3 elements of each array are set to 0 dBm. Since the valid power range is typically greater than 5 dBm, this acts as an indicator of the number of elements. In the future, the overloaded version with the number of antennas as an output can be used.

• GetTemperatureProtect

  public GetTemperatureProtect GetTemperatureProtect(ref Boolean tempProtectOn)

  Methods:

  RFIDStatus GetTemperatureProtect(ref Boolean tempProtectOn)

  Summary:

  Returns the status of the modules temperature protection status.

  Parameters:

  TemperatureProtectOn - This parameter will be set to True if the module's temperature protection setting is active. It will be set to False if the temperature protection

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the antennas read power and write power. It will return RFIDStatus.FAILED otherwise

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetAntennaPowers

  public RFIDStatus GetActiveAntenna(ref UInt32 activeAntenna)

  Methods:

  RFIDStatus GetActiveAntenna(ref UInt32 activeAntenna)

  Summary:

  Returns the numeric value of the currently active antenna.

  Parameters:

  ActiveAntenna - On return, this parameter will hold the value of the active antenna. Value returned will be between 0 and 3.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the antennas read power and write power. It will return RFIDStatus.FAILED otherwise

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetEpicStatus

  public GetEpicStatus GetEpicStatus(out Byte epicMode, out Boolean epicEnabled, out Boolean customerKeyLoaded, out String customerId, out String codecId)

  Methods:

  RFIDStatus GetEpicStatus(out Byte epicMode, out Boolean epicEnabled, out Boolean customerKeyLoaded, out String customerId, out String codecId

  Summary:

  This method returns whether EPIC is enabled in the reader as well as status and information about the EPIC customer key.

  Parameters:

  epicMode - RFU. This will return the setting for level of FEC turned on in the reader. Will return 0 for now.

  epicEnabled - Returns true if EPIC decoding is enabled, false if it is disabled.

  customerKeyLoaded - Returns true if an EPIC Customer Key has been loaded, false otherwise.

  customerId - Returns the Customer Id from the EPIC Customer Key if a key has been loaded. Returns an empty string if no key has been loaded.

  codecId - Returns the Codec Id authorized by the EPIC Customer Key if a key has been loaded. Returns an empty string if no key has been loaded.

  Returns:

  This function will return RFIDStatus.OK if a valid response is received from the sensor.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetAutoSensProgram

  public GetAutoSensProgram GetAutoSensProgram(out String MacroProgram)

  Methods:

  RFIDStatus GetAutoSensProgram(out String MacroProgram)

  Summary:

  This method returns a string of semicolon (';') separated SensArray macros corresponding to the currently active AutoSens macro program.

  Parameters:

  MacroProgram - This return parameter will contain the String representing the macro program.

  Returns:

  This function will return RFIDStatus.OK if a valid response is received from the sensor.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetAutoSensStartupState

  public GetAutoSensStartupState GetAutoSensProgram(out Boolean running)

  Methods:

  RFIDStatus GetAutoSensStartupState(out Boolean running)

  Summary:

  This method takes a Boolean value indicating whether the specified AutoSens program is to be automatically run when the reader reboots.

  Parameters:

  Running - The Running output parameter will be returned as true if the reader has been configured to automatically start the AutoSens program when the reader is rebooted. It will return false if the reader is not setup to start the AutoSens program on reboot.

  Returns:

  This method will always return RFIDStatus.OK.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the sensor doesn't respond.

• GetAntennaPowers

  public RFIDStatus GetPowerSettings(out int numberOfAntennas, ref Double[] readPower, ref Double[] writePower)

  Methods:

  RFIDStatus GetPowerSetting(out int numberOfAntennas, ref Double[] readPower, ref Double[] writePower)

  Summary:

  Returns the read power and write power level settings in dBm of the internal antenna (index 0) and the three external antennas (indexes 1, 2, and 3)

  Parameters:

  NumberOfAntennas - The number of antennas for the reader configuration (2-port vs. 3-port) is returned by this parameter. It will return 1 for the 2-port readers and 4 for the 3-port readers.

  ReadPower - Four element array returning the read power levels in dBm for each of the readers antennas.

  WritePower - Four element array returning the write power levels in dBm for each of the readers antennas.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the antennas read power and write power. It will return RFIDStatus.FAILED otherwise

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  This method will always return both arrays with four elements even when interrogating a 2-port device. In that situation, the last 3 elements of each array are set to 0 dBm. Since the valid power range is typically greater than 5 dBm, this acts as an indicator of the number of elements. In the future, the overloaded version with the number of antennas as an output can be used.

• GetBluetoothConfiguration

  public RFIDStatus GetBluetoothConfiguration(out String Address)
                                     throws java.lang.Exception

  Method:

  RFIDStatus GetBluetoothConfiguration(out String Address)

  Summary:

  This method retrieves the address of the Bluetooth device that the reader is configured to send data to.

  Parameters:

  Address - This parameter returns the Bluetooth device the reader will send data to. The address returned will be a String formatted as ##.##.##.##.##.## where "#" represents a hexidecimal digit (0-9, A-F). Note that this method will return an empty string (length 0) if the Bluetooth address has not been set on your reader.

  Returns:

  This method will return RFIDStatus.OK if the Address can be retrieved, otherwise the method will return RFID.Status.Failed.

  Throws:

  A System.TimeoutException will be thrown if a connection to the reader cannot be established or the reader doesn't respond.

• GetBootLoaderInfo

  public RFIDStatus GetBootloaderInfo(ref UInt16 bootloaderPort)

  public RFIDStatus GetBootloaderInfo(out UInt16 bootloaderPort, out int versionMinor, out int versionMajor)

  Method:

  RFIDStatus GetBootloaderInfo(ref UInt16 bootloaderPort)

  RFIDStatus GetBootloaderInfo(out UInt16 bootloaderPort, out int versionMajor, out int versionMinor)

  Summary:

  These methods return the Ethernet port over which firmware updates are perfromed. The second interface also returns the major and minor version numbers of the underlying bootloader code. If your application simply needs to know what port is configured for communicating with the bootloader, use the first call.

  Parameters:

  bootloaderPort -This parameter returns the UDP Ethernet port over which the application firmware is communicated to the reader.

  versionMajor, versionMinor - This parameter return the major and minor version numbers of the installed bootloader.)

  Returns:

  This function will return CommandStatus.OK if it is able to read and return the bootloader Ethernet communication port and the version information. It will return CommandStatus.Failed otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetConnectionInfo

  public RFIDStatus GetConnectionInfo(Byte connectionNumber, out String connectionString)

  Method:

  RFIDStatus GetConnectionInfo(Byte connectionNumber, out String connectionString)

  Summary:

  When a data notification macro is specified in an AutoSens program, the data is sent to a connection (0-4) based on the connection information specified by the connection string. The connection string is in the format "IP_Address:PortNumber". Generally, an AutoSens program will deliver data to at most a single connection, we allow up to 5 connections to be specified if more than one is needed by a configuration.

  Parameters:

  ConnectionNumber -This input parameter specifies the connection number to which the ConnectionString is associated. The connection number can have values from 0 through 4.

  ConnectionString - The ConnectionString is an input parameter comprised of an IPv4 address in dotted notation (111.222.1.2) followed by a ":" followed by a port number in the range from 0 to 65535. As an example, a connection to be established to port 8100 on a server with IP address 192.168.8.12 would be specified as "192.168.8.12:8100" (without the quotation marks).

  Returns:

  This method will return RFIDStatus.OK if the ConnectionNumber is between 0 and 4 and the ConnectionString is a combination of a valid IPv4 Address and a port number between 0 and 65535 separated by a ":". It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetDRMState

  public RFIDStatus GetDRMState(out Boolean drmIsOn)

  Method:

  RFIDStatus GetDRMState(out Boolean drmIsOn)

  Summary:

  The method returns the current DRM setting for RF Mode 1 (M4/250kHz)

  Parameters:

  drmIsOn - This value will be true is drmIsOn for RF Mode 1, false if it is off.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the DRM setting for RF Mode 1. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetConnectedAntennas

  public RFIDStatus GetConnectedAntennas(out Int32 AntennaCount, out Boolean[] AntennaIsConnected)

  Method:

  RFIDStatus GetConnectedAntennas(out Int32 AntennaCount, out Boolean[] AntennaIsConnected)

  Summary:

  This method returns queries each of the ports of the integrated reader and returns an array sized appropriately for the reader of boolean (true/false) values indicating whether each of the port is connected or not.

  Parameters:

  AntennaCount - Output specifying the number of antennas ports for the reader. For the current product offering, this number will be 1 for the 2-port reader and 4 for the 3-port reader

  AntennaIsConnected - The parameter returns an array of Boolean values. A "true" value indicates a reasonably matched antenna is attached. A "false" value indicates that an antenna is not attached. (However, see the notes below.)

  Returns:

  This function will return RFIDStatus.OK if it is able to communicate with the reader and obtain information about whether an antenna is connected. RFIDStatus.Failed will be returned otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  In addition to the external antenna ports, we return info regarding the internal port. Generally, the first element in the AntennaIsConnected array will return true.
  We have found that if the antenna is in a place where there is a lot of metal in front of the antenna resulting in much of the transmitted RF power being reflected back at the antenna, this method will indicate that the antenna port is not connected even when an antenna is present

• GetErrorList

  public RFIDStatus GetErrorList(ref UInt32 NumberOfErrors, ref UInt32[] When, ref Uint16[] Code, ref Int16[] DByte1, ref Int16[] DByte2)

  Method:

  RFIDStatus GetErrorList(ref UInt32 NumberOfErrors, ref UInt32[] When, ref Uint16[] Code, ref Int16[] DByte1, ref Int16[] DByte2)

  Summary:

  This method returns the list of errors detected and recorded by the sensor

  Parameters:

  NumberOfErrors - Output value returning the number of errors detected by the sensor.

  When - An array of timestamps, in seconds, for when the error were detected relative when the sensor was started (uptime).

  Code - Output parameter returning an array of error codes for the detected errors.

  DByte1, DByte2 - These two arrays return two additional bytes of data relevant to the particular type of error that has been recorded.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the error list. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The specific error codes are documented in the "SensArray Communications Protocol" document.

• GetFirmwareBuild

  public RFIDStatus GetFirmwareBuild(out String FirmwareBuild)

  Method:

  RFIDStatus GetFirmwareBuild(out String FirmwareBuild)

  Summary:

  This method retrieves the reader's firmware build.

  Parameters:

  FirmwareBuild - Output returning the firmware build number of the reader

  Returns:

  This function will return RFIDStatus.OK if it is able to get the sensor's build version. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The value returned has the format B.YY.MM.DD.RR where YY is the year of the build, MM is the month, DD is the day or the month, and RR is a sequence number if more than one version was developed on a given date. Note that initially, the first character of the build number is the letter "B". This may change for new readers if they have significantly different embedded firmware.

• GetFirmwareId

  public RFIDStatus GetFirmwareId(ref String FirmwareId)

  Method:

  RFIDStatus GetFirmwareId(ref String FirmwareId)

  Summary:

  This method retrieves the hardware Major.Minor.Revision number of the sensor.

  Parameters:

  FirmwareId - Output returning the firmware version number of the sensor.

  Returns:

  This functino will return RFIDStatus.OK if it is able to read and return the sensor's firmware version Itwill return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The value returned has the format V#.#.# where the first field (#) is the major version level of the firmware, the second the minor version level, and the third field contains the firmware's revision number.

• GetGen2Params

  public RFIDStatus GetGen2Params(ref Byte[] Gen2Params)

  Methods:

  RFIDStatus GetGen2Params(ref byte[] Gen2Params)

  Summary:

  The Gen2Params data structure is returned with the various Gen2Parameters filled in. filled in.

  Parameters:

  Gen2Params - This structure returns the Gen2 parameter settings for the RFIDReader module in raw binary protocol format.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's Gen2 parameters

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  This method encapsulates the module command 0x22. See the "ALR-M UHF RFIDReader Module Communication Protocol" document for more details.

• GetGPIOSetup

  public RFIDStatus GetGPIOSetup(ref Byte GPIOSetup)

  Method:

  RFIDStatus GetGPIOSetup(ref Byte GPIOSetup)

  Summary:

  This method returns the settings for the general-purpose outputs and the detected state of the general-purpose inputs

  Parameters:

  GPIOSetup - This ouput parameter returns the settings of teh genreal-purpose inputs and ouputs. The 8 bits of the value are [i4, i3, i2, i1, o4, o3, o2, o1]. A 1 for the input values indicating a high boltage level (between 5 and 24 volts) and a 0 indiating a level below 3 volts. A 1 for an output bit indicateds that the output has been turned on, and a 0 indicates it is off.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the GPIO setting. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• GetGPSData

  public RFIDStatus GetGPSData(out GPSData gpsData)

  Method:

  RFIDStatus GetGPSData(out GPSData gpsData)

  Summary:

  This method retrieves the GPS coordinates of the reader.

  Parameters:

  gpsData - This parameter returns the data structure with the data from the latest GPS reading. The information included in this structure is latitude, longitude, altitude, GPS time, speed and heading. See the documentation for the GPSData class for the details on this structure

  Returns:

  This method will return RFIDStatus.OK if the GPS data can be retrieved, otherwise, the method will return RFIDStatus.Failed.

  Throws:

  A System.TimeoutException will be thrown if the connection to the reader cannot be established or the reader doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• GetGPSConfiguration

  public RFIDStatus GetGPSConfiguration(out GPSConfig gpsConfig)

  Method:

  RFIDStatus GetGPSConfiguration(out GPSConfig gpsConfig)

  Summary:

  This method retrieves the GPS setup configuration for the Extreme reader. This includes data refresh rate, which fields are included when data is requested or is streamed, and whether the GPS data is to be included in the sensor data output stream from the reader.

  Parameters:

  gpsConfig - TThis parameter returns the data structure with the current configuration of the GPS sensor from the Extreme reader. See the documentation for the GPSConfig class for details of which fields can be retrieved.

  Returns:

  This method will return RFIDStatus.OK if the GPS configuration can be retrieved, otherwise, the method will return RFIDStatus.Failed.

  Throws:

  A System.TimeoutException will be thrown if the connection to the reader cannot be established or the reader doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• GetHardwareId

  public RFIDStatus GetHardwareId(ref String HardwareId)

  Group

  Top-Level Sensor ID Queries

  Method:

  RFIDStatus GetHardwareId(ref String HardwareId)

  Summary:

  This method retrieves the hardware Major.Minor.Revision number of the sensor.

  Parameters:

  HardwareId - Output returning the hardware identifier of the sensor.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the sensor's hardware version. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The value returned has the format V#.#.# where the first field (#) is the major version level of the hardware, the second the minor version level, and the third field contains the revision number.

• GetIMUData

  public RFIDStatus GetIMUData(out IMUData IMUData)

  Method:

  RFIDStatus GetIMUData(out IMUData IMUData)

  Summary:

  This method retrieves the IMU readings of the reader.

  Parameters:

  IMUData - This parameter returns the data structure with the data from the latest IMU reading. The information included in this structure is accelerometer x/y/z, gyroscope x/y/z, magnetometer x/y/z and/or temperature. See the documentation for the IMUData class for the details on this structure.

  Returns:

  This method will return RFIDStatus.OK if the IMU data can be retrieved, otherwise, the method will return RFIDStatus.Failed. Note that if the IMU sensor fails or is not part of the reader's hardware configuration this will return RFIDStatus.Failed.

  Throws:

  A System.TimeoutException will be thrown if the connection to the reader cannot be established or the reader doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• GetIMUConfiguration

  public RFIDStatus GetIMUConfiguration(out IMUConfig IMUConfig)

  Method:

  RFIDStatus GetIMUConfiguration(out IMUConfig IMUConfig)

  Summary:

  This method retrieves the IMU setup configuration for the Extreme reader. This includes data refresh rate, which fields are included when data is requested or is streamed, and whether the IMU data is to be included in the sensor data output stream from the reader.

  Parameters:

  IMUConfig - TThis parameter returns the data structure with the current configuration of the IMU sensor from the Extreme reader. See the documentation for the IMUConfig class for details of which fields can be retrieved.

  Returns:

  This method will return RFIDStatus.OK if the IMU configuration can be retrieved, otherwise, including the case where the IMU sensor chip fails or is not present in the reader's hardware configuration, this method will return RFIDStatus.Failed.

  Throws:

  A System.TimeoutException will be thrown if the connection to the reader cannot be established or the reader doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• GetHeartbeatConfig

  public RFIDStatus GetHeartbeatConfig(ref Byte[] IPv4Address,
                                                                                                                                           ref UInt16 PortNumber,
                                                                                                                                           ref UInt32 Interval,
                                                                                                                                           ref UInt32 Count)

  Method:

  RFIDStatus GetHeartbeatConfig(ref Byte[] IPv4Address, ref UInt16 PortNumber, ref UInt32 Interval, ref UInt32 Count)

  Summary:

  This method returns the IP address and UDP port number over which the heartbeat is sent as well and the Interval between heartbeat messages and the number (Count) of messages that are sent before the heartbeat goes silent.

  Parameters:

  IPv4Address - This output parameter returns with the four bytes taht comprise the IP address over which the heartbeat messages are sent.

  PortNumber - Output paremeter returning the UDP port number over which the heartbeat messages are being sent.

  Interval - On return this output parameter will hold the time interval in seconds between heartbeat messages.

  Count - On return this ouput parameter contains the number of counts until the heartbeat is silenced.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the hearbeat configuration. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetIPv4Info

  public RFIDStatus GetIPv4Info(ref Boolean usingDHCP,
                                               ref Byte[] IPv4Address, ref Byte[] ipv4Netmask,
                                               ref Byte[] ipv4Gateway, ref Byte[] ipv4DNSServer,
                                               ref UInt16 sensorPort)

  Method:

  RFIDStatus GetIPv4Info(ref Boolean usingDHCP, ref Byte[] IPv4Address, ref Byte[] ipv4Netmask, ref Byte[] ipv4Gateway, ref Byte[] ipv4DNSServer, ref UInt16 sensorPort)

  Summary:

  This method returns the various parameters comprising the IpV4 network configuration.

  Parameters:

  UsingDHCP - Output whose value is True if the sensor is getting its IPv4 setup using DHCP, Falise if a static IP address has been assigned.

  IPv4Address, ipv4Netmask, ipv4Gateway, ipv4DNSServer - These four ouput values contain the IP addresses for the associated networking paramters. In dotted notation, if the address is of the form a.b.c.d, then val[0] = a, val[1] = b, val[2] = c, and val[3] = d.

  SensorPort - On return, this output contains the value of the TCP port used for command-level communication with the sensor takes place over.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the sensor's IpV4 network configuration. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetLinkParams

  public RFIDStatus GetLinkParams(ref Byte LinkParams)

  Method:

  RFIDStatus GetLinkParams(ref Byte LinkParams)

  Summary:

  The method returns the current Link Parameter setting of the RFIDReader module.

  Parameters:

  LinkParams - The value of the Link Parameter setting will be returned through this parameter. The values returned will be:

  • 0 - DSB_ASK, FM0, 40 kHz
  • 1 - PR_ASK, Miller 4, 250 kHz
  • 2 - PR_ASK, Miller 4, 300 kHz
  • 3 - DSB_ASK, FM0, 400 kHz

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the modules Link Parameters. It will retrun RFIDStatus.Failed otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  This method encapsulates the module command 0x54. See the "ALR-M UHF RFID Reader Module Communication Protocol" document for more details.

• GetModuleFirmwareId

  public RFIDStatus GetModuleFirmwareId(ref String ModuleFwNumber)

  Method:

  RFIDStatus GetModuleFirmwareId(ref String ModuleFwNumber)

  Summary:

  Returns the RF Module's firmware version number.

  Parameters:

  ModuleFwNumber - The string representation of the module's firmware version number is returned to the caller.

  Returns:

  The string representation of the module's firmware version number is returned to the caller.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  The value returned has the format V#.#.# where the first filed (#) is the major version level of the firmware, the second the minor version level, and the third field contains the firmware's revision number.

• GetModuleHardwareId

  public RFIDStatus GetModuleHardwareId(ref String ReaderId)

  Group:

  RF Module ID Queries

  Method:

  RFIDStatus GetModuleHardwareId(ref String ReaderId)

  Summary:

  Returns the RF Module's hardware identifier.

  Parameters:

  ReaderId - The 8-digit reader module's serial number is returned, formatted as a string.

  Returns:

  A string containing the module's hardware identifier is returned to the caller

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  The value returned has the format V#.#.# where the first field (#) is the major version level of the hardware, the second the minor version level, and the third filed contains the revision number.

• GetModulePowerSetting

  public RFIDStatus GetModulePowerSetting(ref Double ReadPower, ref Double WritePower)

  Method:

  RFIDStatus GetModulePowerSetting(ref Double ReadPower, ref Double WritePower)

  Summary:

  Returns the read power and write power levels from the reader module.

  Parameters:

  ReadPower - Returned value of the current module's read power level in dBm.

  WritePower - Returned value of the current module's write power level in dBm.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's current read and write power. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  This command is complementary to the setModulePowerSetting command. Not that if the power level has been changed y doing tag inventory reads, the power level is set to the values established by the SetAntennaPowerSettings commands.

• GetModuleReaderId

  public RFIDStatus GetModuleReaderId(ref String ReaderId)

  Method:

  RFIDStatus GetModuleReaderId(ref String ReaderId)

  Summary:

  This function returns the string value corresponding to the reader module's internal serial number.

  Parameters:

  ReaderId - The 8-digit reader module's serial number is returned, formatted as a string.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the module's serial number. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetModuleTemperature

  public RFIDStatus GetModuleTemperature(ref Double ModuleTemperature)

  Method:

  RFIDStatus GetModuleTemperature(ref Double ModuleTemperature)

  Summary:

  This method retrieves the internal temperature of the RFIDReader module in degrees C.

  Parameters:

  ModuleTemperature - On return, ModuleTemperature will hold the current internal temperature of RFIDReader module in degrees C.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's temperature. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetOperatingMode

  public RFIDStatus GetOperatingMode(out String operatingMode)

  Method:

  RFIDStatus GetModuleTemperature(out String operatingMode)

  Summary:

  This method returns the operating mode of the sensor. Possible return values include:
  ERR: Sensor is not ready to communicate. Generally only appears for the first few seconds after a reboot. You will not be able to connect to the reader when it is in this state.
  APP: Sensor is in the standard operating mode and is not reading tags.
  AUT: Sensor is in AutoSens mode actively reading tags.
  BLU: Sensor is updating Bootloader firmware.

  Parameters:

  OperatingMode - This return parameter return the operating mode string value per the values shown above.

  Returns:

  This function will return RFIDStatus.OK unless a connecction to the sensor cannot be made in which case a System.TimeoutException will be thrown.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  Note that there are two ways that the reader can communicate while actively reading tags in AutoSens mode. This command will be able to connect and return the "AUT" status when AutoSens data is being delivered via the notification mechanism. However, if the reader is delivering data in streaming mode, e.g., it is being run from the RFID Console application, the message queue will be screwed up and an invalid header byte error will be returned.
  
  Also, there are a couple of additional modes that are displayed in the heartbeat when the reader is updating the module firmware or the bootloader is loading the main application firmware. You should be very careful to be sure to not issue this command during any of the firmware update processes.

• GetReaderDateandTime

  public RFIDStatus GetReaderDateandTime(out String ReaderDateandTime)
                                     throws java.lang.Exception

  Method:

  RFIDStatus GetReaderDateandTime(out String ReaderDateandTime)

  Summary:

  Retrieve the real-time clock date and time values from the reader.

  Parameters:

  ReaderDateandTime - This parameter returns the reader's date and time in the format: YYY-MM-DDThh:mm:ss

  Returns:

  This function will return RFIDStatus.OK if it is able to get the sensor's current date and time. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetReaderConfiguration

  public RFIDStatus GetReaderConfiguration(out RFID.RFIDReader.ReaderConfig ReaderConfiguration)

  Method:

  RFIDStatus GetReaderConfiguration(out RFID.RFIDReader.ReaderConfig ReaderConfiguration)

  Summary:

  Gets the configuration of the reader

  Parameter:ReaderConfiguration

  Type - out RFID.RFIDReader.ReaderConfig ReaderConfig{

  Byte numberOfAntennas;

  Byte numberOfEthernetPorts;

  Byte numberOfGPIs;

  Byte numberof GPOs; Boolean hasDCInput;

  }

  Returns:

  This function will return RFIDStatus.OK if it is able to get the sensor's reader configuration. It will return RFIDStatus. FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetReaderName

  public RFIDStatus GetReaderName(out String ReaderName)
                                 throws java.lang.Exception

  Method:

  RFIDStatus GetReaderName(out String ReaderName)

  Summary:

  Gets the name advertised by the sensor's heartbeat messages through a direct firmware query.

  Parameters:

  ReaderName - Output parameter returns the name of the reader that is advertised in the sensor's reader name. It will return RFIDStatus.FAILED otherwise.

  Returns:

  This function will return RFIDStatus.OK if it is able to get the sensor's reader name. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetReaderType

  public RFIDStatus GetReaderType(out String ReaderType)

  Method:

  RFIDStatus GetReaderType(out String ReaderType)

  Summary:

  Gets the reader type advertised by the sensor's heartbeat messages through a direct firmware query.

  Parameters:

  ReaderType - Ouput parameter returns the name of the reader that is advertised in the sensor's heartbeat message.

  Returns:

  This function will return RFIDStatus.OK if it is able to get the sensor's reader type. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetReadGapTimes

  public RFIDStatus GetReadGapTimes(ref UInt16 ReadTime, ref UInt16 GapTime)

  Method:

  RFIDStatus GetReadGapTimes(ref UInt16, ref UInt16 GapTime)

  Summary:

  This command retrieves the current read time interval and the time interval between read cycles.

  Parameters:

  ReadTime - Ouput parameter containing the time interval in seconds for which a inventory read cycle is performed for each antenna driven by the reader.

  GapTime - Output parameter containing the time interval in milliseconds for the time period between inventory read cycles.

  Returns:

  This function always returns RFIDStatus.OK

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• GetReadSequence

  public RFIDStatus GetReadSequence(ref Byte[] AntennaSequence, ref Byte SequenceLength)

  Method:

  RFIDStatus GetReadSequence(ref Byte[] AntennaSequence, ref Byte SequenceLength)

  Summary:

  This method retrieves the sequence of antennas that the reader loops through when performing a continuous tag inventory read cycle.

  Parameters:

  AntennaSequence - This output parameter returns an array of antenna numbers reflecting the sequence of antennas that the reader will cycle through during a continuous inventory read cycle.

  SequenceLength - Output Value indicating the number of items in the antenna sequence.

  Returns:

  this method returns an array of antenna numbers reflecting the sequence of antennas that the reader will cycle through during a continuous inventory read cycle.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  Note that the antenna sequence can have repeats. For example, the sequence [0, 0, 1, 0, 1, 1] (with SequenceLength 6) would read antenna 0 for 2 cycle, then alternate between antenna 1 and antenna 0 for one cycle each, then read antenna 1 for 2 consecutive cycles before looping back and repeating the entire sequence.
  The purpose of this is to allow for effectively longer read periods on some antennas than on others due to tag density or other factors that might effect read accuracy.

• GetRegionCode

  public RFIDStatus GetRegionCode(out Byte regionSetting)

  Method:

  RFIDStatus GetRegionCode(out Byte regionSetting)

  Summary:

  This method returns the byte code for the region setting of the reader module.

  Parameters:

  RegionSetting - Returns the current region setting of the reader module with values as follows:

  • 1 - China (1)
  • 2 - China (2)
  • 4 - Europe
  • 8 - USA
  • 16 - Korea
  • 20 - Europe (2)
  • 22 - Australia/New Zealand
  • 23 - Brazil
  • 24 - Israel
  • 25 - India
  • 32 - Japan

  Returns:

  This function will return CommandStatus.OK if it is able to read and return the RF module's region setting. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• GetRegionSetting

  public RFIDStatus GetRegionSetting(out Byte RegionSettings)

  Method:

  RFIDStatus GetRegionSetting(out Byte RegionSettings)

  Summary:

  This method returns the byte code for the region setting of the reader module.

  Parameters:

  RegionSetting - Returns the current region setting of the reader module with values as follows:

  • 51 - Autralia/New Zealand
  • 70 - Bangladesh
  • 52 - Brazil
  • 1 - China (840.5 - 844.5)
  • 2 - China (920.5 - 924.5)
  • 4 - Europe/ETSI
  • 71 - Hong Kong
  • 54 - India
  • 55 - Israel
  • 50 - Japan
  • 22 - Korea
  • 73 - Malaysia
  • 74 - Singapore
  • 56 - Taiwan
  • 75 - Thailand
  • 8 - US/Canada/Mexico/FCC
  • 76 - Vietnam

  Returns:

  This function will return CommandStatus.OK if it is able to read and return the RF module's region setting. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• GetSearchMode

  public RFIDStatus GetSearchMode(out Byte SearchMode)

  Method:

  RFIDStatus GetSearchMode(out Byte SearchMode)

  Summary:

  Returns the current search mode for the reader module.

  Parameters:

  SearchMode - The return value will be 0 if the duel search mode is active and 1 if single is active.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's region code or region name. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetSerialNumber

  public RFIDStatus GetSerialNumber(ref String SerialNumber)

  Method:

  RFIDStatus GetSerialNumber(ref String SerialNumber)

  Summary:

  This method retrieves the hardware Major.Minor.Revision number of the sensor.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the sensor's serial number. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetSelectParameters

  public RFIDStatus GetSelectParameters(out Byte inventoryMode, out Byte preSelectCount)

  Method:

  RFIDStatus GetSelectParameters(out Byte inventoryMode, out Byte preSelectCount)

  Summary:

  The method returns the inventory mode and pre-select count for the module.

  Parameters:

  InventoryMode - The value of the InventoryMode setting will be returned through this parameter. The values returned will be:

  • 0 - No Pre-selects
  • 1 - Pre-select before all query/rep cycles
  • 2 - Pre-select before each antenna change
  • 3 - Pre-select only on start of inventory process
  • 4 - Only do pre-selects; no query/rep cycles

  PreSelectCount - The number of pre-selects that will be issued before each read cycle subject to the processing determined by the InventoryMode parameter. Note that PreSelectCount = 0 and InventoryMode = 0 are equivalent and will be implemented by setting InventoryMode to 0 when doing an inventory read.

  Returns:

  This function will return RFIDStatus.OK if a valid response is received from the sensor. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetSJCSetup

  public RFIDStatus GetSjcSetup(out SJC_Parameters sjcParams)

  Method:

  RFIDStatus GetSerialNumber(out SJC_Parameters sjcParams)

  Summary:

  The method returns the current SJC settings for the module.

  Parameters:

  sjcParams - The current state of the Self-Jamming Correction paramters is returned in this parameter. See the documentation for the SJC_Parameters class for details about the various settings.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the sensor's serial number. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetTempNotificationSetup

  public RFIDStatus GetTempNotificationSetup(ref UInt16 notificationInterval,
                                                                                                                                                         ref UInt16 alertInterval,
                                                                                                                                                         ref Double warningThreshold,
                                                                                                                                                         ref Double alertThreshold)

  Method:

  RFIDStatus GetTempNotificationSetup(ref UInt16 notificationInterval, ref UInt16 alertInterval, ref Double warningThreshold, ref Double alertThreshold)

  Summary:

  This method returns the time intervals and thresholds for reporting module temperature during continuous tag read sessions.

  Parameters:

  NotificationInterval - Ouput value returning the time interval between UDP notifications of the temperature of the module.

  AlertInterval - Output returning the time interval between times that the sensor checks the module's temperature to determine whether it is over the warning or the alert threshold.

  WarningThreshold - Output parameter that returns the current temperature threshold in degrees C above which a warning notification is sent.

  AlertThreshold - Output parameter that returns the current temperature threshold in degrees C above which a temperature alert notification is sent.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's temperature notification settings. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  See the comments under the SetTempNotification() method documentation for more details

• GetLocatorSignalStatus

  public RFIDStatus GetLocatorSignalStatus(ref Boolean LocatorSignalActive)

  Method:

  RFIDStatus GetLocatorSignalStatus(ref Boolean LocatorSignalActive)

  Summary:

  This method returns whether or not the locator flash pattern is active on the sensor.

  Parameters:

  LocatorSignalActive - Output is true when the locator signal is active, false otherwise.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the reader's locator signal signal status. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The LED on the sensor blinks alternating red and green when the signal locator is on to help locate a specific sensor.

• GetPortReturnLoss

  public RFIDStatus GetPortReturnLoss(ref Double returnLoss, UInt32 antennaNumber)

  Method:

  RFIDStatus GetPortReturnLoss(ref Double returnLoss, UInt32 antennaNumber)

  Summary:

  This method returns the return loss id dBm for the antenna port specified.

  Parameters:

  ReturnLoss - Output containing the return loss in dBm for the antenna port specified by AntennaNumber.

  AntennaNumber - Input to the method for which the return loss will be read. This parameter must have a value in the range from 0 to 3.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the the return loss for the specified antenna. It will return RFIDStatus.FAILED otherwise. This command will fail if the AntennaNumber is not between 0 and 3.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetMTIPortReturnLoss

  public RFIDStatus GetMTIPortReturnLoss(ref Double returnLoss, UInt32 antennaNumber)

  Method:

  RFIDStatus GetMTIPortReturnLoss(ref Double returnLoss, UInt32 antennaNumber)

  Summary:

  This method returns the MTI return loss id dBm for the antenna port specified..

  Parameters:

  ReturnLoss - Output containing the return loss in dBm for the antenna port specified by AntennaNumber.

  AntennaNumber - Input to the method for which the return loss will be read. This parameter must have a value in the range from 0 to 3.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the the return loss for the specified antenna. It will return RFIDStatus.FAILED otherwise. This command will fail if the AntennaNumber is not between 0 and 3.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetRSSI

  public RFIDStatus GetRSSI(ref Double envRSSI)

  Method:

  RFIDStatus GetRSSI(ref Double envRSSI)

  Summary:

  This method returns the background RSSI of sensor in dBm.

  Parameters:

  EnvRSSI - On return, this parameter will contain the background RSSI of the sensor in dBm.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's background RSSI. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• GetWiFiConfiguration

  public RFIDStatus GetWiFiConfiguration(out String SSID)
                                     throws java.lang.Exception

  Method:

  RFIDStatus GetWiFiConfiguration(out String SSID)

  Summary:

  This method retrieves the name of the wireless network (SSID) for the Wi-Fi router that the SensX Extreme uses for the Wi-Fi connection.

  Parameters:

  SSID - This parameter returns the name of the wireless network the reader uses to connect to your wireless router.Note that this method will return an empty string (length 0) if the SSID has not been set on your reader.

  Returns:

  This method will return RFIDStatus.OK if the Address can be retrieved, otherwise the method will return RFID.Status.Failed.

  Throws:

  A System.TimeoutException will be thrown if a connection to the reader cannot be established or the reader doesn't respond.

• KillTag

  public RFIDStatus KillTag(UInt32 killPassword,
                                                                                                                             Byte maskBank, UInt16 maskAddress, UInt16 maskLength, Byte[] mask,
                                                                                                                             out Byte errorCode)

  Method:

  RFIDStatus KillTag(UInt32 killPassword, Byte maskBank, UInt16 maskAddress, UInt16 maskLength, Byte[] mask, out Byte errorCode)

  Summary:

  This method kills the tag reference by the specified input mask.

  Parameters:

  killPassword - This parameter specifies the 32 bit kill password that must have been programmed into the tag prior to making this call

  maskBank, maskAddress, maskLength, mask - These parameters are used to select a specific tag (or tags) to be killed. A description of these parameters an be found in the corresponding mask data section of the ReadTagData method above.

  Returns:

  This function will return RFIDStatus.OK if it is able to kill the specified tag. It will return RFIDStatus.FAILED otherwise and return the extended error code in the errorCode parameter.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• LockTagData

  public RFIDStatus LockTagData(UInt32 accessPassword,
                                                                                                                                 Byte maskBank, UInt16 maskAddress, UInt16 maskLength, Byte[] mask,
                                                                                                                                 RFIDLockState killPwdLock, RFIDLockState accessPwdLock,
                                                                                                                                 RFIDLockState epcLock, RFIDLockState userDataLock,
                                                                                                                                 out Byte errorCode)

  Method:

  RFIDStatus LockTagData(UInt32 accessPassword, Byte maskBank, UInt16 maskAddress, UInt16 maskLength, Byte[] mask, RFIDLockState killPwdLock, RFIDLockState accessPwdLock, RFIDLockState epcLock, RFIDLockState userDataLock, out Byte errorCode)

  Summary:

  This method locks, unlocks, or permanently locks or unlocks one or more data banks on the tag. The tag to which the lock is to be applied can be selected using the mask data.

  Parameters:

  accessPassword - Specifies the password needed to lock the tag data.

  maskBank, maskStartBit, maskBitLength, mask - These 4 fields specify a mask for filtering which tag is to be read. The maskBank specfies the data bank to filter on (1 = EPC data, 2 = Tag Identifier data, or 3 = User data). The starting bit position within the data bank that the filter begins from is specified by maskStartBit, the length of the mask in bits is specified by maskBitLength, and the actual mask data is specified by the mask parameter.
  As an example, if you wanted to lock the tag whose TID is E20034140117010112DD127E, you would pass in maskBank = 2, maskStartBit = 0, maskBitLength = 96 (12 bytes * 8 bits/byte) and mask = [E2, 00, 34, 14, 01, 17, 01, 01, 12, DD, 12, 7E].

  killPwdLock, accessPwdLock, epcLock, userDataLock - These paramters specify the type of locks that are to be applied to each of the respective data items. Each of these lock parameters is the or (|) of the following values:

  • RFIDLockState.NoChange = 0 --- The lock state of the associated bank is not to be changed.
  • RFIDLocKState.Lock = 1-- The bank's lock bit is to be set.
  • RFIDLockState.Unlock = 2 -- The bank's lock bit is to be cleared.
  • RFIDLocKState.PermaLock = 4 -- The bank's permalock bit is to be set.
  • RFIDLockState.PermaUnlock = 8 -- The bank's permalock bit is to be cleared.

  errorCode - This returns the underlying error code detailing any problems. Typical error codes are: 1 - the specified parameters are not supported, 2 - the passwordspecified was wrong or provided insufficient privileges (e.g., 0 when associated parts of the tag are locked, and 3 - mask or data locations and/or lengths werenot specified correctly. These error codes correspond to the values documentedin Annex I of the EPCGlobal Gen2 Specification (Nov-2013, Version 2.0).

  Returns:

  This function will return RFIDStatus.OK if it is able to change the lock status of all of the specified data banks. It will return RFIDStatus.Failed otherwise. and set the errorCode parameter indicating the specific error condition. In addition, none of the specified locks are applied. The values for the returned error code are documented under the ReadTagData/errorCode parameter section above.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• ReadNextTag

  public RFIDStatus ReadNextTag(ref TagReadInfo readInfo)

  Method:

  RFIDStatus ReadNextTag(ref TagReadInfo readInfo)

  Summary:

  This method is used to collect tag information.

  Parameters

  readInfo - This output parameter returns a filled out TagReadInfo object

  Returns:

  This method returns RFIDStatus.DONE when the response from StopContinuousRead() has been received.
  This function will generally return RFIDStatus.OK. RFIDStatus.FAILED will be returned if malformed data is read.

  Throws:

  Generally, no exceptions will be thrown for this call. As always, it is good practice to put this in a try/catch block to handle unusual situations that might crop up and cause your application to crash if not caught.

  Comments

  See the discussion under the Additional Information section for the StartContinuousRead() method for how to perform a continuous tag inventory cycle.
  Note that this command blocks waiting for the next tag to be returned. Because of this, the only way to stop the continuous read cycle is to call the StopContinuousRead() from a separate thread.

• ReadNextTag

  public RFIDStatus ReadNextTag(ref String EPC, ref Double RSSI, ref Byte AntennaNumber)

  Method:

  RFIDStatus ReadNextTag(ref String EPC, ref Double RSSI, ref Byte AntennaNumber)

  Summary:

  This method is used to collect tag information.

  Parameters

  EPC - This output parameter returns the EPC for the first tag read after the continuous read cycle is started.

  RSSI - RSSI is an output paramter returning the detected RSSI in dBm for the tag taht was read.

  AntennaNumber - This is an output parameter specifying the number of the antenna that was active when the tag was detected.

  Returns:

  This method returns RFIDStatus.DONE when the response from StopContinuousRead() has been received.
  This function will generally return RFIDStatus.OK. RFIDStatus.FAILED will be returned if malformed data is read.

  Throws:

  Generally, no exceptions will be thrown for this call. As always, it is good practice to put this in a try/catch block to handle unusual situations that might crop up and cause your application to crash if not caught.

  Comments

  See the discussion under the Additional Information section for the StartContinuousRead() method for how to perform a continuous tag inventory cycle.
  Note that this command blocks waiting for the next tag to be returned. Because of this, the only way to stop the continuous read cycle is to call the StopContinuousRead() from a separate thread.

• ReadTag

  public RFIDStatus ReadTag(ref String epc, ref Double rssi, ref Byte antennaNumber)

  Method:

  RFIDStatus ReadNextTag(ref String EPC, ref Double RSSI, ref Byte AntennaNumber)

  Summary:

  This method requests a single inventory read cycle returning any detected tag.

  Parameters

  EPC - Output parameter returning the EPC code for the tag read..

  RSSI - This output parameter returns the RSSI value of the read tag in dBm.

  AntennaNumber - Output parameter returning the antenna number that was energized during the tag inventory cycle.

  Returns:

  This method returns RFIDStatus.DONE when the response from StopContinuousRead() has been received.
  This function will generally return RFIDStatus.OK. RFIDStatus.FAILED will be returned if malformed data is read.

  Throws:

  This function will return RFIDStatus.OK if it is able to read a tag. It will return RFIDStatus.FAILED otherwise.

  Comments

  This command will return "No Data" in the EPC field if it returns without reading a tag. It will return "Bad Data" if the data read is corrupted.

• ReadTag

  public RFIDStatus ReadRfMicronSensorData(Byte functionId, Byte tagModel,
                                                                                                                                                      UInt32 accessPassword,
                                                                                                                                                      Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength, Byte[] mask,
                                                                                                                                                      Byte dataBank, UInt16 dataStartWord, UInt16 dataWordLength, ref UInt16[] data,
                                                                                                                                                      out Byte errorCode)

  Method:

  RFIDStatus ReadRfMicronSensorData(Byte functionId, Byte tagModel, UInt32 accessPassword, Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength, Byte[] mask, Byte dataBank, UInt16 dataStartWord, UInt16 dataWordLength, ref UInt16[] data, out Byte errorCode)

  Summary:

  This method reads the tag data from the specified tag data bank: 0 = Reserved data, 1 = EPC data, 2 = Tag Identifier Data (TID), 3 = User data. The tags read are filtered using the mask data against the location specified by the maskBank, maskStartBit (offset into bank in number of bits) with length specified by maskBitLength number of bits. DataWordLength number of words will be read from the bank specified by the dataBank parameter starting at offset dataStartWord words.

  Parameters

  accessPassword - This specifies the password needed when reading the tag data. In general, specifying a non-zero value is only needed when the access password and kill password have been locked. For all other data banks and to read the passwords when they are not locked, either 0 or the value that matches the currently programmed password for the tag can be used.

  maskBank, maskStartBit, maskBitLength, mask - These 4 fields specify a mask for filtering which tag is to be read. The maskBank specifies the data bank to filter on (1 = EPC data, 2 = Tag Identifier data, or 3 = User data). The starting bit position within the data bank that the filter begins from is specified by maskStartBit, the length of the mask in bits is specified by maskBitLength, and the actual mask data is specified by the mask parameter.
  As an example, if you wanted to mask based on the TID of a tag with TID value E20034140117010112DD127E, maskBank = 2, maskStartBit = 0, maskBitLength = 96 (12 bytes * 8 bits/byte) and mask = [E2, 00, 34, 14, 01, 17, 01, 01, 12, DD, 12, 7E].

  dataBank, dataStartWord, dataWordLength, data - The parameter dataBank specifies the data bank to be read (0 = Reserved data, 1 = EPC data, 2 = Tag Identifier data, 3 = User data), dataStartWord specifies what word (2 bytes) boundary to start from, and dataWordLength specifies the number of words to read. The data is returned as dataWordLength number of elements filled in the data array. Note that the data array is allocated by the calling program and must be at least dataWordLength elements long.
  As an example, if we wanted to read words 2 and 3 of the TID specified above, we would pass in dataBank=2, dataStartWord = 1 (the indexing is zero based) and dataWordLength = 2. On a successful read, this method would return data = [3414, 0117].

  errorCode - This returns the underlying error code detailing any problems. Typical error codes are: 1 - the specified parameters are not supported, 2 - the password specified was wrong or provided insufficient privileges (e.g., 0 when associated parts of the tag are locked, and 3 - mask or data locations and/or lengths were not specified correctly. These error codes correspond to the values documented in Annex I of the EPCGlobal Gen2 Specification (Nov-2013, Version 2.0).

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the data requested for the given tag. It will return RFIDStatus.FAILED otherwise and set the errorCode parameter indicating the specific error condition.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond. A System.IndexOutOfRangeException will be thrown if the "data" array was not allocated with at least a size of dataWordLength.

• ReadTagData

  public RFIDStatus ReadTagData(UInt32 accessPassword,
                                                                                                                      Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength,
                                                                                                                      Byte[] mask, Byte dataBank, UInt16 dataStartWord,
                                                                                                                      UInt16 dataWordLength, ref UInt16[] data, out Byte errorCode)

  Method:

  RFIDStatus ReadTagData(UInt32 accessPassword, Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength, Byte[] mask, Byte dataBank, UInt16 dataStartWord, UInt16 dataWordLength, ref UInt16[] data, out Byte errorCode)

  Summary:

  This method reads the tag data from the specified tag data bank: 0 = Reserved data, 1 = EPC data, 2 = Tag Identifier Data (TID), 3 = User data. The tags read are filtered using the mask data against the location specified by the maskBank, maskStartBitAddress (offset into bank in number of bits) with length specified by maskBitLength number of bits. DataWordLength number of words will be read from the bank specified by the dataBank parameter starting at offset dataStartWord words.

  Parameters:

  accessPassword - This specifies the password needed when reading the tag data. In general, specifying a non-zero value is only needed when the access password and/or kill password have been locked. For all other data banks and to read the passwords when they are not locked, either 0 or the value that matches the currently programmed password for the tag can be used.

  maskBank, maskStartBit, maskBitLength, mask - These 4 fields specify a mask for filtering which tag is to be read. The maskBank specifies the data bank to filter on (1 = EPC data, 2 = Tag Identifier data, or 3 = User data). The starting bit position within the data bank that the filter begins from is specified by maskStartBit, the length of the mask in bitsis specified by maskBitLength, and the actual mask data is specified by the mask parameter.
  As an example, if you wanted to mask based on the TID of a tag with TID value E20034140117010112DD127E, maskBank = 2, maskStartBit = 0, maskBitLength = 96 (12 bytes * 8 bits/byte) and mask = [E2, 00, 34, 14, 01, 17, 01, 01, 12, DD, 12, 7E].

  dataBank, dataStartWord, dataWordLength, data - The parameter dataBank specifies the data bank to be read (0 = Reserved data, 1 = EPC data, 2 = Tag Identifier data, 3 = User data), dataStartWord specifies what word (2 bytes) boundary to start from, and dataWordLength specifies the number of words to read. The data is returned as dataWordLength number of elements filled in the data array. Note that the data array is allocated by the calling program and must be at least dataWordLength elements long.
  As an example, if we wanted to read words 2 and 3 of the TID specified above, we would pass in dataBank=2, dataStartWord = 1 (the indexing is zero based) and dataWordLength = 2. On a successful read, this method would return data = [3414, 0117].

  errorCode - This returns the underlying error code detailing any problems. Typical error codes are: 1 - the specified parameters are not supported, 2 - the passwordspecified was wrong or provided insufficient privileges (e.g., 0 when associated parts of the tag are locked, and 3 - mask or data locations and/or lengths werenot specified correctly. These error codes correspond to the values documentedin Annex I of the EPCGlobal Gen2 Specification (Nov-2013, Version 2.0).

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the data requested for the given tag. It will return RFIDStatus.FAILED otherwise and set the errorCode parameter indicating the specific error condition.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond. A System.IndexOutOfRangeException will be thrown if the "data" array was not allocated with at least a size of dataWordLength.

• Reboot

  public RFIDStatus Reboot()

  Method:

  RFIDStatus Reboot()

  Summary:

  This method issues the reboot command to the sensor.

  Returns:

  This function always returns RFIDStatus.OK.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  Note that as long as the sensor receives the command issued by this method, it will reboot immediately without sending a response. This method will close the underlying socket. Consequently, it is the responsibility of the application to provide the correct IP address and port number to this class if the saved configuration is different from the current setup.

• ResetReceiveTimeout

  public RFIDStatus ResetReceiveTimeout()

  Method:

  RFIDStatus ResetReceiveTimeout()

  Summary:

  This is a cleanup command that needs to be called after a continuous read cycle has been stopped. StartContinuousRead() sets the receive timout to be infinite so that the ReadNextTag() call will block waiting for the next tag data to be sent.

  Returns:

  This function will always return RFIDStatus.OK.

• ResetToDefaultConfiguration

  public RFIDStatus ResetToDefaultConfiguration(int WhatToKeep = 0)

  Methods

  RFIDStatus ResetToDefaultConfiguration(int WhatToKeep = 0)

  Summary:

  This resets the various sensor configuration parameters back to their default values, then restarts the TCP/IP stack.

  Parameters:

  WhatToKeep - Input parameter specifying what subsets of the configuration settings are to be retained when this message is sent to the reader. Values are as follows, but possibly will be extended (bit encoded) to include other options:

  • 0 -- Reset all. This is the default option and resets all configuration settings. This is the legacy option.
  • 1 -- Retain IPv4 settings. Reset all others.
  • 2, 4, 8, 16, 32, 64, 128, 256 -- RFU.

  Returns:

  Returns:

  This function will return RFIDStatus.OK if it is able to reset the configuration memory to its factory defaults and restart the network stack. It will return RFIDStatus.FAILED otherwise, including the case where WhatToKeep is not 0 or 1.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  This command restores the configuration information documented under the comments section of the SaveCurrentConfiguration() method back to its factory defaults. Once the defaults have been restored and the sensor acknowledges having received the command, it shuts down the TCP communication socket and reopens it to wait for new commands. Your application layer will need to provide the IP address and port number to reestablish to this class so that it can attempt to open communication on the right IP address and port.

• RestoreSavedConfiguration

  public RFIDStatus RestoreSavedConfiguration()

  Method:

  RFIDStatus RestoreSavedConfiguration()

  Summary:

  This method sends a request to the sensor to restore the saved configuration values that are stored in flash memory.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and restore the saved configuration. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  This command restores the configuration information documented under the comments section of the SaveCurrentConfiguration() method. Note that the sensor does not check whether the networking parameters are reset. Consequently, the sensor shuts down the TCP communication socket and reopens it to wait for new commands. The underlying communications layer for this API handles this situation and also works to reestablish communication. Your application layer, however, will need to provide the IP address and port number to reestablish this communication link if these values are different between the saved configuration and the setup prior to calling this method.
  The primary purpose of this command is to allow you to experiment with different configurations, then elect to restore the last saved configuration if things don't behave the way you want. (This can also be achieved by rebooting or power-cycling the sensor.)

• SaveCurrentConfiguration

  public RFIDStatus SaveCurrentConfiguration()

  Method:

  RFIDStatus SaveCurrentConfiguration()

  Summary:

  This method saves the various configurable setting to flash memory so that they will be active when the sensor reboots.

  Returns:

  This function will return RFIDStatus.OK if it is able to save the settings. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The configuration information saved includes:

  • The Reader Name
  • Networking parameters
  • Heartbeat parameters
  • Antenna Power values
  • Antenna Sequencing setup
  • Temperature Management parameters

• Set24VStatus

  public RFIDStatus Set24VStatus(Boolean V24Active, Boolean V24ActiveOnStartup)

  Method:

  RFIDStatus Set24VStatus(Boolean V24Active, Boolean V24ActiveOnStartup)

  Summary:

  This method turns the 24VDC on or off and sets the configuration that determines whether it is on or off on startup

  Parameters:

  V24Active - This input parameter turns the 24VDC power on when true and off when false.

  V24ActiveOnStartup - This input parameter determines whether the 24VDC power is on (true) when the sensor is restarted, or off (false)

  Returns:

  This function will return RFIDStatus.OK if it is able to change to the new setup for the 24VDC. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The initial configuration of the 24VDC is set via startupState24V. However, as with any configuration item that is part of the startup process, the method SaveCurrentConfiguration() needs to be called before for it to be in effect when the reader is booted.

• SetAntennaPowerSettings

  public RFIDStatus SetAntennaPowerSettings(UInt32 antennaId, Double readPower, Double writePower)

  Method:

  RFIDStatus SetAntennaPowerSettings(UInt antennaId, Double ReadPower, Double WritePower)

  Summary:

  Set the read and write power levels for when the reader is transmitting through the specified antenna

  Parameters:

  antennaId - The number of the antenna for which the power is to be set. Range is from 0 to 3

  readPower - The read power level in dBm to be set for the specified antenna when the reader will be reading tags. Must be in teh range from 5 to 30 dBm

  writePower - The write power level in dBm to be set for the specified antenna when the reader will be write information to tags. Must be in the range from 5 to 30 dBm.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the antenna power. It will return RFIDStatus.FAILED otherwise. This command will fail if the AntennaId is not in the range from 0 to 3. It will also fail if either the ReadPower or the WritePower is less than 5 or greater than 30.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetAFECMode

  public RFIDStatus SetAFECMode(Byte afecMode)

  Method:

  RFIDStatus SetAFECMode(Byte afecMode)

  Summary:

  This method sets the Advanced FEC mode of the reader.

  Parameters:

  afecMode - The value of the Advanced FEC inventory mode will be set to the value specified by this parameter.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the antenna power. It will return RFIDStatus.FAILED otherwise. This command will fail if the AntennaId is not in the range from 0 to 3. It will also fail if either the ReadPower or the WritePower is less than 5 or greater than 30.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetActiveAntenna

  public RFIDStatus SetActiveAntenna(UInt32 antennaId)

  Method:

  RFIDStatus SetActiveAntenna(UInt antennaId)

  Summary:

  Set the read and write power levels for when the reader is transmitting through the specified antenna

  Parameters:

  antennaId - The id of the antenna for transmitting RF power. This value must be between 0 (the internal antenna) and 3.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the antenna power. It will return RFIDStatus.FAILED otherwise. This command will fail if the AntennaId is not in the range from 0 to 3. It will also fail if either the ReadPower or the WritePower is less than 5 or greater than 30.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetAutoSensProgram

  public RFIDStatus SetAutoSensProgram(String macroProgram)

  Method:

  RFIDStatus SetAutoSensProgram(String macroProgram)

  Summary:

  This method uses a string of semicolon (';') separated SensArray macros corresponding to the active AutoSens macro program. This string will be check to be sure that is represents a valid AutoSens program and set up as the configured program if it checks out properly.

  Parameters:

  MacroProgram - This parameter contains the String representing of the macro program to be set.

  Returns:

  This function will return RFIDStatus.OK if it is a valid AutoSens macro program. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetAutoSensStartupState

  public RFIDStatus SetAutoSensStartupState(Boolean Running)

  Method:

  RFIDStatus SetAutoSensStartupState(Boolean Running)

  Summary:

  This method takes a Boolean value indicating whether the specified AutoSens program is to be automatically run when the reader reboots.

  Parameters:

  Running - If set to true, the Running input parameter will configure the reader to automatically start the AutoSens program when the reader is rebooted. If it is specified as false, the reader will not start the AutoSens program on reboot.

  Returns:

  This method will always return RFIDStatus.OK.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the sensor doesn't respond.

• SetBluetoothConfiguration

  public RFIDStatus SetBluetoothConfiguration(String Address, String PairingCode)

  Method:

  RFIDStatus SetBluetoothConfiguration(String Address, String PairingCode)

  Summary:

  This method configures the reader to establish a connection with a specific Bluetooth enabled device such as a SmartPhone, a tablet computer etc. This communication is enabled providing the reader with the address and the pairing code of the device that the reader will pair with and subsequently communicate with.

  Parameters:

  Address - This parameter specifies the Bluetooth Address of the device that will be paired with the reader. The Address must be a string in the form ##.##.##.##.##.## where each pair of ## fields specifies a hexadecimal value. A example of this might be 11.22.34.56.78.90. Note that there are 6 fields separated by the colon ':' character. This method requires that each # character be one of the values 0-9 or A-F. Also, leading zeros must be provided,e.g. 01:02:03:04:05:06 cannot be shortened to 1:2:3:4:5:6.

  PairingCode - The PairingCode is the security code required by the device that the reader will pair with. This code must be passed by the reader to the Bluetooth-enabled device to provide credentials that allow the Bluetooth device to know that the reader is authorized to connect. Note that this can be a UTF-8 encoded string.

  Returns:

  This function will return RFIDStatus.OK if the Address and PairingCode are properly formatted as specified in the parameter descriptions above. If either of these parameters is not properly formatted, this method will return RFIDStatus.FAILED.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetConnectionInfo

  public RFIDStatus SetConnectionInfo(Byte connectionNumber, String connectionString)

  Method:

  RFIDStatus SetConnectionInfo(Byte connectionNumber, String connectionString)

  Summary:

  When a data notification macro is specified in an AutoSens program, the data is sent to a connection (0-4) based on the connection information specified by the connection string. The connection string is in the format "IP_Address:PortNumber". Generally, an AutoSens program will deliver data to at most a single connection, we allow up to 5 connections to be specified if more than one is needed by a configuration.

  Parameters:

  ConnectionNumber - This input parameter specifies the connection number to which the ConnectionString is associated. The connection number can have values from 0 through 4.

  ConnectionString - The ConnectionString is an input parameter comprised of an IPv4 address in dotted notation (111.222.1.2) followed by a ":" followed by a port number in the range from 0 to 65535. As an example, a connection to be established to port 8100 on a server with IP address 192.168.8.12 would be specified as "192.168.8.12:8100" (without the quotation marks).

  Returns:

  This method will return RFIDStatus.OK if the ConnectionNumber is between 0 and 4 and the ConnectionString is a combination of a valid IPv4 Address and a port number between 0 and 65535 separated by a ":". It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetCustomerKey

  public RFIDStatus SetCustomerKey(string CustomerKeyFile)

  Method:

  RFIDStatus SetCustomerKey(string CustomerKeyFile)

  Summary:

  This method sets the checks and sets the customer key signature to be used for afec.

  Parameters:

  CustomerKeyFile - The string will contain the full file content of the customer key file. Size is limited.

  Returns:

  This function will return RFIDStatus.OK if the setting is valid. Otherwise RFIDStatus.FAILED will be returned.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetDRMState

  public RFIDStatus SetDRMState(Boolean newDrmState)

  Method:

  RFIDStatus SetDRMState(Boolean newDrmState)

  Summary:

  The method sets the DRM mode for RF Mode 1 (M4/250kHz)

  Parameters:

  newDrmState - This parameter becomes the new value for the DRM (Dense Reader Mode) setting for the M4/250kHz RF mode.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the DRM setting for RF Mode 1. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetExpressoModeParams

  public RFIDStatus SetExpressoModeParams(out ExpressoModeParameters expressoParams)

  Method:

  RFIDStatus SetExpressoModeParams(ExpressoModeParameters expressoParams)

  Summary:

  The method sets up a subset of the additional Expresso Mode parameters needed to initiate an Expresso Mode inventory process.

  Parameters:

  expressoParams -The subfields of ExpressoModeParameters that are returned are:

  • phase1Time -- the time spent in phase 1 of Expresso mode
  • phase2StartQ -- the starting Q value for phase 2 of Expresso mode

  Returns:

  This function will return CommandStatus.OK if it is able to read and return the expresso mode parameters. It will return CommandStatus.Failed otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetGen2Params

  public RFIDStatus SetGen2Params(Byte[] gen2Params)

  Method:

  RFIDStatus SetGen2Params(Byte[] gen2Params)

  Summary:

  The Gen2Params for the RFIDReader module are set to the values specified in the Gen2Params data structure.

  Parameters:

  Gen2Params - This structure returns the Gen2 parameter settings for the RFIDReader module.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the RF module's Gen2 Parameters. It will return RFIDStatus.FAILED otherwise. This command will fail if an attempt is made to set values that are not valid for the specified data fields of the Gen2DataType structure.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments:

  This method encapsulates the module command 0x20. See the "ALR-M UHF RFIDReader Module Communication Protocol" document for more details.

• SetGeneralPurposeOutputs

  public RFIDStatus SetGeneralPurposeOutputs(Byte newGPOs)

  Method:

  RFIDStatus SetGeneralPurposeOutputs(bytes newGPOs)

  Summary:

  This method sets the settings for the general-purpose outputs and the detected state of the general-purpose inputs

  Parameters:

  newGPOs - This input parameter is sent to the sensor to turn the general-purpose outputs on or off. The 8 bits of the value are [0, 0, 0, 0, 04, 03, 02, 01]. A 1 turns the output on, and a 0 turns it off

  Returns:

  This function will return true if it is able to set the new output values. It will return false otherwise. This command will fail if the 4 most significant bits are not set to 0.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• SetGPSConfiguration

  public RFIDStatus SetGPSConfiguration(GPSConfig gpsConfig)

  Method:

  RFIDStatus SetGPSConfiguration(GPSConfig gpsConfig)

  Summary:

  This method is used to set the GPS configuration of the Extreme reader. This includes data refresh rate, which fields are included when data is requested or is streamed, and whether the GPS data is to be included in the sensor data output stream from the reader.

  Parameters:

  gpsConfig - This parameter passes in the data structure to update the current configuration of the GPS sensor of the Extreme reader. See the documentation for the GPSConfig class for details of which fields can be set.

  Returns:

  This function will return true if it is able to set the new output values. It will return false otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• SetHeartbeatConfig

  public RFIDStatus SetHeartbeatConfig(Byte[] iPv4Address,
                                                   UInt16 portNumber,
                                                   UInt32 interval,
                                                   UInt32 count)

  Method:

  RFIDStatus SetHeartbeatConfig(Byte[] iPv4Address, UInt16 portNumber, UInt32 interval, UInt32 count)

  Summary:

  This method sets the IP address, UDP port number, interval, and count of the heartbeat configuration

  Parameters:

  iPv4Address - This input parameter passes in the four bytes that comprise the IP address over which the heartbeat messages are sent. This can be set to 255.255.255.255 for UDP broadcast over the local subnet

  PortNumber - This input parameter sets the PortNumber over which teh UDP heartbeat messages are sent. The default is 3988, but can be set to any value between 1024 and 65535.

  Interval - The Interval input parameter passes in the number of seconds between heartbeat messages. This value can be set to 0 to turn the heartbeat off, or can be set to a long interval to reduce network traffic associated with the heartbeat messages.

  Count - This value specifies the number of heartbeat messages that are sent before the heartbeat is no longer being sent. Again, this can be used to reduce network traffic by turning the messages off after some time period.

  Returns:

  This function will return true if it is able to set the heartbeat configuration. It will return false otherwise. This command will fail if the PortNumber is not between 1024 and 65535.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The Interval and Count values should be used carefully since it could make devise network discovery difficult. During initial deployment, you may want to leave these at their default values (Interval=30, Count=0xFFFFFFFF) or even consider reducing the interval to a smaller value so that you see the heartbeat more often.
  Also, note that this configuration is not saved automatically. Be sure to save the configuration so that the new values will stay in effect when the sensor is rebooted.

• SetIMUConfiguration

  public RFIDStatus SetIMUConfiguration(IMUConfig IMUConfig)

  Method:

  RFIDStatus SetIMUConfiguration(IMUConfig IMUConfig)

  Summary:

  This method is used to set the IMU configuration of the Extreme reader. This includes data refresh rate, which fields are included when data is requested or is streamed, and whether the IMU data is to be included in the sensor data output stream from the reader.

  Parameters:

  IMUConfig - This parameter passes in the data structure to update the current configuration of the IMU sensor of the Extreme reader. See the documentation for the IMUConfig class for details of which fields can be set.

  Returns:

  This function will return true if it is able to set the new output values. It will return false otherwise. This command will fail if the IMU chip has failed or is not present in the reader's hardware configuration.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Note:

  This method has been implemented only on the Extreme readers. Other readers will return a command not implemented response.

• SetInventoryFilter

  public RFIDStatus SetInventoryFilter(Byte maskBank, UInt16 maskStartBitAddress
                                                      UInt16 maskBitLength, Byte[] mask,
                                                      Boolean makePersistent)

  Method:

  RFIDStatus SetInventoryFilter(Byte maskBank, UInt16 maskStartBitAddress UInt16 maskBitLength, Byte[] mask, Boolean makePersistent)

  Summary:

  This method sets the filter to be used during tag inventory cycles

  Parameters:

  makePersistent - This parameter specifies whether this filter should be saved to the module flash memory so that it will continue to be active even when the module reboots

  Returns:

  This function will return RFIDStatus.OK if it is able to set the filter. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  Inventory filters can be cleared by calling the provided method ClearInventoryFilter(boolean makePersistent).

• SetIPv4CommLink

  public void SetIPv4CommLink(String IPAddress, UInt16 PortNumber)

  Method:

  void SetIPv4CommLink(String IPAddress, UInt16 portNumber)

  Summary:

  The IP address and port number are passed on to the underlying communication layer which closes the underlying socket if the IP address and port number don't match the values already set up.

  Parameters:

  iPAddress - Input parameter with dotted format IP address (e.g., "192.168.1.150").

  portNumber - Input parameter with the TCP port that the primary command communication will take place over.

  ReturnType:

  There is no return vale from this method.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  comments:

  This method is used to reset the underlying socket whenever the sensor's network configuration has changed, or when the application chooses to communicate with a second sensor without wanting to create a separate instance of the RFIDReader class.

• SetIPv4Info

  public RFIDStatus SetIPv4Info(Boolean UseDHCP, Byte[] IPv4Address,
                                               Byte[] ipv4Netmask, Byte[] ipv4Gateway,
                                               Byte[] ipv4DNSServer, UInt16 SensorPort)

  Method:

  RFIDStatus SetIPv4Info(Boolean UseDHCP, Byte[] IPv4Address, Byte[] ipv4Netmask, Byte[] ipv4Gateway, Byte[] ipv4DNSServer, UInt16 SensorPort)

  Summary:

  This method is used to set the IpV4 network configuration for the sensor.

  Parameters:

  UseDHCP - Input specifying that the sensor should use DHCP to obtain its network configuration.

  IPv4Address, ipv4Netmask, ipv4Gateway, ipv4DNSServer - Input values for IpV4 address, the netmask, the gateway's IP address, and the IP address of the DNS server. These should be a valid dot notation for these values (a.b.c.d where the 4 fields must fall between 0 and 255).

  SensorPort - Input specifying the prot for command-level comminication with the sensor. This must be a value between 1024 and 65535

  Returns:

  This method will return RFIDStatus.OK if it is able to set the sensor's IpV4 networking setup. It will return RFIDStatus.FAILED otherwise. This method will fail if the SensorPort number is not between 1024 and 65535.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond. A System.FormatException will be Thrown if any of the parameters IPv4Address, IPv4Netmask, IpV4Gateway, or IpV4DNSServer is not a valid dot notation IP address.

  Comments

  Note that this command will immediately change the network setup, then close and reopen the command socket. Also, this configuration will not be automatically saved as the startup configuration of the sensor. Consequently, if the sensor is rebooted before the sensor's configuration is saved it will restart using the previous sensor setup.

• SetLinkParams

  public RFIDStatus SetLinkParams(byte linkParams, boolean save)

  Method:

  RFIDStatus SetLinkParams(byte linkParams, boolean save)

  Summary:

  The method sets the current Link Parameter setting of the RFIDReader module.

  Parameters:

  linkParams - this parameter sets the link parameters to the following values:

  • 0 - DSB_ASK, FM0, 40 kHz
  • 1 - PR_ASK, Miller 4, 250 kHz
  • 2 - PR_ASK, Miller 4, 300 kHz
  • 3 - DSB_ASK, FM0, 400 kHz

  save - this parameter sets whether or not the link parameters will be saved to the module after a power cycle.

  Returns:

  This function will return true if it is able to successfully set the link parameters to the module. It will return false otherwise. This command will fail if the value passed is not between 0 and 3.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  This method encapsulates the module command 0x52. See the "ALR-M UHF RFIDReader Module Communication Protocol" document for more details.

• GetExpressoModeParams

  public RFIDStatus GetExpressoModeParams(out ExpressoModeParameters expressoParams)

  Method:

  RFIDStatus GetExpressoModeParams(out ExpressoModeParameters expressoParams)

  Summary:

  The method returns a subset of the additional Expresso Mode parameters needed to initiate an Expresso Mode inventory process.

  Parameters:

  expressoParams - The subfields of ExpressoModeParameters that are returned are:

  • phase1Time -- the time spent in phase 1 of Expresso mode
  • phase2StartQ -- the starting Q value for phase 2 of Expresso mode

  Returns:

  This function will return true if it is able to successfully set the link parameters to the module. It will return false otherwise. This command will fail if the value passed is not between 0 and 3.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetLocatorSignalStatus

  public RFIDStatus SetLocatorSignalStatus(Boolean NewSignalStatus)

  Method:

  RFIDStatus SetLocatorSignalStatus(Boolean NewSignalStatus)

  Summary:

  This method activates or deactivates the locator signal on the sensor.

  Parameters:

  NewSignalStatus - Input parameter, when true, turns the locator flash pattern on, and when false, returns the flash pattern to normal operating mode indication.

  Returns:

  This function will return RFIDStatus.OK if it is able to turn the reader's locator indicator on or off. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comment

  The LED on the sensor blinks alternating red and green when the signal locator is on. It returns to its standard blinking green light when the locator is turned back off.

• SetModulePowerSetting

  public RFIDStatus SetModulePowerSetting(Double readPower, Double writePower)

  Group:

  RF Setup and Query Methods

  Method:

  RFIDStatus SetModulePower(Double readPower, Double writePower)

  Summary:

  This function directly sets the read and write power of the RFIDReader module.

  Parameters:

  readPower - The power to be used when reading tags in dBm. Valid range is from 5 to 30.

  writePower - The power to be used when writing tags in dBm. Valid range is from 5 to 30.

  Returns:

  This function will return true if it is able to read and return the module's hardware id. It will return false otherwise. This command will fail if readPower or writePower is either less than 5 or greater than 30

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetReaderDateandTime

  public RFIDStatus SetReaderDateandTime(String readerDateandTime)

  Method:

  RFIDStatus SetReaderDateandTime(String readerDateandTime)

  Summary:

  Sets the real-time clock and date values of the reader.

  Parameters:

  readerDateandTime - This parameter provides the date/time to be set in the format: YYYY-MM-DDThh:mm:ss

  Returns:

  This function will return RFIDStatus.OK if it is able to set the sensor's date and time. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetReaderName

  public RFIDStatus SetReaderName(String readerName)

  Method:

  RFIDStatus SetReaderName(String readerName)

  Summary:

  Sets the name advertised by the sensor's heartbeat messages.

  Parameters:

  readerName - Input parameter specifying the name of the reader to be advertised in the sensor's heartbeat message. The name cannot be longer than 31 characters.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the sensor's reader name. It will return RFIDStatus.FAILED otherwise. This command will fail if the reader name is longer than 31 characters.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetReadGapTimes

  public RFIDStatus SetReadGapTimes(UInt16 readTime, UInt16 gapTime)

  Method:

  RFIDStatus SetReadGapTimes(UInt16 readTime, UInt16 gapTime)

  Summary:

  This method sets the time interval for an inventory read cycle and the time interval between reads.

  Parameters:

  readTimes - Input parameter setting the time interval in milliseconds for which the reader will perform an inventory cycle for the current antenna.

  gapTimes - Input parameter setting the time interval in milliseconds between inventory read cycles.

  Returns:

  This function will return RFIDStatus.OK it if is able to set the read time and the gap time of the sensor. It will return RFIDStatus.FAILED otherwise. This command will fail if an attempt is made to set the gapTime to less than 10 ms.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The read time is the time interval for reading tags for each antenna in the antenna sequence. The gap time is the time interval between read cycles where the reader switches to the next antenna in the sequence, sets up the read power level for driving that particular antenna as well as doing a bit of housekeeping. The minimum time interval allotted for these to complete is 10 ms, hence the minimum value validation for the gap time.
  Note that the read and gap times establish a duty cycle for the operation of the RF module. Since the module can overheat when run continuously, we encourage you to either monitor the module's temperature carefully during high duty cycle operation, or set the duty cycle up to allow for extended operation under your ambient temperature conditions.
  More information about selecting appropriate read and gap times based on ambient temperature can be found in the SensThys white paper "Thermal Performance of the SensArray".

• SetReadSequence

  public RFIDStatus SetReadSequence(Byte[] AntennaSequence, Byte SequenceLength)

  Method:

  RFIDStatus SetReadSequence(Byte[] AntennaSequence, Byte SequenceLength)

  Summary:

  This method sets the sequence of antennas that the reader loops through when performing a continuous tag inventory read cycle.

  Parameters:

  antennaSequence - This input parameter is used to pass an array of antenna numbers to the reader to set the sequence of antennas that it will cycle through during a continuous inventory read cycle.

  sequenceLength - Input value indicating the number of items in the antenna sequence.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the reader's antenna sequence. It Will return RFIDStatus.FAILED otherwise. This command will fail if the antenna numbers in the sequence fall outside the range from 0 to 3. Also, the maximum number of antennas is 16, this method will fail if the antennaSequence length is greater than 16.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  Note that the antenna sequence can have repeats. For example, the sequence [0, 0, 1] (with SequenceLength 3) would read antenna 0 for 2 cycles, read antenna 1, then loop back repeating the entire sequence. This would effectively give antenna 0 twice as much air time as antenna 1.
  The purpose of this is to allow for effectively longer read periods on some antennas than on others due to tag density or other factors that might affect read accuracy.

• SetRegionCode

  public RFIDStatus SetRegionCode(Byte regionSetting)

  Method:

  RFIDStatus SetRegionCode(Byte regionSetting)

  Summary:

  This method sets the byte code for the region setting on the reader module.

  Parameters:

  RegionSetting - Sets the current region setting of the reader module with values as follows:
  

  • 1 - China (1)
  • 2 - China (2)
  • 4 - Europe
  • 8 - USA
  • 16 - Korea
  • 20 - Europe (2)
  • 22 - Australia/New Zealand
  • 23 - Brazil
  • 24 - Israel
  • 25 - India
  • 32 - Japan

  Returns:

  This function will return CommandStatus.OK if it is able to set the RF module's region setting. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

• SetSearchMode

  public RFIDStatus SetSearchMode(byte searchMode)

  Method:

  RFIDStatus SetSearchMode(byte searchMode)

  Summary:

  Set the search mode of the RFID module

  Parameters:

  searchMode - This parameter specifies the search mode (0) - dual or (1) - single to be set.

  Returns:

  searchMode This function will return true if it is able to set the RF module's search mode. It will return false otherwise. This command will fail if a value other than 0 or 1 is passes in for the parameter.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetSelectParameters

  public RFIDStatus SetSelectParameters(Byte inventoryMode, Byte preSelectCount)

  Method:

  RFIDStatus SetSelectParameters(Byte inventoryMode, Byte preSelectCount)

  Summary:

  The method sets the inventory mode and pre-select count for the module.

  Parameters:

  InventoryMode - The value of the InventoryMode setting will be returned through this parameter. The values returned will be:

  • 0 - No Pre-selects
  • 1 - Pre-select before all query/rep cycles
  • 2 - Pre-select before each antenna change
  • 3 - Pre-select only on start of inventory process
  • 4 - Only do pre-selects; no query/rep cycles

  PreSelectCount - The number of pre-selects that will be issued before each read cycle subject to the processing determined by the InventoryMode parameter. Note that PreSelectCount = 0 and InventoryMode = 0 are equivalent and will be implemented by setting InventoryMode to 0 when doing an inventory read.

  turnLabel">Returns:

  Returns:

  This function will return RFIDStatus.OK if it is able to set the select parameter. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetSessionParameter

  public RFIDStatus SetSessionParameter(Byte sessionParam)

  Method:

  RFIDStatus SetSessionParameter(Byte sessionParam)

  Summary:

  This method sets the Session Parameter.

  Parameters:

  sessionParam - This input parameter passes in the value for the session parameter to be set. The values are 0 through 3 for session 0 through 3.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the session parameter. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.

  Comments

  The session parameter is one component in the underlying byte protocol for setting the Gen2 parameters. This method reads the Gen2 parameters, changes the session bits, then sends the command to set the Gen2 parameters.

• SetSensorReadCallback

  public void SetSensorReadCallback(RFID.Reader.SensorDataReadHandler sensorReadHandler)

  Method:

  void SetSensorReadCallback(RFID.Reader.SensorDataReadHandler sensorReadHandler)

  Summary:

  This method allows the continuous read callback function to be changed or disabled (by passing the parameter value as null). The callback that is registered with this overloaded method will pass a reference to the reader object with which it is registered back to the client code.

  Parameters:

  sensorReadHandler - This parameter specifies the callback routine that is called each time tag data is reported during a continuous inventory cycle.

  Throws:

• SetSjcParameters

  public void SetSjcParameters(SJC_Parameters sjcParams)

  Method:

  void SetSjcParameters(SJC_Parameters sjcParams)

  Summary:

  The method sets the current SJC settings of the module.

  Parameters:

  sjcParams - The current state of the Self-Jamming Correction paramters is updated to the settings passed in through this parameter. See the documentation for the SJC_Parameters class for details about the various settings.

  Returns:

  This function will return RFIDStatus.OK if it is able to read and return the DRM setting for RF Mode 1. It will return RFIDStatus.FAILED otherwise.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• SetTagReadCallback

  public void SetTagReadCallback(RFID.Reader.TagReadHandler continuousTagReadHandler)

  Method:

  void SetTagReadCallback(RFID.Reader.TagReadHandler continuousTagReadHandler)

  Summary:

  This method allows the continuous read callback function to be changed or disabled (by passing the parameter value as null).

  Parameters:

  continuousTagReadHandler - This parameter specifies the callback routine that is called each time tag data is reported during a continuous inventory cycle

  ReturnType:

  There is no return vale from this method.

  Exceptions:

  No exceptions will be thrown by this method.

• SetTagReadCallback

  public void SetTagReadCallback(RFID.Reader.TagReadHandler2 continuousTagReadHandler)

  Method:

  void SetTagReadCallback(RFID.Reader.TagReadHandler2 continuousTagReadHandler)

  Summary:

  This method allows the continuous read callback function to be changed or disabled (by passing the parameter value as null).

  The callback that is registered with this overloaded method will pass a reference to the reader object which it is registered back to the client code.

  Parameters:

  continuousTagReadHandler - This parameter specifies the callback routine that is called each time tag data is reported during a continuous inventory cycle

  ReturnType:

  There is no return vale from this method.

  Exceptions:

  No exceptions will be thrown by this method.

• SetTempNotificationSetup

  public RFIDStatus SetTempNotificationSetup(UInt16 notificationInverval, UInt16 alertInterval
                                                            Double warningThreshold, Double alertThreshold)

  Methods

  RFIDStatus SetTempNotificationSetup(UInt16 notificationInverval, UInt16 alertInterval Double warningThreshold, Double alertThreshold)

  Summary:

  This method sets the time intervals and thresholds for reporting module temperature during continuous tag read sessions.

  Parameters:

  alertInterval - Input specifying the interval in seconds between times that the sensor checks the module's temperature to determine whether or not it is over the warning or the alert threshold.

  warningThreshold - Input parameter to set the current temperature threshold in degrees C above which a warning notification is sent.

  alertThreshold - Input parameter to set the current temperature threshold in degrees C above which a temperature alert notification is sent.

  Returns:

  This function will return RFIDStatus.OK if it is able to set the Temperature Notification Settings. It will return RFIDStatus.FAILED otherwise. This method will fail if an attempt is made to set the alert interval to less than 10 seconds or the alarm threshold is set above 85 degrees C.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

  Comments

  There are two types of UDP notifications to port 3984 that are sent from the sensor related to the temperature
  The first is a periodic notification of the module's temperature at an interval specified by the NotificationInterval parameter. This can be turned off by setting it to 0. The default for this interval is 30 seconds.
  These notifications are sent when the module exceeds a couple of thresholds. A warning is issued when the temperature exceeds the value specified by the WarningThreshold parameter. An alert is issued when the temperature exceeds the value specified by AlertThreshold. As long as the temperature stays above these values, the warning or the alert is not resent. However, if the temperature drops at least 2 degrees below these levels, then rises above them again, the warning or alert is reissued.
  The warnings can be turned off by setting the WarningThreshold very high. However, to protect the module, alerts cannot be turned off and the threshold cannot be set above 85 degrees C.
  The default warning threshold is 60 degrees C. The default alert threshold is 85 degrees C. These thresholds are checked periodically determined by the AlertInterval parameter. The time interval has a default value of 30 seconds. It cannot be be lower than 10 seconds. If this value is set to a very long time interval (greater than 5 minutes) the module may become excessively hot and will automatically shut down to protect itself.

• SetWiFiConfiguration

  public RFIDStatus SetWiFiConfiguration(String SSID, String PassCode)

  Method:

  RFIDStatus SetWiFiConfiguration(String SSID, String PassCode)

  Summary:

  This method configures the Wi-Fi parameters in the SensX Extreme readers to enable connections to a Wi-Fi router. The name of the wireless network (SSID) and the password (PassCode) needed to access that network are required for the reader to communicate on that wireless network. The SensX reader requires the wireless router to support WPA2_Personal_AES security settings.

  Parameters:

  SSID - This parameter is used to specify the name of the wireless network as is typically broadcast by your wireless router.

  PassCode - The PassCode is required to allow the reader to provide the password or passphrase to the wireless router.

  Returns:

  This function will return RFIDStatus.OK if the SSID and the PassCode are not empty strings. If one or the other of these parameters is an empty String, the method will return RFIDStatus.FAILED.

  Throws:

  A System.TimeoutException will be thrown if a connection to the sensor cannot be established or the module doesn't respond.

• Shutdown

  public void Shutdown()

  Method:

  void Shutdown()

  Summary:

  This method closes down the underlying communications connection.

  Exceptions:

  System.Timeout as well as some socket exceptions may be thrown by this call. In general, these exceptions can be ignored.

• isConnected

  public Boolean isConnected()

  Method:

  Boolean isConnected()

  Summary:

  This method returns whether the underlying socket for the reader is connected to a reader or not.

• SetIPv6Address

  public void SetIPv6Address(string sIPv6Address)

  Method:

  void SetIPv6Address()

  Summary:

  This method is used to set the connected readers IPv6 Address.

  Parameters:

  sIPv6Address - The IPv6 Address to be set on the reader.

• ClearedToSend

  public Boolean ClearedToSend()

  Method:

  Boolean ClearedToSend()

  Summary:

  This method returns whether or not the reader is available for data to be sent.

  Returns:

  This method returns true if data is cleared to be sent to the reader. False, otherwise.

• StartContinuousRead

  public RFIDStatus StartContinuousRead()

  Method:

  RFIDStatus StartContinuousRead()

  Summary:

  This method starts a continuous tag inventory session. This session continues until the StopContinuousRead() command is received. The "Additional Information" section below describes in more detail how to use these calls

  Returns:

  This function always returns RFIDStatus.OK.

  Throws:

  a System.TimeoutException will be thrown if the initial connection to the sensor cannot be established.

  Comments

  This method along with ReadNextTag() and StopContinuousRead() form a set of commands for performing a continuous tag inventory read cycle. During a continuous read cycle, the reader automatically cycles through the antenna sequence as described in the comments sections of the SetReadGapTimes() and SetAntennaSequence() commands above.
  The primary way these commands are used it to issue StartContinuousRead(), then invoke ReadNextTag() in a loop until the return value from the method call is TagReadInfo.STATUS_DONE. TagReadInfo.STATUS_DONE is issued from ReadNextTag() when it receives the response to the StopContinuousRead() command rather than tag data. Note that due to network latency and other factors, a number of tags may be read after the stop command is issued. Because ReadNextTag() blocks indefinitely waiting for tag data to be returned, StopContinuousRead() must be issued from a separate thread. Typically, a thread would be created to run the ReadNextTag() loop, and the StopContinousRead() command can then be issued from the primary thread.
  Once the StartContinuousRead() method is invoked, the only command that should be sent to the sensor is StopContinuousRead(). ReadNextTag() can be called to listen for the data from the next tag read to be passed back. Otherwise, any other command can result in the sensor locking up and leaving the module in a continuous read state, potentially damaging the reader. This method along with ReadNextTag() � or your registered callback � and StopContinuousRead() form a set of commands for performing a continuous tag inventory read cycle. During a continuous read cycle, the reader automatically cycles through the antenna sequence as described in the comments sections of the SetReadGapTimes() and SetAntennaSequence() commands above.
  There are two ways to use these commands to perform the inventory cycle:

  • The first way to use these commands is to register a callback method with the RFIDReader class, either through the class constructor, or through the SetTagReadCallback() method. The callback interface is documented in the constructor section above. Whenever a callback is registered, StartContinuousRead() starts a background thread to read the tag data continuing until the StopContinuousRead() command is sent. Due to network and process latency, when StopContinuousRead() is sent from your application, the background thread continues to read tags until the response to the StopContinuousRead() command is received. At that point, the status data member of the TagReadInfo structure passed back as the callback parameter is set to TagReadInfo.STATUS_DONE and the background thread stops reading tags.
  • The second way to use these commands is to issue StartContinuousRead(), then invoke ReadNextTag() in a loop until the return value from the method call is TagReadInfo.STATUS_DONE. TagReadInfo.STATUS_DONE is issued from ReadNextTag() when it receives the response to the StopContinuousRead() command rather than tag data. Note that due to network latency and other factors, a number of tags may be read after the stop command is issued. Because ReadNextTag() blocks indefinitely waiting for tag data to be returned, StopContinuousRead() must be issued from a separate thread. Typically, a thread would be created to run the ReadNextTag() loop, and the StopContinousRead() command can then be issued from the primary thread.

  
  In either scenario, once the StartContinuousRead() method is invoked, the only command that should be sent to the sensor is StopContinuousRead(). ReadNextTag() can be called to listen for the data from the next tag read to be passed back.Otherwise, any other command can result in the sensor locking up and leaving the module in a continuous read state, potentially damaging the reader.

• StopContinuousRead

  public RFIDStatus StopContinuousRead()

  Method:

  RFIDStatus StopContinuousRead()

  Summary:

  This method is called to stop a continuous read cycle started by the StartContinuousRead() method.

  Returns:

  This always returns RFIDStatus.OK.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor has been lost and cannot be reestablished in a timely manner.

  Comments

  See the discussions under the Additional Information section of the StartContinuousRead() method and ReadNextTag() method above.

• StopContinuousRead

  public RFIDStatus StopContinuousRead(Byte resumeTime)

  Method:

  RFIDStatus StopContinuousRead(Byte resumeTime)

  Summary:

  This method is called to stop a continuous read cycle started by the StartContinuousRead() method. This is an overloaded version where a restart time after whcih the stopped AutoSens program will be automatically restarted.

  Parameters:

  resumeTime - This parameter specifies the time after the reader stops to when the running AutoSens program is resumed. This parameter specifies the time in minutes and has a range from 0 to 15. Specifying 0 is equivalent to calling StopContinuousRead() without any parameters and results in the AutoSens program remaining stopped until manually restarted or the reader is rebooted when Start AutoSens on Boot is active.

  Returns:

  This always returns RFIDStatus.OK.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor has been lost and cannot be reestablished in a timely manner.

  Comments

  Note that this AutoResume feature is only applicable for AutoSens programs that do not require the main socket for data delivery. AutoResume will work for any AutoSens macro program where the data is delivered through a connection that is established by the reader while running the AutoSens program. For those cases where the AuotSens program is streaming to the main communication port (5000), this command will result in a non-resuming stop being issued to the reader.
  
  See the discussions under the Additional Information sections of the StartContinuousRead() method and ReadNextTag() method above.

• WriteTagData

  public RFIDStatus WriteTagData(UInt32 accessPassword, 
                                                                                                                      Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength, Byte[] mask, 
                                                                                                                      Byte dataBank, UInt16 dataStartWord, UInt16 dataWordLength, UInt16[] data,
                                                                                                                      out Byte errorCode)

  Method:

  RFIDStatus WriteTagData(UInt32 accessPassword, Byte maskBank, UInt16 maskStartBit, UInt16 maskBitLength, Byte[] mask, Byte dataBank, UInt16 dataStartWord, UInt16 dataWordLength, UInt16[] data, out Byte errorCode)

  Summary:

  This method writes the tag data to the specified tag data bank: 0 = Reserved data, 1 = EPC data, 2 = Tag Identifier data (generally not writable), 3 = User data using the mask data against the location specified by the maskBank, maskStartBitAddress (offset into bank in number of bits) with length specified by maskBitLength number of bits. DataWordLength number of words will be written to the bank specified by the dataBank parameter starting at offset dataStartWord words.

  Parameters:

  The parameters for this method are described in detail under the ReadTagData() method above. The only exception is that the data[] array is passed in and is written to the specified location (rather than read from that location in the description above).

  Returns:

  This function will return the a TagFields object used to pass the any error codes back to the caller.

  Throws:

  A System.TimeoutException will be thrown if the connection to the sensor cannot be established or the module doesn't respond.