Package jmri.jmrix.loconet.locoio

Class LocoIO

java.lang.Object

jmri.jmrix.loconet.locoio.LocoIO

public class LocoIO
extends Object

Manage the communication to/from a LocoIO board. Deprecated since version 5.12. Will be removed 2025 version 5.13

Uses the LOCONETSV1MODE programming mode.

Uses LnProgrammer LOCOIO_PEER_CODE_SV_VER1 message format, comparable to DecoderPro LOCONETSV1MODE Since JMRI 4.11.6 the LocoIO tool does not work with the HDL LocoIO rev 3 and newer boards, with risk of breaking the stored config. Use the DecoderPro decoder definition.

See Also:

• Programming SV's

  The SV's in a LocoIO hardware module can be programmed using LocoNet OPC_PEER_XFER messages.

  Commands for setting SV's:

  PC to LocoIO LocoNet message (OPC_PEER_XFER)

  
   Code LOCOIO_SV_READ _or_ LOCOIO_SV_WRITE ----
   0xE5 OPC_PEER_XFER
   0x10 Message length
   SRCL 0x50            0x50 // low address byte of LocoBuffer
   DSTL LocoIO low address
   DSTH 0x01 0x01 // Fixed LocoIO high address
   PXCT1
   D1 LOCOIO_SV_READ _or_ LOCOIO_SV_WRITE // Read/Write command
   D2 SV number         SV number
   D3 0x00              0x00
   D4 0x00              Data to Write
   PXCT2
   D5 LocoIO Sub-address
   D6 0x00              0x00
   D7 0x00              0x00
   D8 0x00              0x00
   CHK Checksum         Checksum
   

  LocoIO to PC reply message (OPC_PEER_XFER)

  
   Code LOCOIO_SV_READ _or_ LOCOIO_SV_WRITE ----
   0xE5 OPC_PEER_XFER
   0x10 Message length
   SRCL LocoIO low address
   DSTL 0x50                0x50 // low address byte of LocoBuffer
   DSTH 0x01                0x01 // high address byte of LocoBuffer
   PXCT1 MSB LocoIO version // High order bit of LocoIO version
   D1 LOCOIO_SV_READ _or_   LOCOIO_SV_WRITE // Original Command
   D2 SV number requested
   D3 LSBs LocoIO version // Lower 7 bits of LocoIO version
   D4 0x00                  0x00
   PXCT2 MSB Requested Data // High order bit of requested data
   D5 LocoIO Sub-address
   D6 Requested Data        0x00
   D7 Requested Data + 1    0x00
   D8 Requested Data + 2    Written Data
   CHK Checksum             Checksum
   

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LOCOIO_BROADCAST_ADDRESS
static final int	LOCOIO_PEER_CODE_7BIT_ADDRS
static final int	LOCOIO_PEER_CODE_ANSI_TEXT
static final int	LOCOIO_PEER_CODE_SV_VER1
static final int	LOCOIO_PEER_CODE_SV_VER2
static final int	LOCOIO_SV_READ
static final int	LOCOIO_SV_WRITE

Constructor Summary

Constructors

Constructor	Description
LocoIO()	Create a new instance of LocoIO.

Method Summary

Modifier and Type	Method	Description
static void	probeLocoIOs(LnTrafficController ln)	Send out a probe of all connected LocoIO units on a given LocoNet connection.
static void	programLocoIOAddress(int address, int subAddress, LnTrafficController ln)	Compose and send a message out onto LocoNet changing the LocoIO hardware board address of all connected LocoIO boards.
static LocoNetMessage	readSV(int locoIOAddress, int locoIOSubAddress, int sv)	Compose a LocoNet message from the given ingredients for reading the value of one specific SV from a given LocoIO.
static int	SENSOR_ADR(int a1, int a2)
static LocoNetMessage	writeSV(int locoIOAddress, int locoIOSubAddress, int sv, int data)	Compose a LocoNet message from the given ingredients for reading the value of one specific SV from a given LocoIO.

Methods inherited from class java.lang.Object

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

Field Details

LOCOIO_SV_WRITE

public static final int LOCOIO_SV_WRITE

See Also:

• Constant Field Values

LOCOIO_SV_READ

public static final int LOCOIO_SV_READ

See Also:

• Constant Field Values

LOCOIO_BROADCAST_ADDRESS

public static final int LOCOIO_BROADCAST_ADDRESS

See Also:

• Constant Field Values

LOCOIO_PEER_CODE_7BIT_ADDRS

public static final int LOCOIO_PEER_CODE_7BIT_ADDRS

See Also:

• Constant Field Values

LOCOIO_PEER_CODE_ANSI_TEXT

public static final int LOCOIO_PEER_CODE_ANSI_TEXT

See Also:

• Constant Field Values

LOCOIO_PEER_CODE_SV_VER1

public static final int LOCOIO_PEER_CODE_SV_VER1

See Also:

• Constant Field Values

LOCOIO_PEER_CODE_SV_VER2

public static final int LOCOIO_PEER_CODE_SV_VER2

See Also:

• Constant Field Values

Constructor Details

LocoIO

public LocoIO()

Create a new instance of LocoIO.

Method Details

SENSOR_ADR

public static int SENSOR_ADR(int a1,
 int a2)

readSV

public static LocoNetMessage readSV(int locoIOAddress,
 int locoIOSubAddress,
 int sv)

Compose a LocoNet message from the given ingredients for reading the value of one specific SV from a given LocoIO.

Parameters:

locoIOAddress - base address of the LocoIO board to read from

locoIOSubAddress - subAddress of the LocoIO board

sv - the SV index to query

Returns:

complete message to send

writeSV

public static LocoNetMessage writeSV(int locoIOAddress,
 int locoIOSubAddress,
 int sv,
 int data)

Compose a LocoNet message from the given ingredients for reading the value of one specific SV from a given LocoIO.

Parameters:

locoIOAddress - base address of the LocoIO board to read from

locoIOSubAddress - subAddress of the LocoIO board

sv - the SV index to change

data - the new value to store in the board's SV

Returns:

complete message to send

programLocoIOAddress

public static void programLocoIOAddress(int address,
 int subAddress,
 LnTrafficController ln)

Compose and send a message out onto LocoNet changing the LocoIO hardware board address of all connected LocoIO boards.

User is warned that this is a broadcast type operation.

Parameters:

address - the new base address of the LocoIO board to change

subAddress - the new subAddress of the board

ln - the TrafficController to use for sending the message

probeLocoIOs

public static void probeLocoIOs(LnTrafficController ln)

Send out a probe of all connected LocoIO units on a given LocoNet connection.

Parameters:

ln - the TrafficController to use for sending the message