Package jmri.jmrix.marklin

Class MarklinMessage

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRMessage

jmri.jmrix.marklin.MarklinMessage

All Implemented Interfaces:

Message

public class MarklinMessage
extends AbstractMRMessage

Encodes a message to a Marklin command station.

The MarklinReply class handles the response from the command station. Packages of length 13 are interpreted as can-bus packages: 4 bytes Can-bus-ID (BigEndian or network order), 1-byte length and 8 bytes of data, if necessary with null bytes to fill in.

The message ID is divided into the areas of lower priority (priority), command (command), response and hash. The communication is based on the following format: Prio - 2 +2bit Command 8 bit Resp - 1 bit Hash - 16bit DLC - 4bit (ie CAN message length) CAN message 8 BYTES Can Message Bytes 0 to 3 are the address bytes, with byte 0 High, byte 3 low

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static int	MY_UID

Fields inherited from class jmri.jmrix.AbstractMRMessage

LONG_TIMEOUT, SHORT_TIMEOUT, sourceLetter

Fields inherited from class jmri.jmrix.AbstractMessage

_dataChars, _nDataChars

Constructor Summary

Constructors

Constructor	Description
MarklinMessage()
MarklinMessage(byte[] d)
MarklinMessage(int i)
MarklinMessage(int[] d)
MarklinMessage(MarklinMessage m)

Method Summary

Modifier and Type	Method	Description
long	getAddress()
static MarklinMessage	getCanBoot()	Generate CAN BOOT command (0x1B) for Gleisbox activation.
static MarklinMessage	getCanBootloaderMode()	Generate CAN BOOT command (0x1B) for entering bootloader mode.
static MarklinMessage	getEnableMain()
static MarklinMessage	getExitProgMode()
static MarklinMessage	getKillMain()
static MarklinMessage	getProgMode()
static MarklinMessage	getQryLocoDirection(int addr)
static MarklinMessage	getQryLocoFunction(int addr, int funct)
static MarklinMessage	getQryLocoSpeed(int addr)
static MarklinMessage	getReadDirectCV(int cv)
static MarklinMessage	getReadPagedCV(int cv)
static MarklinMessage	getReadRegister(int reg)
static MarklinMessage	getSetTurnout(int addr, int state, int power)
static MarklinMessage	getWriteDirectCV(int cv, int val)
static MarklinMessage	getWritePagedCV(int cv, int val)
static MarklinMessage	getWriteRegister(int reg, int val)
static MarklinMessage	sensorPollMessage(int module)
static MarklinMessage	setLocoDirection(int addr, int dir)
static MarklinMessage	setLocoEmergencyStop(int addr)
static MarklinMessage	setLocoFunction(int addr, int funct, int state)
static MarklinMessage	setLocoSpeed(int addr, int speed)
static MarklinMessage	setLocoSpeedSteps(int addr, int step)

Methods inherited from class jmri.jmrix.AbstractMRMessage

addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getSourceLetter, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setOpCode, setRetries, setTimeout, toString

Methods inherited from class jmri.jmrix.AbstractMessage

equals, getElement, getNumDataElements, hashCode, setElement

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.jmrix.Message

toMonitorString

Field Details

MY_UID

static int MY_UID

Constructor Details

MarklinMessage

MarklinMessage()

MarklinMessage

public MarklinMessage(int[] d)

MarklinMessage

public MarklinMessage(byte[] d)

MarklinMessage

public MarklinMessage(int i)

MarklinMessage

public MarklinMessage(MarklinMessage m)

Method Details

getEnableMain

public static MarklinMessage getEnableMain()

getKillMain

public static MarklinMessage getKillMain()

getCanBoot

public static MarklinMessage getCanBoot()

Generate CAN BOOT command (0x1B) for Gleisbox activation.

This command resets the Gleisbox/trackbox and initiates it to start passing commands to locos and accessories on the rails. Without this command on startup, the hardware does not respond to subsequent commands. This variant is used for normal operational startup of standalone Gleisbox devices when no CS2/MS2 is attached.

The packet uses DLC=5 with data byte 0 set to 0x11, which is the "magic value" that activates the Gleisbox for normal operations. This matches the behavior of Rocrail and the can2udp reference implementation (M_GLEISBOX_MAGIC_START_SEQUENCE).

Returns:

MarklinMessage containing the CAN BOOT activation command

See Also:

• can2udp reference implementation
• getCanBootloaderMode()

getCanBootloaderMode

public static MarklinMessage getCanBootloaderMode()

Generate CAN BOOT command (0x1B) for entering bootloader mode.

This variant of the CAN BOOT command invokes the bootloader update sequence on Märklin devices for firmware updates. It is sent after a system reset with approximately 400ms wait time, putting the device into bootloader mode ready to receive firmware data.

This command uses DLC=0 (no data bytes) and should be followed by firmware data transfer packets if performing an actual firmware update. This is different from getCanBoot() which activates the device for normal operations.

Note: This command is intended for firmware update operations. For normal Gleisbox activation to run trains, use getCanBoot() instead.

Returns:

MarklinMessage containing the CAN BOOT bootloader invocation command

See Also:

• Märklin CAN Protokoll 0x1B commands documentation
• getCanBoot()

getSetTurnout

public static MarklinMessage getSetTurnout(int addr,
 int state,
 int power)

getQryLocoSpeed

public static MarklinMessage getQryLocoSpeed(int addr)

setLocoSpeed

public static MarklinMessage setLocoSpeed(int addr,
 int speed)

setLocoEmergencyStop

public static MarklinMessage setLocoEmergencyStop(int addr)

setLocoSpeedSteps

public static MarklinMessage setLocoSpeedSteps(int addr,
 int step)

getQryLocoDirection

public static MarklinMessage getQryLocoDirection(int addr)

setLocoDirection

public static MarklinMessage setLocoDirection(int addr,
 int dir)

getQryLocoFunction

public static MarklinMessage getQryLocoFunction(int addr,
 int funct)

setLocoFunction

public static MarklinMessage setLocoFunction(int addr,
 int funct,
 int state)

sensorPollMessage

public static MarklinMessage sensorPollMessage(int module)

getAddress

public long getAddress()

getProgMode

public static MarklinMessage getProgMode()

getExitProgMode

public static MarklinMessage getExitProgMode()

getReadPagedCV

public static MarklinMessage getReadPagedCV(int cv)

getWritePagedCV

public static MarklinMessage getWritePagedCV(int cv,
 int val)

getReadRegister

public static MarklinMessage getReadRegister(int reg)

getWriteRegister

public static MarklinMessage getWriteRegister(int reg,
 int val)

getReadDirectCV

public static MarklinMessage getReadDirectCV(int cv)

getWriteDirectCV

public static MarklinMessage getWriteDirectCV(int cv,
 int val)