DCC-EX Consolidated Command Summary
- This is a summary, for a detailed command, see…
This page describes all the DCC-EX commands that the EX‑CommandStation supports.
Conventions used on this page
<
and>
- All DCC-EX commands are surrounded by these characters to indicate the beginning and end, these must always be includedFirst letter or number - These are called OPCODES, are case sensitive, and must be specified as directed, eg.
1
,c
, or-
CAPITALISED words - These are parameters referred to as keywords, and should be specified as directed, eg.
MAIN
(note these are not case sensitive, however capitalising makes them easier to distinguish from other parameters)lowercase words - These are parameters that must be provided or are returned, with multiple parameters separated by a space ” “, eg.
cab
Square brackets
[]
- Parameters within square brackets[]
are optional and may be ommitted, and if specifying these parameters, do not include the square brackets themselves| - Use of the | character means you need to provide one of the provided options only, for example
<0|1 MAIN|PROG|JOIN>
becomes either<0 MAIN>
or<1 MAIN>
0|1
DIRECTION: 1=forward, 0=reverse.
Commonly used Parameters (Arguments)
cab
- DCC Address. i.e. a Loco. (eg. 3-9999)speed
- 0-127dir
direction
- 1=forward 0=reversespeedByte
- 0=stopped 1-127=reverse 128-256=forwardfunct
function
- function number related to a specific DCC decoder/ loco (e.g. 0-27)functMap
functionMap
- individual bits of the returned number represent the state of the specific functionsslot
- redundant parameter. This needs to be included but is ignored by the EX-CommandStationreg
register
- redundant parameter. This needs to be included but is ignored by the EX-CommandStationdesc
description
-byte
-track
- ‘MAIN’=Main track ‘PROG’=Programming Track ‘JOIN’=Main and Programming tracks temporarily joined
Controlling the EX-CommandStation
Power management
Command |
Description / Response |
---|---|
|
Track Power |
|
Re-boot the command Station |
Cab (Loco) Commands
Command |
Description / Response |
---|---|
|
Set the speed and direction of a Cab (Loco) |
|
Requests a deliberate update on the cab speed/functions in the same format as the cab (loco) broadcast. |
|
Remove one or all locos from reminders |
|
Emergency Stop |
|
Turns loco decoder functions ON and OFF |
|
Request the list defined Roster Entry IDs |
|
Request details of a specific Roster Entry |
|
Request the list of Turnout/Point IDs |
|
Request details of a specific Turnout/Point |
|
Request the list of Automation and Route IDs |
|
Request details of a specific Automation or Route |
|
Request a deliberate update of cab |
|
legacy function. |
System Information
Command |
Description / Response |
---|---|
|
Request CommandStation Status |
|
Request Current on the MAIN Track |
|
Show number of supported cabs |
Writing CVs - Program on the main
Command |
Description / Response |
---|---|
|
Write a DCC packet the MAIN track |
|
Write CV on main track |
|
Write CV bit on main track |
|
Write CV |
|
Write bit to CV |
Reading/Writing CVs - Programming track
Command |
Description / Response |
---|---|
|
Read DCC decoder address |
|
Write DCC address to cab (loco) |
|
Write CV |
|
Write bit to CV |
|
Read CV |
|
Verify/Read of CV with guessed value |
|
Verify/Read bit of CV with guessed value |
|
Writes a DCC packet to the PROG track |
Writing CVs - Programming track - Tuning
Command |
Description / Response |
---|---|
|
Override ACK processing mA pulse size |
|
Override ACK processing minimum pulse width |
|
Override ACK processing max pulse width |
|
Adjust ACK retries to number x (default is 2) |
|
Override 250mA prog track limit while idle |
DCC Accessories
Command |
Description / Response |
---|---|
|
Control an Accessory Decoder |
|
Control an Accessory Decoder |
Turnouts/Points
Command |
Description / Response |
---|---|
|
List all defined turnouts/Points |
|
Throw (1 or T) or close(0 or C) a defined turnout/point |
|
Delete defined turnout/point |
Routes/Automations
Command |
Description / Response |
---|---|
|
Returns a list of Automations/Routes |
|
Returns information for a route/automation |
Sensors
Command |
Description / Response |
---|---|
|
Lists Status of all sensors |
|
Lists definition all defined sensors |
|
Create a new sensor ID |
|
Delete defined sensor |
WiFi Control
Command |
Description / Response |
---|---|
|
Sends AT+ commands to the WiFi board (ESP8266, ESP32, etc.) |
|
Force the Command Station into “WiFi Connected” mode |
Track Manager (Formally DC-District)
Note: this is not available yet in the Production release of EX‑CommandStation
Command |
Description / Response |
---|---|
|
Configure Track Manager |
|
Display the current Track Manager configuration |
TBA
Command |
Description / Response |
---|---|
|
Switch between 28 and 128 speed steps |
—
Configuring the EX-CommandStation
Turnouts/Points - Configuration
Command |
Description / Response |
---|---|
|
Define DCC turnout |
|
Define DCC turnout |
|
Define servo turnout |
|
Define VPIN turnout |
|
Delete turnout |
|
Deprecated |
|
Deprecated |
Once all turnout/points have been properly defined, you can use the <E>
(upper case E) command to store their definitions to EEPROM.
Sensors - Configuration
Command |
Description / Response |
---|---|
|
Creates a new sensor ID, with specified PIN and PULLUP |
|
Deletes definition of sensor ID |
Once all sensors have been properly defined, you can use the <E>
(upper case E) command to store their definitions to EEPROM.
Outputs
Command |
Description / Response |
---|---|
|
Lists all defined output pins |
|
Creates a new output ID, with specified PIN and IFLAG values |
<Z id 0|1>
: Sets output ID to either INACTIVE or ACTIVE state
<Z id>
: Deletes definition of output ID
EEPROM management
Command |
Description / Response |
---|---|
|
Store definitions to EEPROM |
|
Erase ALL (turnouts, sensors, and outputs) from EEPROM |
|
Diagnostic dump eeprom contents |
Diagnostic traces
Command |
Description / Response |
---|---|
|
Shows cab numbers and speed in reminder table |
|
Shows remaining RAM (Free Memory) |
|
Enables ACK diagnostics |
|
Enables Command Parser diagnostics |
|
Enables Ethernet diagnostics |
|
Enables LCN interface diagnostics |
|
Enables WiFi diagnostics |
|
Enables WiThrottle diagnostics |
|
Shows configured servo board and GPIO extender board config and used pins |
Diagnostic programming commands
Command |
Description / Response |
---|---|
|
Sets the ACK limit |
|
Sets the ACK pulse minimum |
|
Sets the ACK pulse maximum |
|
Sets the ACK pulse maximum |
|
Override 250mA prog track limit while idle |
I/O (HAL) Diagnostics
Command |
Description / Response |
---|---|
|
List HAL devices and allocated VPINs |
|
Set servo position to value on pin vpin. |
|
Write value to analogue pin vpin, supplying param2 to the driver. |
|
Read and display pin vpin’s analogue value. |
Other
Command |
Description / Response |
---|---|
|
Is reserved for user commands (through user filter) |
More Information
- For a detailed command reference, see…