Package com.tccc.kos.ext.freestyle.hardware.rfid

Class RfidAntenna

java.lang.Object
com.tccc.kos.ext.freestyle.hardware.rfid.RfidAntenna
All Implemented Interfaces:
com.tccc.kos.commons.core.service.config.ConfigAware<RfidAntennaConfig>, com.tccc.kos.commons.core.service.handle.HandleAware
public class RfidAntenna extends Object implements com.tccc.kos.commons.core.service.config.ConfigAware<RfidAntennaConfig>
This is a single logical antenna which can be scanned. It specifies details such as the physical antenna number, position mappings, timeouts and so on.
Version:
2023-09-14

  • Constructor Summary

    Constructors
    Constructor
    Description
    RfidAntenna(String name, int antennaNum)
    Create a new antenna for the scanner.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAntennaNum()
     
    RfidBoard
    getBoard()
     
    RfidAntennaConfig
    getConfig()
     
    com.tccc.kos.commons.core.service.handle.Handle
    getHandle()
     
    int[]
    getMaxTags()
     
    int
    getMaxTags(int pos)
    Return the max number of tags to expect at a given logical position.
    int
    getReadCount()
    Return the number of reads that have been performed on this antenna.
    boolean
    isWriteEnabled()
     
    void
    mapPosition(int logical, int physical)
    Map a logical position on the antenna to a physical position.
    void
    resetReadCount()
    Reset the read count for this antenna.
    void
    setConfig(RfidAntennaConfig config)
     
    void
    setMaxTags(int pos, int maxTags)
    Set the max number of tags to read for a given logical position.
    void
    setWriteEnabled(boolean enable)
    Enable / disable writes from the antenna.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.tccc.kos.commons.core.service.config.ConfigAware

    onConfigChanged, onConfigSet

    Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

    addHandleChild, getName, getPath

  • Constructor Details

    • RfidAntenna

      public RfidAntenna(String name, int antennaNum)
      Create a new antenna for the scanner.
      Parameters:
      name - antenna name
      antennaNum - the antenna number

  • Method Details

    • mapPosition

      public void mapPosition(int logical, int physical)
      Map a logical position on the antenna to a physical position. By default logical and physical positions are the same, but the mappings can be changed so that logical positions can match higher level mappings, such as slots in a shelf, even when the physical mappings are not naturally ordered in a convenient way.
      Parameters:
      logical - the logical position
      physical - the physical position

    • setWriteEnabled

      public void setWriteEnabled(boolean enable)
      Enable / disable writes from the antenna. This can be used to block all writes which can be useful during testing to avoid changing tags.

    • setMaxTags

      public void setMaxTags(int pos, int maxTags)
      Set the max number of tags to read for a given logical position. This allows the reader to stop reading tags once the max has been reached which greatly speeds up reading. By default, the max number of tags per position is 1, but this can be used to change the value in the event that the antenna is not positional or a given position expects to see more than one tag.
      Parameters:
      pos - the logical antenna position
      maxTags - the max number of tags to read

    • getMaxTags

      public int getMaxTags(int pos)
      Return the max number of tags to expect at a given logical position.
      Parameters:
      pos - the logical position on the antenna

    • getReadCount

      public int getReadCount()
      Return the number of reads that have been performed on this antenna.

    • resetReadCount

      public void resetReadCount()
      Reset the read count for this antenna.

    • getHandle

      public com.tccc.kos.commons.core.service.handle.Handle getHandle()
      Specified by:
      getHandle in interface com.tccc.kos.commons.core.service.handle.HandleAware

    • getBoard

      public RfidBoard getBoard()

    • getAntennaNum

      public int getAntennaNum()

    • getMaxTags

      public int[] getMaxTags()

    • isWriteEnabled

      public boolean isWriteEnabled()

    • getConfig

      public RfidAntennaConfig getConfig()
      Specified by:
      getConfig in interface com.tccc.kos.commons.core.service.config.ConfigAware<RfidAntennaConfig>

    • setConfig

      public void setConfig(RfidAntennaConfig config)
      Specified by:
      setConfig in interface com.tccc.kos.commons.core.service.config.ConfigAware<RfidAntennaConfig>