Package jmri.jmrix.loconet.locoio

Class LocoIOData

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.jmrix.loconet.locoio.LocoIOData
All Implemented Interfaces:
PropertyChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, LocoNetListener
public class LocoIOData extends PropertyChangeSupport implements LocoNetListener, PropertyChangeListener
Data associated with a LocoIO device.

  • Field Details

  • Constructor Details

    • LocoIOData

      public LocoIOData(int unitAddr, int unitSubAddr, LnTrafficController tc)
      Create a new instance of LocoIOData.
      Parameters:
      unitAddr - unit address.
      unitSubAddr - unit SubAddress.
      tc - system connection traffic controller.

  • Method Details

    • propertyChange

      public void propertyChange(PropertyChangeEvent evt)
      Specified by:
      propertyChange in interface PropertyChangeListener

    • setUnitAddress

      public void setUnitAddress(int unit, int unitSub)
      Address and SubAddress of this device.

      High byte of the Address is fixed to 0x01
      Low byte Address must be in the range of 0x01 .. 0x4F, 0x51 .. 0x7F
      (0x50 is reserved for the LocoBuffer)
      The subAddress is in the range of 0x01 .. 0x7E
      (0x7F is reserved)

      Parameters:
      unit - unit address.
      unitSub - unit subAddress.

    • setUnitAddress

      public void setUnitAddress(int unit)

    • setUnitSubAddress

      public void setUnitSubAddress(int unitSub)

    • getUnitAddress

      public int getUnitAddress()

    • getUnitSubAddress

      public int getUnitSubAddress()

    • setUnitConfig

      public void setUnitConfig(int portRefresh, int altCodePBs, int isServo, int blinkRate)
      No LocoIO Board level configuration. 
       Bit 0: 0 = default, 1 = Port Refresh
 Bit 1: 0 = Fixed code PBs, 1 = Alternated code PBs
 Bit 2: 0 = default - Not used
 Bit 3: 0 = default, 1 = Ports 5-12 are Servo Ports
 Bit 4-7: Blink Rate

 Add/support the additional config options for HDL boards -
 Work has moved to xml decoder definition Public_Domain_HDL_LocoIO, is included there since 4.21.2
      Parameters:
      portRefresh - port refresh value, bit 0.
      altCodePBs - alternated code PBs, bit 1.
      isServo - servo port, bit 3.
      blinkRate - blink rate, bits 4-7.

    • getUnitConfig

      public int getUnitConfig()

    • setLBVersion

      public void setLBVersion(String version)

    • getLBVersion

      public String getLBVersion()

    • setLIOVersion

      public void setLIOVersion(String version)

    • getLIOVersion

      public String getLIOVersion()

    • setStatus

      public void setStatus(String msg)

    • getStatus

      public String getStatus()

    • setSV

      public void setSV(int channel, int value)

    • getSV

      public int getSV(int channel)

    • setV1

      public void setV1(int channel, LocoIOMode l, int address)

    • setV1

      public void setV1(int channel, int value)

    • getV1

      public int getV1(int channel)

    • setV2

      public void setV2(int channel, LocoIOMode l, int address)

    • setV2

      public void setV2(int channel, int value)

    • getV2

      public int getV2(int channel)

    • setAddr

      public void setAddr(int channel, int value)
      Set new value in addr field (for the address info used in each LocoIO channel).
      Parameters:
      channel - integer value of the addresses in use for this row (0 = invalid)
      value - channel value.

    • getAddr

      public int getAddr(int channel)

    • setMode

      public void setMode(int channel, String m)

    • getMode

      public String getMode(int channel)

    • setLIM

      public void setLIM(int channel, String s)

    • setLIM

      public void setLIM(int channel)

    • setLIM

      public void setLIM(int channel, LocoIOMode m)

    • getLIM

      public LocoIOMode getLIM(int channel)

    • readValues

      public void readValues(int channel)

    • captureValues

      public void captureValues(int channel)

    • writeValues

      public void writeValues(int channel)

    • readAll

      public void readAll()
      Start reading all rows back.

    • writeAll

      public void writeAll()
      Start writing all rows out.

    • getLocoIOModeList

      public LocoIOModeList getLocoIOModeList()

    • highPart

      protected int highPart(int value)

    • lowPart

      protected int lowPart(int value)

    • message

      public void message(LocoNetMessage m)
      Listen to the LocoNet. We're listening for incoming OPC_PEER_XFR messages, which might be part of a read or write sequence. We're also _sometimes_ listening for commands as part of a "capture" operation.

      The incoming LocoNet OPC_PEER_XFR messages don't retain any information about the CV number or whether it was a read or write operation. We store the data regardless of whether it was read or write, but we need to remember the cv number in the lastOpCv member.

      Specified by:
      message in interface LocoNetListener
      Parameters:
      m - Incoming message

    • replyReceived

      protected void replyReceived()
      A valid reply has been received, so the read/write worked, and the state should be advanced.

    • issueNextOperation

      protected void issueNextOperation()
      Look through the table to find the next thing that needs to be read.

    • timeout

      protected void timeout()
      Internal routine to handle a timeout during read/write by retrying the same operation.

    • startTimer

      protected void startTimer()
      Internal routine to start timer to protect the mode-change.

    • stopTimer

      protected void stopTimer()
      Internal routine to stop timer, as all is well.

    • restartTimer

      protected void restartTimer(int delay)
      Internal routine to handle timer starts and restarts.
      Parameters:
      delay - Milliseconds to wait

    • sendReadCommand

      void sendReadCommand(int locoIOAddress, int locoIOSubAddress, int cv)
      Read an SV from a given LocoIO device.
      Parameters:
      locoIOAddress - primary board address
      locoIOSubAddress - subaddress within board
      cv - CV number to access

    • sendWriteCommand

      void sendWriteCommand(int locoIOAddress, int locoIOSubAddress, int cv, int data)
      Write an SV to a given LocoIO device.
      Parameters:
      locoIOAddress - primary board address
      locoIOSubAddress - subaddress within board
      cv - CV number to access
      data - value to be written

    • dispose

      public void dispose()