Class ISOReader

    • Constructor Detail

      • ISOReader

        @Deprecated
        public ISOReader​(java.lang.String identifier,
                         java.lang.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​(java.lang.String identifier,
                         java.lang.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​(java.lang.String identifier,
                         java.lang.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 java.util.List<HfTag> 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 java.util.List<HfTag> 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 java.util.List<HfTag> 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
      • sendReadingRequest

        public java.lang.String sendReadingRequest​(java.lang.String tagCommand)
                                            throws CommConnectionException,
                                                   RFIDReaderException
        Send a reading request to tags (REQ). With this method you can send manufacturer specific commands.
        Parameters:
        tagCommand - the command defined in the ISO 15693-3. For example '022000' to read the block 0 of a tag
        Returns:
        the read data
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TNR, Tag not responding
        • RDL, Data length error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - if an communication error occurs
      • sendDirectReadingRequest

        public java.lang.String sendDirectReadingRequest​(java.lang.String tagCommand)
                                                  throws CommConnectionException,
                                                         RFIDReaderException
        Send a reading request directly to tags (DRQ). With this method you can send manufacturer specific commands.
        Parameters:
        tagCommand - the command defined in the ISO 15693-3. For example '022000' to read the block 0 of a tag
        Returns:
        the read data
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TNR, Tag not responding
        • RDL, Data length error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - if an communication error occurs
      • sendWritingRequest

        public void sendWritingRequest​(java.lang.String tagCommand)
                                throws CommConnectionException,
                                       RFIDReaderException
        Send a writing request to tags (WRQ). Use this if the data on the tag is to be changed/written. With this method you can send manufacturer specific commands.
        Parameters:
        tagCommand - the command defined in the ISO 15693-3. For example '022100A000B000' to write 'A000B000' to the block 0 of a tag
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TNR, Tag not responding
        • RDL, Data length error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - if an communication error occurs
      • sendDirectWritingRequest

        public void sendDirectWritingRequest​(java.lang.String tagCommand)
                                      throws CommConnectionException,
                                             RFIDReaderException
        Send a writing request directly to tags (DWQ). Use this if the data on the tag is to be changed/written. With this method you can send manufacturer specific commands.
        Parameters:
        tagCommand - the command defined in the ISO 15693-3. For example '022100A000B000' to write 'A000B000' to the block 0 of a tag
        Throws:
        RFIDReaderException - possible RFIDErrorCodes:
        • CCE, CRC communication error
        • CLD, Collision detected
        • CER, CRC error
        • TNR, Tag not responding
        • RDL, Data length error
        • TEC, Tag Error code
        • NER, No expected response
        CommConnectionException - if an communication error occurs
      • getTagData

        public HfTag getTagData​(int blockNumber,
                                java.lang.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​(java.lang.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 HfTag 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 HfTag getTagData​(int firstBlock,
                                int numberOfFollowingBlocks,
                                java.lang.String tagID)
                         throws RFIDReaderException,
                                CommConnectionException
        gets the data which is stored in the tag, get the data from first block 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 HfTag setTagData​(int blockNumber,
                                java.lang.String data)
                         throws RFIDReaderException,
                                CommConnectionException
        Writes Data to the tag
        Parameters:
        blockNumber - blocknumber
        data - 4Byte data as Hex (8 signs)
        Returns:
        the HfTag
        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 HfTag setTagData​(int blockNumber,
                                java.lang.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.
        Returns:
        the HfTag
        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 HfTag setTagData​(int blockNumber,
                                java.lang.String data,
                                java.lang.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.
        Returns:
        the HfTag
        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 HfTag setTagData​(int blockNumber,
                                java.lang.String data,
                                java.lang.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)
        Returns:
        the HfTag
        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
      • getTagSystemInformation

        public HFTagInformation getTagSystemInformation​(java.lang.String tagID)
                                                 throws RFIDReaderException,
                                                        CommConnectionException
        Gets the tag system information
        Parameters:
        tagID - tag id
        Returns:
        HFTagInformation
        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
      • setTagAFI

        public void setTagAFI​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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 position. 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).
        Specified by:
        setPower in class MetratecReaderGen1<HfTag>
        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, ..)
      • setMultiplexAntennas

        public void setMultiplexAntennas​(int numberOfAntennas)
                                  throws CommConnectionException,
                                         RFIDReaderException
        In case you want to automatically switch between multiple antennas (e.g. trying to find all tags in a search area that can only be searched using multiple antennas) you can use this automatic switching mode.
        Switching always starts with the lowest antenna port (0). Switching to the next antenna port oc- curs automatically with the start of every tag manipulation command. No pin state is changed until the first tag manipulation command.
        Specified by:
        setMultiplexAntennas in class MetratecReader<HfTag>
        Parameters:
        numberOfAntennas - number of antennas [1,16], 0 for disable; Please note that for this parameter the number given is the counted number of participating antennas, not the antenna port numbers, thus stating a number "X" would stand for "X antennas participating".
        Throws:
        CommConnectionException - if an communication exception occurs
        RFIDReaderException - if an protocol exception occurs (e.g. CRC error, value out of range, ..)