Train modified by Mike Johnson

Mike Johnson — Thu, 22 May 2014 09:52:38 -0000

Loco and Consist Train Control Commands

21 Release Engine(KLOC)

Format: [<MjPri?><MinPri?=2><CANID>]<21><Session>

<Dat1> is the engine session number.

The command station decrements the reference counter for the engine record. If the reference count is 0, the command station removes the engine from the engine list.

22 Query engine (QLOC)

Format: <22><Session>

<Dat1> is the engine session number.

The command station responds with PLOC if the NN is assigned. Otherwise responds with ERR: engine not found.

23 Keep Alive (KEEP)

Format: <24><Session>

<Dat1> is the engine session number.

Sent by a cab to notify it is active. If a cab does not send this message within the life time-out period, it is removed from the refresh list.

Probably not needed. Deleted in Ver 6.

40 Request engine assignment(RLOC)

Format: <40><AAAAAAAA><AAAAAAAA>

<Dat1> and <Dat2> are [AddrH] and [AddrL] of the decoder, respectively. 7 bit addresses have (AddrH=0). 14 bit addresses have bits 7,8 of AddrH set to 0.

The command station responds with (PLOC) if engine is free and is being assigned. Otherwise responds with (ERR): engine in use. This command is typically sent by a cab to the command station following a change of the controlled decoder address.

41 Query Consist (QCON)

Format: <41><ConID><Index>

<Dat1> is consist address.
<Dat2> is engine index in the consist.

Allows enumeration of a consist. Command station responds with PLOC if an engine exists at the specified index, otherwise responds with ERR: no more engines.

44 Set Throttle session mode (STMOD)

Format: <44><Session><MMMMMMMM>

<Dat1> Session number
<Dat2> contains mode bits:
- Bits 0 - 1: speed mode
- 00 - 128 speed steps
- 01 - 14 speed steps
- 10 - 28 speed steps with interleave steps ?
- 11 - 28 speed steps
- Bits 2 - 7: spare

Sent from a cab to the command station to change the number of speed steps used, to that supported by the decoder. The command station should remember the setting and send it in PLOC replies for this decoder.

45 Consist Engine (PCON)

Format: <45><Session><Consist#>

<Dat1> Session number
<Dat2> is consist address (8 bits).

Adds a decoder to a consist. If consisting is successful, an ACK is sent. If engine is consisted already, an error is reported: engine in use.

46 Remove Engine from consist (KCON)

Format: <46><Session><Consist#>

<Dat1> Session number
<Dat2> is consist address.

Removes a decoder from a consist. If deconsisting is successful an ACK is sent. If engine is not consisted, an error is reported: Engine not found.

47 Set Engine Speed/Dir(DSPD)

Format: <47><Session><Speed/Dir>

<Dat1> Session number
<Dat2> is speed/dir value

Sent by a device to request an engine speed/dir change. The speed is in the DCC format for the number of speed steps. For 128 steps, bit 7 is the direction, 1 for forward. The other 7 bits are the speed, 0 is stop, 1 is emergency stop. For 14 or 28 steps, bit 6 is 1, bit 5 is the direction, bit 4 is the lsb of the 28 step speed, the other 4 bits are the speed, with 0 is stop and 1 is emergency stop.

48 Set Engine Flags (DFLG)

Format: <48><Session><DDDDDDDD>

<Dat1> Session number
<Dat2> is the flags
bits 0-1: Speed Mode
- 00 - 128 speed steps
- 01 - 14 speed steps
- 10 - 28 speed steps with interleave steps
- 11 - 28 speed steps
Bit 2: Lights On/OFF ?
Bit 3: Engine relative direction ?
Bits 4-5: Engine state
- 00 - active ?
- 01 - consisted
- 10 - consist master
- 11 - inactive ?
Bits 6-7: Reserved.

Sent by a cab to notify the command station of a change in engine flags. Probably not needed see opcodes 44 and E1.

49 DCC Event mapping commands (DCCE)

Format: <49><MMMMAAAA><AAAAAAAA>

<Dat1> Address and event.
- Bits 0-3: DCC Accessory Output Address MSB
- Bits 4-7: Event Operations
- 0000 Enter Learn Mode
- 0001 Unlearn events
- 0010 - 1111 reserved
<Dat2> DCC Accessory Output Address LSB

Sent by a cab to initiate an event - DCC accessory mapping action. Possible actions are to learn a new mapping (the command station enters learn mode and captures the next CBUS event to create a mapping) and unlearn a mapping.

60 Set Engine functions (DFUN)

Format: <60><Session><Dat1><Dat2>

<Session> is the engine session number.
<Dat1> is 1 for FN0-FN5, 2 is FN5-FN8, 3 is FN9-FN12, 4 is FN13-FN20 and 5 is FN21-FN28.
<Dat2> is 5, 4 or 8 bits one per function in DCC order. eg. FN0 is in bit 4.

Sent by a device to request an engine Fn state change.

E1 Engine report (PLOC)

There are 2 formats for this:

Format1: <E1><Session><AddrH><AddrL><Speed/Dir> | Consist#><Fn1><Fn2><Fn3>

Session for engine assigned by the command station. This session number is used in all referenced to the engine until it is released.

AddrH and AddrL is the DCC address. For short addresses AddrH it is set to 0. If the engine is consisted, AddrL is the consist address.

Speed/Direction value. Bit 7 is the direction bit and bits 0-6 are the speed value.

<Fn1> is the function byte F0 to F4 <Fn2> is the function byte F5 to F8 <Fn3> is the function byte F9 to F12

Format2: <E1><Session><AddrH><AddrL><Flags><Speed/Dir | Consist#><B1><B2>

<Dat1> Session for engine assigned by the command station. This session number is used in all references to the engine until it is released.
<Dat2> is the MS byte of the DCC address. For short addresses it is set to 0.
<Dat3> is the LS byte of the DCC address.
<Dat4> is the Flags byte.
- bits 0-1: Speed Mode
- 00 - 128 speed steps
- 01 - 14 speed steps
- 10 - 28 speed steps with interleave steps
- 11 - 28 speed steps
- Bit 2: spare
- Bit 3: spare
- Bit 4: Consisted
- Bit 5: Consist Master
- Bit 6: spare
- Bit 7: In use.
<Dat5> is the Speed/Direction value. Bit 7 is the direction bit and bits 0-6 are the speed value. If the engine is consisted, this is the consist address.
<Dat6> spare.
<Dat7> spare.

Due to the number of functions, these states are in the opcode E8 PLOCF packet, which may be before or after the PLOC packet.

A report of an engine entry sent by the command station. Usually sent in response to QLOC or as an acknowledgement of acquiring an engine requested by a cab (RLOC).

E8 Engine function report (PLOCF)

Format: <E8><Session><AddrH><AddrL><FN0><FN5><FN13><FN21>

<Dat1> Session for engine assigned by the command station. This session number is used in all references to the engine until it is released.
<Dat2> is the MS byte of the DCC address. For short addresses it is set to 0.
<Dat3> is the LS byte of the DCC address.
<Dat4> is the 5 functions FN0 to FN4 in DCC bit order. See opcode 60 DFUN.
<Dat5> is the 8 functions FN5 to FN12.
<Dat6> is the 8 functions FN13 to FN20.
<Dat7> is the 8 functions FN21 to FN28.

The PLOCF may appear before or after the PLOC, and is usually a reply to a QLOC or RLOC request.

Recent changes to Train

Train modified by Mike Johnson

Loco and Consist Train Control Commands

21 Release Engine(KLOC)

22 Query engine (QLOC)

23 Keep Alive (KEEP)

40 Request engine assignment(RLOC)

41 Query Consist (QCON)

44 Set Throttle session mode (STMOD)

45 Consist Engine (PCON)

46 Remove Engine from consist (KCON)

47 Set Engine Speed/Dir(DSPD)

48 Set Engine Flags (DFLG)

49 DCC Event mapping commands (DCCE)

60 Set Engine functions (DFUN)

E1 Engine report (PLOC)

E8 Engine function report (PLOCF)