Class ISOReader

    • Constructor Detail

      • ISOReader

        public ISOReader​(String identifier,
                         ICommConnection connection,
                         ISOReader.MODE mode,
                         ISOReader.SRI sri,
                         String... minReaderRevision)
        Creates a new MifareReader with the specified connection, mode and sri
        Parameters:
        identifier - reader identifier
        connection - connection
        mode - mode
        sri - sri
        minReaderRevision - minimal reader revision
      • ISOReader

        @Deprecated
        public ISOReader​(String identifier,
                         String usbDeviceSerialNumber,
                         ISOReader.MODE mode,
                         ISOReader.SRI sri)
        Deprecated.
        Use the reader classes ( QuasarMX, QuasarLR, DeskID_ISO, Dwarf15, QR15) for instantiate the reader
        Creates a new ISOReader class for communicate with the specified metraTec usb reader
        Parameters:
        identifier - reader identifier
        usbDeviceSerialNumber - serial number of the usb hf reader
        mode - mode
        sri - sri
      • ISOReader

        @Deprecated
        public ISOReader​(String identifier,
                         String ipAddress,
                         int port,
                         ISOReader.MODE mode,
                         ISOReader.SRI sri)
        Deprecated.
        Use the reader classes ( QuasarMX, QuasarLR, DeskID_ISO, Dwarf15, QR15) for instantiate the reader
        Creates a new ISOReader class for communicate with the specified metraTec ethernet reader
        Parameters:
        identifier - reader identifier
        ipAddress - ip address of the ethernet hf reader
        port - port of the ethernet hf reader
        mode - mode
        sri - sri
      • ISOReader

        @Deprecated
        public ISOReader​(String identifier,
                         String portName,
                         int baudrate,
                         int dataBit,
                         int stopBit,
                         int parity,
                         int flowControl,
                         ISOReader.MODE mode,
                         ISOReader.SRI sri)
        Deprecated.
        Use the reader classes ( QuasarMX, QuasarLR, DeskID_ISO, Dwarf15, QR15) for instantiate the reader
        Creates a new ISOReader class for communicate with the specified metraTec rs232 reader
        Parameters:
        identifier - reader identifier
        portName - port on which the rs232 hf reader is connected
        baudrate - baudrate of the rs232 hf reader
        dataBit - rs232 databits
        stopBit - rs232 stopbit
        parity - rs232 parity
        flowControl - rs232 flowcontrol
        mode - mode
        sri - sri
    • Method Detail

      • getInventorySingleSlot

        public List<String> getInventorySingleSlot()
                                            throws RFIDReaderException,
                                                   CommConnectionException
        looks for all tags in range of the reader (used single slot) and get the Tag IDs of all tags as a number of strings back
        Returns:
        List with the Tag IDs of founded tags
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • getInventoryUnique

        public List<String> getInventoryUnique()
                                        throws RFIDReaderException,
                                               CommConnectionException
        looks for all new tags in range of the reader and get the Tag IDs of all tags as a number of strings back
        Returns:
        List with the Tag IDs of founded tags
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • getInventoryUniqueSingleSlot

        public List<String> getInventoryUniqueSingleSlot()
                                                  throws RFIDReaderException,
                                                         CommConnectionException
        looks for all new tags in range of the reader (used single slot) and get the Tag IDs of all tags as a number of strings back
        Returns:
        List with the Tag IDs of founded tags
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • getTagData

        public String getTagData​(int blockNumber,
                                 String tagID)
                          throws CommConnectionException,
                                 RFIDReaderException
        get the data from the Tag with tagID which is stored in the block number
        Parameters:
        blockNumber - block number
        tagID - tag ID (optional, if null the available tag is used)
        Returns:
        returns the data which is stored in the block number
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detect
        • CER, CRC error
        • TEC, Tag Error code
        • WPA, wrong Block number
        • TNR, Tag not responding
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagQuiet

        public void setTagQuiet​(String tagID)
                         throws CommConnectionException,
                                RFIDReaderException
        Sends stay quiet command to the tag.
        Parameters:
        tagID - tag ID (required)
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detect
        • CER, CRC error
        • TEC, Tag Error code
        • WPA, wrong Block number
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • getTagData

        public String getTagData​(int blockNumber)
                          throws RFIDReaderException,
                                 CommConnectionException
        get the data which is stored in the block number
        Parameters:
        blockNumber - block number
        Returns:
        returns the data which is stored in the block, null if tag is not responding
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detect
        • CER, CRC error
        • TEC, Tag Error code
        • WPA, wrong Block number
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • getTagData

        public String getTagData​(int firstBlock,
                                 int numberOfFollowingBlocks,
                                 String tagID)
                          throws RFIDReaderException,
                                 CommConnectionException
        gets the data which is stored in the tag, get the data from firstblock and the following blocks. Returns the data of readable blocks. If "following blocks" is bigger than the available blocks, only the available blocks are returned. If the tag after reading the data is not available (TNR 5 times) the reading data will be return.
        Parameters:
        firstBlock - first block to read
        numberOfFollowingBlocks - number of following block
        tagID - tag ID (optional, if null the available tag is used)
        Returns:
        returns the data which is stored in the blocks
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detect
        • CER, CRC error
        • TEC, Tag Error code
        • WPA, wrong Block number
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagData

        public void setTagData​(int blockNumber,
                               String data)
                        throws RFIDReaderException,
                               CommConnectionException
        Writes Data to the tag
        Parameters:
        blockNumber - blocknumber
        data - 4Byte data as Hex (8 signs)
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • WPA, Wrong Block number or wrong data length
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagData

        public void setTagData​(int blockNumber,
                               String data,
                               boolean optionFlag)
                        throws RFIDReaderException,
                               CommConnectionException
        Writes Data to the tag
        Parameters:
        blockNumber - blocknumber
        data - 4Byte data as Hex (8 signs)
        optionFlag - Meaning is defined by the tag command description.
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • WPA, Wrong Block number or wrong data length
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagData

        public void setTagData​(int blockNumber,
                               String data,
                               String tagID,
                               boolean optionFlag)
                        throws RFIDReaderException,
                               CommConnectionException
        Writes Data to the specified Tag
        Parameters:
        blockNumber - blocknumber
        data - 4Byte data as Hex (8 signs)
        tagID - tag id (addressed mode)
        optionFlag - Meaning is defined by the tag command description.
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • WPA, Wrong Block number or wrong data length
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagData

        public void setTagData​(int blockNumber,
                               String data,
                               String tagID)
                        throws RFIDReaderException,
                               CommConnectionException
        Writes Data to the specified Tag
        Parameters:
        blockNumber - blocknumber
        data - 4Byte data as Hex (8 signs)
        tagID - tag id (addressed mode)
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • WPA, Wrong Block number or wrong data length
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setUseAFI

        public void setUseAFI​(int afi)
                       throws RFIDReaderException
        Sets the afi byte to use
        Parameters:
        afi - afi byte (0..16)
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • WPA, wrong parameter
      • getUseAFI

        public int getUseAFI()
        Gets the used afi byte
        Returns:
        used afi byte
      • getMODE

        public ISOReader.MODE getMODE()
        Gets the current used mode
        Returns:
        MODE mode
      • getSRI

        public ISOReader.SRI getSRI()
        Gets the used modulation depth and subcarrier mode
        Returns:
        SRI sri
      • setTagAFI

        public void setTagAFI​(String tagID,
                              int afi)
                       throws RFIDReaderException,
                              CommConnectionException
        Sets the AFI value of the specified tag
        Parameters:
        tagID - tag id
        afi - afi value
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • lockTagAFI

        public void lockTagAFI​(String tagID)
                        throws RFIDReaderException,
                               CommConnectionException
        Locks the AFI value of the specified tag
        Parameters:
        tagID - tag id
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setTagDSFID

        public void setTagDSFID​(String tagID,
                                int dsfid)
                         throws RFIDReaderException,
                                CommConnectionException
        Sets the DSFID (data storage format identifier) value of the specified tag
        Parameters:
        tagID - tag id
        dsfid - DSFID value
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • lockTagDSFID

        public void lockTagDSFID​(String tagID)
                          throws RFIDReaderException,
                                 CommConnectionException
        Locks the DSFID (data storage format identifier) of the specified tag
        Parameters:
        tagID - tag id
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - possible ICommConnection Error codes:
        • NOT_INITIALISE
        • CONNECTION_LOST
        • RECV_TIMEOUT
        • UNHANDLED_ERROR
      • setPower

        public void setPower​(int value)
                      throws CommConnectionException,
                             RFIDReaderException
        The reader allows different output power levels to match antenna size, tag size or tag po- sition. The power level is given in milliwatt (mW). The minimum value is 500, the maximum is 4000 with steps of 250. The second generation ISO 15693 devices with hardware revision >= 02.00 (DeskID ISO, UM15, Dwarf15, QR15 and QuasarMX) allow setting power values of 100 or 200 (mW).
        Parameters:
        value - power in mW from 500mW to 4000mW in 250mW steps
        Throws:
        CommConnectionException - if an communication exception occurs
        RFIDReaderException - if an protocol exception occurs (e.g. CRC error, value out of range, ..)