Interface ReaderIntrface

  • All Known Implementing Classes:
    Reader

    public interface ReaderIntrface
    Interface implemented by the Base Class for Readers. Contains all the documents and APIs An array of Reader is initialized when Enumerate.USBConnect(android.content.Context) is called.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void BeepNow​(byte count, java.lang.Boolean longBeep)
      Call this function with the number of desired short or long beeps.
      byte GetActConfig()
      Get the active configuration ( 0..N ) of the pcProx Plus.
      int GetActDev()
      Return the current active device as an index into the list, 0..(GetDevCnt()-1).
      short GetActiveID​(int[] buffer, short bufferMaximumSize)
      Reads the active data from the card "presently on the reader".
      short GetActiveID32​(int[] buffer, short bufferMaximumSize)
      This is the 32 byte version of GetActiveID(int[], short) for the readers to get the card ID with up to 255 bits of data.
      boolean GetAZERTYShiftLock​(int configurationIndex)
      Get the state of the Shift Lock.
      short GetBeeperVolume()
      Gets the volume level for the pcProx Plus(version 2).
      int GetBLEConfiguration()
      Gets the BLE configuration of the reader.
      BprRlyCtrl GetBprRlyCtrl​(int configurationIndex)
      Get beeper (and relay on OEM W2-USB readers) controls.
      int GetCardPriority​(int configurationIndex)
      Get the Card Priority for the configuration index.
      int GetCardType​(int configurationIndex)
      Get the Card Type 0x0000..0xFFFE for the given configuration.
      java.lang.String GetDevName()
      This API is used to get the device name.
      java.lang.String GetDevType()
      Get the active device type.
      java.lang.String getDid()
      Returns the firmware version Major,Minor,Build as bits 15..8 Bits 7..4 and bits 3..0 respectively.
      char[] getESN()
      This Api will Returns the 32 byte electronic serial number embedded in the processor chip.
      boolean GetExtendedPrecisionMath​(int configurationIndex)
      Return the state of the ExtendedPrecisionMath flag.
      long GetFirmwareVersion​(short hardware, short module)
      Some devices have multiple firmware versions to report.
      ConfigurationFlags GetFlags​(int configurationIndex)
      Returns ConfigurationFlags object for the given configuration index.
      ConfigurationFlags2 GetFlags2​(int configurationIndex)
      Returns ConfigurationFlags2 object for the given configuration index.
      ConfigurationFlags3 GetFlags3​(int configurationIndex)
      Returns ConfigurationFlags3 object for the given configuration index.
      java.lang.String GetFullFWVersion()
      Reads the device's full Firmware version including the String version number.
      java.lang.String GetFWFilename()
      Reads the device firmware filename.
      IdBitCounts GetIDBitCnts​(int configurationIndex)
      Returns IdBitCounts object for the given configuration index.
      IdDisplayParameters GetIDDispParms​(int configurationIndex)
      IdDisplayParameters2 GetIDDispParms2​(int configurationIndex)
      To get IdDisplayParameters2 which contains: short iLeadChrCnt:
      IdDisplayParameters3 GetIDDispParms3​(int configurationIndex)
      To get IdDisplayParameters3 which contains: short iTrailChrCnt:
      byte GetLastLibErr()
      Returns the last library error code (see Library Error Codes) for the active device.
      LEDControl GetLEDControl()
      Get LEDControl information color red, green, amber, auto or off.
      java.lang.String getLibVersion()
      Get the version of the library code.
      int getLuid()
      Get Logical Unit ID from last ReadCfg(int) of device.
      int GetMaxConfig()
      Get number of configurations present in the reader.
      java.lang.String getPartNumberString()
      Read the device part number string.
      boolean GetQueuedID​(short clearUID, short clearHold)
      Read the Queued ID data from the reader.
      java.lang.String GetQueuedID_index​(short index)
      Return specific part of the data read by GetQueuedID() GetQueuedID() actuall gets data from the reader this funtions just marshalls the data back to the caller.
      byte GetRawPayload_index​(short index)  
      void GetSepFldData​(int[] sepFldDataBuffer, int configurationIndex)
      Get the FIPS 201 credentials and delimiters for all user defined fields.
      TimeParameters GetTimeParms​(int configurationIndex)
      Returns TimeParameters object for the given Configuration index.
      java.lang.String GetVidPidVendorName()
      This Api will return the VendorName string for the active device.
      boolean IsBLEPresent()
      To check whether the BLE(Bluetooth) is present or not.
      boolean IsCardTypeInList​(java.lang.String cardType)
      Is CardType in list? If the given card type is in the pcProx Plus Firmware List Return TRUE, else return FALSE.
      boolean isLoon()
      Checks whether a reader is loon or not.
      boolean LoadIniFile​(java.io.FileInputStream IniInputStream)
      Load the configuration in the reader which is mentioned in the file.
      boolean pcProxPlusDefaults()
      Reset pcProx Plus to defaults.
      void ReadCfg​(int configurationIndex)
      A call to this function pulls the device configuration information into the library memory space to be manipulated by the Get*() and Set*() functions.
      void ReadDevCfgFmFile​(java.io.FileInputStream HWGinputStream)
      Open and read an ASCII file and load the setting into the reader.This function reads files created with the WriteDevCfgToFile(OutputStream) function.
      void ReadDevCfgFmSecureFile​(java.io.FileInputStream HWGInputStream)
      This will check whether the Secure key which is present in the file is valid or not.
      boolean ReadSecureData​(byte[] headerBuffer, byte[] dataBuffer)
      This is to get and read the secure blob on a secure reader.
      void ResetFactoryDefaults()
      This sets the device configuration to the Factory Default values.
      boolean SaveUserDflts()
      Save Current As USER Default Configuration Save the current device's working configuration as the user defaults.
      void SetActConfig​(byte configurationIndex)
      Set the active configuration ( 0..N ) of the pcProx Plus device.
      void SetActDev​(int deviceIndex)
      Set the active device.
      void SetAZERTYShiftLock​(boolean AZERTYShiftLock, int configurationIndex)
      Set the state of the Shift Lock.
      boolean SetBeeperVolume​(byte volumeLevel)
      Sets the volume level for the pcProx Plus (version 2)(loon) reader.
      void SetBLEConfiguration​(byte level)
      Sets the BLE configuration of the reader.
      void SetBprRlyCtrl​(BprRlyCtrl bprRlyCtrl, int configurationIndex)
      Set beeper (and relay on OEM W2-USB readers) controls.
      boolean SetCardTypePriority​(int configurationIndex, int cardType, int cardPriority)
      Set the Card Type 0x0000..0xFFFF and the card priority for the given configuration index.
      void SetExtendedPrecisionMath​(boolean extendedPrecisionMath, int configurationIndex)
      Set the state of the extended precision math flag.
      void SetFlags​(ConfigurationFlags configurationFlags, int configurationIndex)
      Sets ConfigurationFlags object for the given configuration index.
      void SetFlags2​(ConfigurationFlags2 configurationFlags2, int configurationIndex)
      Sets ConfigurationFlags2 object for the given configuration index.
      void SetFlags3​(ConfigurationFlags3 configurationFlags3, int configurationIndex)
      Sets ConfigurationFlags3 object for the given configuration index.
      void SetIDBitCnts​(IdBitCounts idBitCounts, int configurationIndex)
      Sets IdBitCounts object for the given configuration index.
      void SetIDDispParms​(IdDisplayParameters idDisplayParameters, int configurationIndex)
      Set display parameters IdDisplayParameters to control how the card ID is displayed when keystroked out or sent serially on serial and RS-232 readers.IdDisplayParameters contains: short iFACIDDelim:
      void SetIDDispParms2​(IdDisplayParameters2 idDisplayParameters2, int configurationIndex)
      void SetIDDispParms3​(IdDisplayParameters3 idDisplayParameters3, int configurationIndex)
      void SetLEDControl​(LEDControl ledControl)
      Sets LEDControl information color red, green, amber, auto or off for the given configuration.
      void setLuid​(int luid)
      Set Logical unit ID to device.
      boolean SetRawPayload_index​(short index, short c)  
      void SetSepFldData​(int[] sepFldDataBuffer, int configurationIndex)
      Set the FIPS 201 credentials and delimiters for all user defined fields.
      void SetTimeParms​(TimeParameters timeParameters, int configurationIndex)
      Sets TimeParameters for the selected Configuration Index.
      void WriteCfg​(int configurationIndex)
      A call to this function writes all configuration information in the library memory space to the device for non-volatile storage.
      void WriteDevCfgToFile​(java.io.OutputStream HWGoutputStream)
      Write an ASCII file with all the setting of most recent the device setting read by ReadCfg().
      void WriteDevCfgToSecureFile​(java.io.OutputStream HWGOutputStream, java.io.FileInputStream HWGInputStream)
      Write an ASCII file with all the setting of most recent the device setting read by ReadCfg().
      boolean WriteSecureData​(java.util.List<java.lang.String> blobBuffer, int blobLen)
      This is to set and write the secure blob on a secure reader.
    • Method Detail

      • getDid

        java.lang.String getDid()
                         throws SDKException
        Returns the firmware version Major,Minor,Build as bits 15..8 Bits 7..4 and bits 3..0 respectively. Example: 0x0F12 = 15.1.2 Note: Do not compare version numbers from the pcProx firmware to enable or disable functions in your application as firmware version can change. The firmware version is for reference only and should not be used to make decision on what features are available.
        Returns:
        Firmware version
        Throws:
        SDKException
      • getLuid

        int getLuid()
        Get Logical Unit ID from last ReadCfg(int) of device.
        Returns:
        LUID a user defined 16-bit ID (0-65536) to be associated with the current selected device.
        See Also:
        setLuid(int)
      • setLuid

        void setLuid​(int luid)
              throws SDKException
        Set Logical unit ID to device.
        Parameters:
        luid - It is a user defined 16-bit ID (0-65536) to be associated with the current device. When multiple devices are connected they may enumerate in random order and the LUID is the safest way to tell them apart.

        This does not write the configuration items to the device, just to library memory. Setting the reader to defaults does not erase the LUID. Use WriteCfg(int) to write to device memory. Setting the reader to defaults does not erase the LUID.

        Throws:
        SDKException - if there is a failure in USB communication or LUID value is not in the allowed range.
        See Also:
        getLuid()
      • getPartNumberString

        java.lang.String getPartNumberString()
                                      throws SDKException
        Read the device part number string. This is a 24 character string such as "RDR-80581AKU" and null terminated.
        Returns:
        String value of device part number
        Throws:
        SDKException - if there is a failure in USB communication.
      • GetDevName

        java.lang.String GetDevName()
        This API is used to get the device name.

        e.g. "/dev/bus/usb/001/002"

        Returns:
        Device Name String
      • getLibVersion

        java.lang.String getLibVersion()
        Get the version of the library code. This does not communicate with any device. It returns the string from the BuildConfig file. The intended interpretation of the version name is Major.Minor.Build.Hotfix
        Returns:
        Version of the library code.
      • BeepNow

        void BeepNow​(byte count,
                     java.lang.Boolean longBeep)
              throws SDKException
        Call this function with the number of desired short or long beeps.
        Parameters:
        count - 1..N beeps, Range is 1..5 for short beeps and 1..2 for long beeps
        longBeep - long Beep = true, short beep = false
        Throws:
        SDKException - if count exceeds permissible range
      • GetMaxConfig

        int GetMaxConfig()
        Get number of configurations present in the reader. For pcProx Plus dual frequency readers this will be 1 or more and 0 for Legacy non pcProx Plus readers.
        Returns:
        0..N-1: 0 for non pcProx Plus, 1 or more for pcProx Plus. Here N stands for maximum configuration.
      • ReadCfg

        void ReadCfg​(int configurationIndex)
              throws SDKException,
                     java.lang.CloneNotSupportedException
        A call to this function pulls the device configuration information into the library memory space to be manipulated by the Get*() and Set*() functions. After altering the data the user must call WriteCfg(int) to write the changes back to device so they can take effect.
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration.
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        WriteCfg(int)
      • WriteCfg

        void WriteCfg​(int configurationIndex)
               throws SDKException,
                      java.lang.InterruptedException,
                      java.lang.CloneNotSupportedException
        A call to this function writes all configuration information in the library memory space to the device for non-volatile storage. Any changed parameters take effect immediately after WriteCfg(int).

        The actual write internally within the device is not done until all critical pending actions are complete. This may take up to two seconds, typically 1200 msec to complete.

        pcProx Plus(version 2) readers takes only 20ms to complete the write.

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.InterruptedException
        java.lang.CloneNotSupportedException
        See Also:
        ReadCfg(int)
      • GetCardType

        int GetCardType​(int configurationIndex)
                 throws SDKException
        Get the Card Type 0x0000..0xFFFE for the given configuration.
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration.
        Returns:
        0..0xFFFE for valid card types. -1 for error, disconnected, or non pcProx Plus reader.
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        SetCardTypePriority(int, int, int)
      • GetCardPriority

        int GetCardPriority​(int configurationIndex)
                     throws SDKException
        Get the Card Priority for the configuration index. The Priority is 0 or 1, and -1 indicates an error.
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration.
        Returns:
        0 = Low priority, 1 = high priority, -1 error.
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        SetCardTypePriority(int, int, int)
      • SetCardTypePriority

        boolean SetCardTypePriority​(int configurationIndex,
                                    int cardType,
                                    int cardPriority)
                             throws SDKException
        Set the Card Type 0x0000..0xFFFF and the card priority for the given configuration index. Card types not understood by the device firmware are ignored and will return as (0x0000) OFF.

        The priority bit if non-zero will have priority over other configurations that are set to zero. The priority allows dual frequency cards or multiple cards to be read in a predictable manner.

        Only one configuration should have the priority bit set, otherwise unpredictable results may occur on multiple card reads.

        It is not applicable for single config readers.

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        cardType - 16 bit card type
        cardPriority - 0 for low and 1 for high
        Returns:
        True = success , False = failure.
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or priority value is other than 0 or 1 or if there is a failure in USB communication.
        See Also:
        GetCardType(int), GetCardPriority(int)
      • GetActiveID

        short GetActiveID​(int[] buffer,
                          short bufferMaximumSize)
                   throws SDKException
        Reads the active data from the card "presently on the reader". This function will return the number of bits read. The buffer passed in arguments is populated with card data.

        It is recommended you do not call this faster than 250 msec, or about twice the data hold time of the active card. Call sooner than 250 msec will not be sent to the reader but will return cached data.

        It is valid only for cards less than 64 bits.

        Parameters:
        buffer - It is an empty int array of desired size. It will be populated with the active data from the card
        bufferMaximumSize - It specifies the size of the byte buffer. Maximum value is 8, if the value provided is more than 8, it will automatically reset to 8.
        Returns:
        It returns number of bits read from the reader representing the card ID

        It does NOT include the parity bits that may have been stripped from the ID through the use of the leading and/or trailing parity bit counts.

        A return value of zero means there is either no card within RF field or an error was encountered or a wrong card was presented.

        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetActiveID32(int[], short)
      • GetActiveID32

        short GetActiveID32​(int[] buffer,
                            short bufferMaximumSize)
                     throws SDKException
        This is the 32 byte version of GetActiveID(int[], short) for the readers to get the card ID with up to 255 bits of data. Cards with larger ID's than 64 bits will be truncated with GetActiveID(int[], short), so this function is recommended instead. This function will return the number of bits read. The buffer passed in arguments is populated with card data.

        It is recommended you do not call this faster than 250 msec, or about twice the data hold time of the active card. Call sooner than 250 msec will not be sent to the reader but will return cached data.

        Parameters:
        buffer - an empty int array of desired size. It will be populated with the active data from the card
        bufferMaximumSize - It specifies the size of the byte buffer. Maximum value is 32, if the value provided is more than 32, it will automatically reset to 32
        Returns:
        Number of bits Read 0..255

        It does NOT include the parity bits that may have been stripped from the ID through the use of the leading and/or trailing parity bit counts.

        A return value of zero means there is either no card within RF field or an error was encountered or a wrong card was presented.

        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetActiveID(int[], short)
      • GetBeeperVolume

        short GetBeeperVolume()
                       throws SDKException
        Gets the volume level for the pcProx Plus(version 2).
        Returns:
        Volume level 0..3 for the pcProx Plus(version 2) Reader.
        • 0- off
        • 1- low
        • 2- med
        • 3- High
        • -1- For non pcProx Plus(version 2)
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        SetBeeperVolume(byte)
      • SetBeeperVolume

        boolean SetBeeperVolume​(byte volumeLevel)
                         throws SDKException
        Sets the volume level for the pcProx Plus (version 2)(loon) reader.
        Parameters:
        volumeLevel - volumeLevel in range 0..3,
        • 0-off
        • 1-low
        • 2-med
        • 3-High
        Returns:
        true if successful, false otherwise
        Throws:
        SDKException - if Volume level is less than zero or greater than 3
        See Also:
        GetBeeperVolume()
      • isLoon

        boolean isLoon()
        Checks whether a reader is loon or not.
        Returns:
        true for loon readers, false otherwise
      • GetFWFilename

        java.lang.String GetFWFilename()
                                throws SDKException
        Reads the device firmware filename.

        e.g. "LNC160700UBX700". Works only for loon readers.

        Returns:
        String value of Firmware Filename on success
        Throws:
        SDKException - if there is a failure in USB communication.
      • GetFullFWVersion

        java.lang.String GetFullFWVersion()
                                   throws SDKException
        Reads the device's full Firmware version including the String version number.

        e.g. "16.07.0-7715". Works only for loon readers.

        Returns:
        Returns the Firmware version with the string version number for loon readers having version number 16.7 or greater. In case of failure it returns Null.
        Throws:
        SDKException - if there is a failure in USB communication.
      • GetFirmwareVersion

        long GetFirmwareVersion​(short hardware,
                                short module)
                         throws SDKException
        Some devices have multiple firmware versions to report. This function returns the long firmware version of the hardware and module pair. Not all modules are available for all hardware. These return 0 for unavailable. The version 0x01023456 can be expressed as "1.2.34.56". Note: Do not compare version numbers from the pcProx firmware to enable or disable functions in your application as firmware version can change. The firmware version is for reference only. For pcSwipe only Hardware "Main Cpu" App and bootloader are available.
        Parameters:
        hardware - Hardware 0 = Main CPU, 1 = Aux Cpu, 2-FF unused
        module - IModule 0 = Application, 1 = Bootloader, 2 = Modem
        Returns:
        long value for valid versions, 0 indicates unavailable.
        Throws:
        SDKException - if there is a failure in USB communication.
      • GetFlags

        ConfigurationFlags GetFlags​(int configurationIndex)
                             throws SDKException,
                                    java.lang.CloneNotSupportedException
        Returns ConfigurationFlags object for the given configuration index. ConfigurationFlags contains:
        • boolean bFixLenDsp:

          It will return whether the send fixed length FAC/ID is set or not

        • boolean bFrcBitCntEx:

          It will return whether the read bit count to be exact to be valid is set or not

        • boolean bStripFac:

          It returns whether the stripping of the FAC from the ID (not discarded) is set or not

        • boolean bSndFac:

          It returns whether the send FAC (if stripped from data) is set or not

        • boolean bUseDelFac2Id:

          It gives the delimiter placed between FAC and ID on send

        • boolean bNoUseELChar:

          It gives the termination keystroke set i.e. the last character after card ID (default to ENTER)

        • boolean bSndOnRx:

          It sends valid ID as soon as it is received (iIDLockOutTm timer not used)

        • boolean bHaltKBSnd:

          When set true,it dies not send keys to USB i.e. itdisables key strokes

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        ConfigurationFlags object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetFlags(ConfigurationFlags, int)
      • SetFlags

        void SetFlags​(ConfigurationFlags configurationFlags,
                      int configurationIndex)
               throws SDKException
        Sets ConfigurationFlags object for the given configuration index. ConfigurationFlags contains:
        • boolean bFixLenDsp:

          If set to true it will set the FAC digits and the ID digits to the number specified by the user

        • boolean bFrcBitCntEx:

          It forces the read bit count to be exact to be valid

        • boolean bStripFac:

          It sets the stripping of the FAC from the ID (not discarded)

        • boolean bSndFac:

          When true, it allows to Send the FAC (if stripped from data)

        • boolean bUseDelFac2Id:

          It puts a delimiter between FAC and ID on send

        • boolean bNoUseELChar:

          It sets the termination keystroke i.e. the last character after card ID (default to ENTER)

        • boolean bSndOnRx:

          It sends valid ID as soon as it is received (iIDLockOutTm timer not used)

        • boolean bHaltKBSnd:

          When set true,it dies not send keys to USB i.e. itdisables key strokes

        Parameters:
        configurationFlags - ConfigurationFlags object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        GetFlags(int)
      • GetFlags2

        ConfigurationFlags2 GetFlags2​(int configurationIndex)
                               throws SDKException,
                                      java.lang.CloneNotSupportedException
        Returns ConfigurationFlags2 object for the given configuration index. ConfigurationFlags2 contains:
        • boolean bUseLeadChrs:

          It returns whether the Use leading chars in ID KB send is set or not

        • boolean bDspHex:

          It returns whether display ID as ASCII Hex [not ASCII decimal] is set or not

        • boolean bWiegInvData:

          It returns whether the wiegand data on pins is inverted or not

        • boolean bUseInvDataF:

          It returns whether the bWiegInvData flag over hardware setting is set or not

        • boolean bRevWiegBits:

          It returns whether the reverse the Wiegand read bits is set or not

        • boolean bBeepID:

          It returns whether the beep when ID is received is set or not

        • boolean bRevBytes:

          It returns whether the reverse the byte order (CSN reader) is set or not

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        ConfigurationFlags2 object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetFlags2(ConfigurationFlags2, int)
      • SetFlags2

        void SetFlags2​(ConfigurationFlags2 configurationFlags2,
                       int configurationIndex)
                throws SDKException
        Sets ConfigurationFlags2 object for the given configuration index. ConfigurationFlags2 contains:
        • boolean bUseLeadChrs:

          It is set to Use leading chars in ID KB send

        • boolean bDspHex:

          It is set to display ID as ASCII Hex [not ASCII decimal]l

        • boolean bWiegInvData:

          It is set if wiegand data on pins is inverted

        • boolean bUseInvDataF:

          It is set to use the bWiegInvData flag over hardware setting

        • boolean bRevWiegBits:

          It is set to reverse the Wiegand read bits

        • boolean bBeepID:

          It is set to let the device beep when ID is received

        • boolean bRevBytes:

          It is set to reverse the byte order (CSN reader)

        Parameters:
        configurationFlags2 - ConfigurationFlags2 object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        GetFlags2(int)
      • GetFlags3

        ConfigurationFlags3 GetFlags3​(int configurationIndex)
                               throws SDKException,
                                      java.lang.CloneNotSupportedException
        Returns ConfigurationFlags3 object for the given configuration index. ConfigurationFlags3 contains:
        • boolean bUseNumKP:

          Euro Keyboard flag

        • boolean bSndSFON:

          Split format ON = 1, old combined scheme = 0

        • boolean bSndSFFC:

          It allows to send FAC as hexadecimal number in keystroke output. 0 = FAC Decimal, 1 = FAC Hex

        • boolean bSndSFID:

          It allows to send ID as hexadecimal number in keystroke output. 0 = ID as decimal, 1 = ID as hex.

        • boolean bPrxProEm:

          Emulate serial data format to match HID Corp. Prox Pro reader by sending a 2 byte checksum after the card data

        • boolean bUse64Bit:

          It sets the Extended precison math on for ID. 0 = 32-bit, 1 = 64-bit.

        • boolean bNotBootDev:

          USB Enum: 0=BootDevice, 1=NOTBootDevice

        • boolean bLowerCaseHex:

          Keystroke out the card data in lowercase hexadecimal. 0 = uppercase hexadecimal, 1 = lowercase hexadecimal

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        ConfigurationFlags3 object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetFlags3(ConfigurationFlags3, int)
      • SetFlags3

        void SetFlags3​(ConfigurationFlags3 configurationFlags3,
                       int configurationIndex)
                throws SDKException,
                       java.lang.CloneNotSupportedException
        Sets ConfigurationFlags3 object for the given configuration index. ConfigurationFlags3 contains:
        • boolean bUseNumKP:

          Euro Keyboard flag

        • boolean bSndSFON:

          Split format ON = 1, old combined scheme = 0

        • boolean bSndSFFC:

          It allows to send FAC as hexadecimal number in keystroke output. 0 = FAC Decimal, 1 = FAC Hex

        • boolean bSndSFID:

          It allows to send ID as hexadecimal number in keystroke output. 0 = ID as decimal, 1 = ID as hex.

        • boolean bPrxProEm:

          Emulate serial data format to match HID Corp. Prox Pro reader by sending a 2 byte checksum after the card data

        • boolean bUse64Bit:

          It sets the Extended precison math on for ID. 0 = 32-bit, 1 = 64-bit.

        • boolean bNotBootDev:

          USB Enum: 0=BootDevice, 1=NOTBootDevice

        • boolean bLowerCaseHex:

          Keystroke out the card data in lowercase hexadecimal. 0 = uppercase hexadecimal, 1 = lowercase hexadecimal

        Parameters:
        configurationFlags3 - ConfigurationFlags3 object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        GetFlags3(int)
      • GetIDBitCnts

        IdBitCounts GetIDBitCnts​(int configurationIndex)
                          throws SDKException,
                                 java.lang.CloneNotSupportedException
        Returns IdBitCounts object for the given configuration index. IdBitCounts contains:
        • short iLeadParityBitCnt:

          It gives the number of most significant bits stripped. The number should be in range 0..15 for single config readers, 0..142 otherwise

        • short iTrailParityBitCnt:

          It gives the number of least significant bits stripped. The number should be in range 0..15 for single config readers, 0..142 otherwise

        • short iIDBitCnt:

          It gives the value of id bit field count which should be in range 0..255

        • short iTotalBitCnt:

          It gives the value of the total bit counts that can be read by the device. The value should be in range 26..255

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        IdBitCounts object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetIDBitCnts(IdBitCounts, int)
      • SetIDBitCnts

        void SetIDBitCnts​(IdBitCounts idBitCounts,
                          int configurationIndex)
                   throws SDKException,
                          java.lang.CloneNotSupportedException
        Sets IdBitCounts object for the given configuration index. IdBitCounts contains:
        • short iLeadParityBitCnt:

          It strips the most significant bits from the output of the card, as per the value passed in arguments. The value should be in range 0..15 for single config readers, 0..142 otherwise

        • short iTrailParityBitCnt:

          It strips the least significant bits from the output of the card, as per the value passed in arguments. The value should be in range 0..15 for single config readers, 0..142 otherwise

        • short iIDBitCnt:

          It sets the id field bit count as per the argument passed with it. The value should be in range 1..255

        • short iTotalBitCnt:

          It sets the value in argument to the total bits that can only be read by the card. The value should be in range 26..255

        Parameters:
        idBitCounts - IdBitCounts object
        configurationIndex - 0..N-1, N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or input values exceeds the allowed range or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        GetIDBitCnts(int)
      • GetTimeParms

        TimeParameters GetTimeParms​(int configurationIndex)
                             throws SDKException,
                                    java.lang.CloneNotSupportedException
        Returns TimeParameters object for the given Configuration index. TimeParameters contains:
        • short iBitStrmTO:

          Wiegand read T/O after this msec time (4ms). The range should be 0..1020

        • short iIDHoldTO:

          Card ID valid for this msec time (48ms). The range should be 0..12750

        • short iIDLockOutTm:

          Squelch repetitive reader reports (usually > 1000) in msec (48msec gran.). The range should be 0..12750

        • short iUSBKeyPrsTm:

          It sets USB inter-key 'Press' time in 4ms units. The range should be 0..1020

        • short iUSBKeyRlsTm:

          It sets USB inter-key 'Release' time in 4ms units. The range should be 0..1020

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        TimeParameters object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetTimeParms(TimeParameters, int)
      • SetTimeParms

        void SetTimeParms​(TimeParameters timeParameters,
                          int configurationIndex)
                   throws SDKException
        Sets TimeParameters for the selected Configuration Index. TimeParameters contains:
        • short iBitStrmTO:

          Wiegand read T/O after this msec time (4ms)

        • short iIDHoldTO:

          Card ID valid for this msec time (48ms)

        • short iIDLockOutTm:

          Squelch repetitive reader reports (usually > 1000) in msec (48msec gran.)

        • short iUSBKeyPrsTm:

          Sets USB inter-key 'Press' time in 4ms units

        • short iUSBKeyRlsTm:

          Sets USB inter-key 'Release' time in 4ms units

        • short ExFeatures01:

          Extended Features (big parity Azery ext precision)

        Parameters:
        timeParameters - Object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if input values are out of allowed range or if there is a failure in USB communication.
        See Also:
        GetTimeParms(int)
      • GetLEDControl

        LEDControl GetLEDControl()
                          throws SDKException,
                                 java.lang.CloneNotSupportedException
        Get LEDControl information color red, green, amber, auto or off. LEDControl Contains:
        • boolean bAppCtrlsLED:

          It gives true if the control is set to auto mode

        • boolean iRedLEDState:

          It gives true if the LED state is set to Red color

        • boolean iGrnLEDState:

          It gives true if the LED state is set to Green color

        • Color of LED is AMBER when both iGRnLEDState and iRedLEDState are true and bAppCtrlsLED is false

        • LED is turned OFF when bAppCtrlsLED, iGRnLEDState and iRedLEDState are false

        Returns:
        LEDControl Object
        Throws:
        SDKException - if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetLEDControl(LEDControl)
      • GetActDev

        int GetActDev()
        Return the current active device as an index into the list, 0..(GetDevCnt()-1). Note: The USB order of devices found can be random. Use the LUID to uniquely tag your devices. Then enumerate through the active device list for the LUID you need.
        Parameters:
        None -
        Returns:
        Active device 0..126
      • SetActDev

        void SetActDev​(int deviceIndex)
        Set the active device. The selected device is the active device that ReadCfg() and WriteCfg() operate on.
        Parameters:
        Set - the active device where deviceIndex selects a new device for processing. This does not require a WriteCfg() to be performed as it is only selecting the device to which we are communicating with via the library.
        See Also:
        GetActDev()
      • SetLEDControl

        void SetLEDControl​(LEDControl ledControl)
                    throws SDKException
        Sets LEDControl information color red, green, amber, auto or off for the given configuration. LEDControl Contains:
        • boolean bAppCtrlsLED:

          It sets the control to auto mode

        • boolean iRedLEDState:

          It sets the LED state to Red color

        • boolean iGrnLEDState:

          It sets the LED state to Green color

        • Setting both iGRnLEDState and iRedLEDState to true and bAppCtrlsLED to false changes the LED to AMBER

        • Setting both iGRnLEDState and iRedLEDState to false will turn the LED OFF

        Parameters:
        ledControl - LEDControl object
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetLEDControl()
      • GetAZERTYShiftLock

        boolean GetAZERTYShiftLock​(int configurationIndex)
                            throws SDKException
        Get the state of the Shift Lock. Some keyboards such as French keyboards have a shift lock key in place of the US caps lock key. This affects how the top row of numbers and punctuation are usedThis sets the device configuration to the Factory Default values. It is
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        Boolean: the value of AzertyShiftLock (true if set, false if not)
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        SetAZERTYShiftLock(boolean, int)
      • SetAZERTYShiftLock

        void SetAZERTYShiftLock​(boolean AZERTYShiftLock,
                                int configurationIndex)
                         throws SDKException
        Set the state of the Shift Lock. Some keyboards such as French keyboards have a shift lock key in place of the US caps lock key. This affects how the top row of numbers and punctuation are used.
        Parameters:
        AZERTYShiftLock - state of AZERTShift lock to be set: true or false
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetAZERTYShiftLock(int)
      • GetExtendedPrecisionMath

        boolean GetExtendedPrecisionMath​(int configurationIndex)
                                  throws SDKException
        Return the state of the ExtendedPrecisionMath flag. This affects the FAC value when it is longer than 32 bit
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        boolean state of ExtendedPrecisionMath on (true = 64-bits, false = 32-bits)
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        SetExtendedPrecisionMath(boolean, int)
      • SetExtendedPrecisionMath

        void SetExtendedPrecisionMath​(boolean extendedPrecisionMath,
                                      int configurationIndex)
                               throws SDKException
        Set the state of the extended precision math flag. This affects the FAC value when it is longer than 32 bits. When off FAC values over 32 bits will not be displayed properly
        Parameters:
        extendedPrecisionMath - of extendedPrecisionMath lock to be set: true or false
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetExtendedPrecisionMath(int)
      • ResetFactoryDefaults

        void ResetFactoryDefaults()
                           throws SDKException,
                                  java.lang.CloneNotSupportedException
        This sets the device configuration to the Factory Default values. It is like a WriteCfg(int) call.

        Before returning to the caller, this function calls ReadCfg() to reload the configuration information (which may have changed) into the library memory.

        Throws:
        SDKException - if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
      • GetBLEConfiguration

        int GetBLEConfiguration()
                         throws SDKException
        Gets the BLE configuration of the reader. It is applicable only for loon readers which support bluetooth functionality.
        Returns:
        level:
        • 0 for BLE off/125KHz-13.56MHz radios off
        • 1 for BLE off/125KHz-13.56MHz radios on
        • 2 for BLE on/125KHz-13.56MHz radios off
        • 3 for BLE on/125KHz-13.56MHz radios on
        • -1 for unsupported readers
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        SetBLEConfiguration(byte)
      • SetBLEConfiguration

        void SetBLEConfiguration​(byte level)
                          throws SDKException
        Sets the BLE configuration of the reader.
        Parameters:
        level - 0, 1, 2, 3 or 4
        • 0:BLE off/125KHz-13.56MHz radios off
        • 1:BLE off/125KHz-13.56MHz radios on
        • 2:BLE on/125KHz-13.56MHz radios off
        • 3:BLE on/125KHz-13.56MHz radios on
        • 4:BLE off/125KHz-13.56MHz radios toggle
        Throws:
        SDKException - if there is a failure in USB communication or level is not between 0-4.
        See Also:
        GetBLEConfiguration()
      • IsBLEPresent

        boolean IsBLEPresent()
                      throws SDKException
        To check whether the BLE(Bluetooth) is present or not.
        Returns:
        true if successful, false otherwise
        Throws:
        SDKException - if there is a failure in USB communication.
        See Also:
        GetBLEConfiguration()
      • GetSepFldData

        void GetSepFldData​(int[] sepFldDataBuffer,
                           int configurationIndex)
                    throws SDKException
        Get the FIPS 201 credentials and delimiters for all user defined fields. This is for pcProx or OEM Wiegand converter board that can read FIPS 201 CHUID's. Usually from 75 to 245 bits make up some or all of the FIPS 201 fields. OEM Readers such as the HID-G3 75 bit reader is support by the OEM converter board.
        Parameters:
        sepFldDataBuffer - int buffer
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        SetSepFldData(int[], int)
      • SetSepFldData

        void SetSepFldData​(int[] sepFldDataBuffer,
                           int configurationIndex)
                    throws SDKException
        Set the FIPS 201 credentials and delimiters for all user defined fields. This is for pcProx or OEM Wiegand converter board that can read FIPS 201 CHUID's. Usually from 75 to 245 bits make up some or all of the FIPS 201 fields. OEM Readers such as the HID-G3 75 bit reader is supported by the OEM converter board
        Parameters:
        sepFldDataBuffer - int buffer
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        GetSepFldData(int[], int)
      • GetBprRlyCtrl

        BprRlyCtrl GetBprRlyCtrl​(int configurationIndex)
                          throws SDKException,
                                 java.lang.CloneNotSupportedException
        Get beeper (and relay on OEM W2-USB readers) controls.
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        BprRlyCtrl object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        GetBprRlyCtrl(int)
      • SetBprRlyCtrl

        void SetBprRlyCtrl​(BprRlyCtrl bprRlyCtrl,
                           int configurationIndex)
                    throws SDKException
        Set beeper (and relay on OEM W2-USB readers) controls.
        Parameters:
        bprRlyCtrl - object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        See Also:
        SetSepFldData(int[], int)
      • GetIDDispParms

        IdDisplayParameters GetIDDispParms​(int configurationIndex)
                                    throws SDKException,
                                           java.lang.CloneNotSupportedException
        To get IdDisplayParameters. IdDisplayParameters conatins:
        • short iFACIDDelim:

          If bStripFac & bSndFac & bUseDelFac2Id, this char is sent between FAC & ID. This delimiter appears as a seperator between FAC and ID in keystroke output

        • short iELDelim:

          If NOT bNoUseELChar, this char when set appears at the end of the ID in keystroked card output

        • short iDDispLen:

          If bFixLenDsp is true, ID is padded with zeros/stripped to achieve this length

        • short iFACDispLen:

          If bFixLenDsp is true, FAC is padded with zeros/stripped to achieve this length

        • short iExOutputFormat:

          This allows to choose one of the two format modes: data format or extend mode(if supported by reader)

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        IdDisplayParameters object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetIDDispParms(IdDisplayParameters, int)
      • SetIDDispParms

        void SetIDDispParms​(IdDisplayParameters idDisplayParameters,
                            int configurationIndex)
                     throws SDKException
        Set display parameters IdDisplayParameters to control how the card ID is displayed when keystroked out or sent serially on serial and RS-232 readers.IdDisplayParameters contains:
        • short iFACIDDelim:

          If bStripFac & bSndFac & bUseDelFac2Id, this char is sent between FAC & ID. This delimiter appears as a seperator between FAC and ID in keystroke output

        • short iELDelim:

          If NOT bNoUseELChar, this char when set appears at the end of the ID in keystroked card output

        • short iDDispLen:

          If bFixLenDsp is true, ID is padded with zeros/stripped to achieve this length

        • short iFACDispLen:

          If bFixLenDsp is true, FAC is padded with zeros/stripped to achieve this length

        • short iExOutputFormat:

          This allows to choose one of the two format modes: data format or extend mode(if supported by reader)

        Parameters:
        idDisplayParameters - Object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if input values are out of allowed range or if there is a failure in USB communication.
        See Also:
        GetIDDispParms(int)
      • GetIDDispParms2

        IdDisplayParameters2 GetIDDispParms2​(int configurationIndex)
                                      throws SDKException,
                                             java.lang.CloneNotSupportedException
        To get IdDisplayParameters2 which contains:
        • short iLeadChrCnt:

          If bUseLeadChrs, then it is set with lead character counts(<=3). And according to the count, characters can be sent at the beginning of the card data. Three delimiters total are allowed and can be split between leading and trailing characters

        • short iLeadChr0:

          First Leading character. The char set will be displayed in the beginnning of card data.

        • short iLeadChr1:

          Second Leading character. If previous lead char is 0 then it will shift to previous position.

        • short iLeadChr2:

          Third Leading character. If previous lead char is 0 then it will shift to previous position.

        • short iCrdGnChr0:

          First card gone character. It is sent/ displayed in output when card is gone from the field

        • short iCrdGnChr0:

          Second card gone character. If the previous card gone char is zero then it will shift to the previous position

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        IdDisplayParameters2 object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetIDDispParms2(IdDisplayParameters2, int)
      • SetIDDispParms2

        void SetIDDispParms2​(IdDisplayParameters2 idDisplayParameters2,
                             int configurationIndex)
                      throws SDKException
        To set IdDisplayParameters2. Mainly controls the leading and trailing delimiters. IdDisplayParameters2 contains:
        • short iLeadChrCnt:

          If bUseLeadChrs, then it is set with lead character counts(<=3). And according to the count, characters can be sent at the beginning of the card data. Three delimiters total are allowed and can be split between leading and trailing characters

        • short iLeadChr0:

          First Leading character. The char set will be displayed in the beginnning of card data.

        • short iLeadChr1:

          Second Leading character. If previous lead char is 0 then it will shift to previous position.

        • short iLeadChr2:

          Third Leading character. If previous lead char is 0 then it will shift to previous position.

        • short iCrdGnChr0:

          First card gone character. It is sent/ displayed in output when card is gone from the field

        • short iCrdGnChr0:

          Second card gone character. If the previous card gone char is zero then it will shift to the previous position

        Three delimiters total are allowed and can be split between leading and trailing characters
        Parameters:
        idDisplayParameters2 - Object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if input values are out of allowed range or if there is a failure in USB communication.
        See Also:
        GetIDDispParms2(int)
      • GetIDDispParms3

        IdDisplayParameters3 GetIDDispParms3​(int configurationIndex)
                                      throws SDKException,
                                             java.lang.CloneNotSupportedException
        To get IdDisplayParameters3 which contains:
        • short iTrailChrCnt:

          It contains the trailing character count(<=3). The sum of iTrailChrCnt and iLeadChrCnt should be =<3. And according to the count, characters can be sent at the end of the card data (ID).

        • short iTrailChr0:

          First trailing character. The char set will be displayed in the end of the ID of card data.

        • short iTrailChr1:

          Second trailing character. If previous trailing char is 0 then it will shift to previous position.

        • short iTrailChr2:

          Third trailing character. If previous trailing char is 0 then it will shift to previous position.

        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Returns:
        IdDisplayParameters3 object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.lang.CloneNotSupportedException
        See Also:
        SetIDDispParms3(IdDisplayParameters3, int)
      • SetIDDispParms3

        void SetIDDispParms3​(IdDisplayParameters3 idDisplayParameters3,
                             int configurationIndex)
                      throws SDKException
        To set IdDisplayParameters3. Mainly controls the leading and trailing delimiters. IdDisplayParameters3 contains:
        • short iTrailChrCnt:

          It contains the trailing character count(<=3). The sum of iTrailChrCnt and iLeadChrCnt should be =<3. And according to the count, characters can be sent at the end of the card data (ID).

        • short iTrailChr0:

          First trailing character. The char set will be displayed in the end of the ID of card data.

        • short iTrailChr1:

          Second trailing character. If previous trailing char is 0 then it will shift to previous position.

        • short iTrailChr2:

          Third trailing character. If previous trailing char is 0 then it will shift to previous position.

        Parameters:
        idDisplayParameters3 - Object
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if input values are out of allowed range or if there is a failure in USB communication.
        See Also:
        GetIDDispParms3(int)
      • ReadDevCfgFmFile

        void ReadDevCfgFmFile​(java.io.FileInputStream HWGinputStream)
                       throws java.io.IOException,
                              SDKException,
                              java.lang.InterruptedException,
                              java.lang.CloneNotSupportedException
        Open and read an ASCII file and load the setting into the reader.This function reads files created with the WriteDevCfgToFile(OutputStream) function.
        Parameters:
        HWGinputStream - object an instance of FileInputStream created from a hwg file
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.io.IOException
        java.lang.InterruptedException
        java.lang.CloneNotSupportedException
        See Also:
        WriteDevCfgToFile(OutputStream)
      • ReadDevCfgFmSecureFile

        void ReadDevCfgFmSecureFile​(java.io.FileInputStream HWGInputStream)
                             throws java.io.IOException,
                                    SDKException,
                                    java.lang.InterruptedException,
                                    java.lang.CloneNotSupportedException
        This will check whether the Secure key which is present in the file is valid or not. Open and read an ASCII file and load the setting into the reader.This function reads files created with the WriteDevCfgToSecureFile(OutputStream, FileInputStream) function.
        Parameters:
        HWGInputStream - object an instance of FileInputStream created from a hwg file
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.io.IOException
        java.lang.InterruptedException
        java.lang.CloneNotSupportedException
        See Also:
        WriteDevCfgToSecureFile(OutputStream, FileInputStream)
      • WriteDevCfgToFile

        void WriteDevCfgToFile​(java.io.OutputStream HWGoutputStream)
                        throws java.io.IOException,
                               SDKException,
                               java.lang.CloneNotSupportedException
        Write an ASCII file with all the setting of most recent the device setting read by ReadCfg(). This writes the buffered data held by the library to a file. The user should call ReadCfg() or WriteCfg() to make sure the correct values are sync'ed with the device memory. The file can be loaded back into the device with function ReadDevCfgFmFile().
        Parameters:
        HWGoutputStream - object
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.io.IOException
        java.lang.CloneNotSupportedException
        See Also:
        ReadDevCfgFmFile(FileInputStream)
      • WriteDevCfgToSecureFile

        void WriteDevCfgToSecureFile​(java.io.OutputStream HWGOutputStream,
                                     java.io.FileInputStream HWGInputStream)
                              throws java.io.IOException,
                                     SDKException,
                                     java.lang.CloneNotSupportedException
        Write an ASCII file with all the setting of most recent the device setting read by ReadCfg(). This writes the buffered data held by the library to a file. The user should call ReadCfg() or WriteCfg() to make sure the correct values are sync'ed with the device memory. The file can be loaded back into the device with function ReadDevCfgFmFile(). It will generate the Secure key for the file and append at the end of the file
        Parameters:
        HWGOutputStream - object
        HWGInputStream - object an instance of FileInputStream created from the same hwg file that you opened for writing.
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
        java.io.IOException
        java.lang.CloneNotSupportedException
        See Also:
        ReadDevCfgFmSecureFile(FileInputStream)
      • SetActConfig

        void SetActConfig​(byte configurationIndex)
                   throws SDKException
        Set the active configuration ( 0..N ) of the pcProx Plus device. pcProx Plus readers will return 0, 1, 2..N and Non pcProx Plus readers will return 0.
        Parameters:
        configurationIndex - 0..N-1, where N stands for maximum configuration
        Throws:
        SDKException - if configurationIndex exceeds maximum Config or if there is a failure in USB communication.
      • GetActConfig

        byte GetActConfig()
                   throws SDKException
        Get the active configuration ( 0..N ) of the pcProx Plus. For devices that only have one configuration this will return 0. All devices have one configuration, so zero is always valid.
        Returns:
        Throws:
        SDKException
      • GetDevType

        java.lang.String GetDevType()
                             throws SDKException
        Get the active device type. It will return PRXDEVTYP_ for USB, Serial or TCP/IP on the Active Device.
        Returns:
        Throws:
        SDKException
      • GetQueuedID

        boolean GetQueuedID​(short clearUID,
                            short clearHold)
                     throws SDKException
        Read the Queued ID data from the reader. This returns the last card read by the reader, age and overrun counter. The age is is from 0 - 0x00FFFF in 48msec units up to 52 minutes The overrun is the number of cards read before the UID was transfered to the PC. It is recommended not to call this faster than 250ms, or about twice the data hold time of the active card. After this call returns TRUE (Success) you may call GetQueuedID_index()
        Parameters:
        clearUID - if clearUID is set then the card, and overrun counters will be cleared for the next read.
        clearHold - if clearHold is set then the reader is ready to read another card immediately.
        Returns:
        Returns TRUE success, or FALSE failed (perhaps function is not available in the firmware)
        Throws:
        SDKException
      • GetVidPidVendorName

        java.lang.String GetVidPidVendorName()
                                      throws SDKException
        This Api will return the VendorName string for the active device. This comes from the optional pcProxVidPid.txt file.
        Returns:
        String value of device vendor Name
        Throws:
        SDKException - if there is a failure in USB communication.
      • getESN

        char[] getESN()
               throws SDKException
        This Api will Returns the 32 byte electronic serial number embedded in the processor chip.
        Returns:
        32 byte String ESN for loon USB readers and else return NULL.
        Throws:
        SDKException - if there is a failure in USB communication.
      • GetQueuedID_index

        java.lang.String GetQueuedID_index​(short index)
        Return specific part of the data read by GetQueuedID() GetQueuedID() actuall gets data from the reader this funtions just marshalls the data back to the caller. GetQueuedID_index() index 0 .. 35
        Returns:
        index 0..31 = Bytes 0.. 31 of the UserID index 32 = String Number of bits read 0-256 index 33 = String Age (16 bits) 0 - 65,535 48msec ticks or 0 to 52 minutes index 34 = String Overrun counter number of cards before UID transfered to PC. index 35 = String lockout timer 0-256 (0=ready to read) Overrun clipped at 255, and age clipped at 0x00FFFF
        See Also:
        GetQueuedID()
      • IsCardTypeInList

        boolean IsCardTypeInList​(java.lang.String cardType)
        Is CardType in list? If the given card type is in the pcProx Plus Firmware List Return TRUE, else return FALSE. A 0 card type (CARDTYPE_OFF) is always in the list and returns TRUE. If the pcProx Plus does not have a list then all cards types are assumed to be in the list.
        Parameters:
        cardType - 0..FFFF
        Returns:
        TRUE card type in list -- FALSE not in list
        See Also:
        GetCardType()
      • GetLastLibErr

        byte GetLastLibErr()
        Returns the last library error code (see Library Error Codes) for the active device. The last error code is valid until another library call is made. This does not reset the last library error code. When a function returns FALSE and has failed, it is good practice to call this function to check the error code.
        Parameters:
        None -
        Returns:
        byte error code value bits
        • 0x0002- READ_CFG_FAIL
        • 0x01- GET_ACTIVE_ID_FAIL
        • 0x0004- WRITE_CFG_FAIL
        See Also:
        SetActDev()
      • pcProxPlusDefaults

        boolean pcProxPlusDefaults()
                            throws java.lang.InterruptedException,
                                   SDKException
        Reset pcProx Plus to defaults. This copies the Default settings configurations to the Active settings configurations and Stored Settings. You will need to call ReadCfg() to get the changed settings into your application.
        Parameters:
        None -
        Returns:
        TRUE success / FALSE Fail
        Throws:
        java.lang.InterruptedException
        SDKException
        See Also:
        ResetUserDflts()
      • SaveUserDflts

        boolean SaveUserDflts()
                       throws SDKException,
                              java.lang.InterruptedException
        Save Current As USER Default Configuration Save the current device's working configuration as the user defaults. user defaults. Execution time ~ 2 seconds. For pcProx Plus this Writes the stored settings.
        Parameters:
        None -
        Returns:
        TRUE success / FALSE Fail
        Throws:
        SDKException
        java.lang.InterruptedException
        See Also:
        ResetUserDflts()
      • ReadSecureData

        boolean ReadSecureData​(byte[] headerBuffer,
                               byte[] dataBuffer)
                        throws java.lang.InterruptedException,
                               SDKException
        This is to get and read the secure blob on a secure reader. Read the configuration as requested in header (blob details: Type, config, length, BSV).
        Parameters:
        headerBuffer - pointer (reference) to byte buffer to send the blob details to reader.
        dataBuffer - pointer (reference) to byte buffer to get the data present on reader
        Returns:
        TRUE success / FALSE Fail
        Throws:
        java.lang.InterruptedException
        SDKException
      • WriteSecureData

        boolean WriteSecureData​(java.util.List<java.lang.String> blobBuffer,
                                int blobLen)
                         throws java.lang.InterruptedException,
                                SDKException
        This is to set and write the secure blob on a secure reader. Write the configuration as requested in header(blob details: Type, config, length, BSV).
        Parameters:
        blobBuffer - reference to List buffer which is a to send the blob details and data to reader.
        blobLen - is the integer value for length of List buffer whose reference is sent.
        Returns:
        TRUE success / FALSE Fail
        Throws:
        java.lang.InterruptedException
        SDKException
      • LoadIniFile

        boolean LoadIniFile​(java.io.FileInputStream IniInputStream)
                     throws java.io.IOException,
                            SDKException,
                            java.lang.InterruptedException
        Load the configuration in the reader which is mentioned in the file.
        Parameters:
        IniInputStream - object an instance of FileInputStream created from a ini file
        Throws:
        SDKException - if there is a failure in USB communication.
        java.io.IOException
        java.lang.InterruptedException
      • GetRawPayload_index

        byte GetRawPayload_index​(short index)