Library

class Consist

#include <DCCEXLoco.h>

DEPRECATED! Class to create a software consist of one or more ConsistLoco objects.

As of version 1.3.0, all Consist and related classes and methods are being deprecated in favour of the new command station consists.

Public Functions

Consist(): DEPRECATED Constructor.

void setName(const char *name)

DEPRECATED Set consist name.

Parameters:: name – Name to set for the consist

const char *getName()

DEPRECATED Get consist name.

Returns:: Current name of the consist

void addLoco(Loco *loco, Facing facing)

DEPRECATED Add a loco to the consist using a Loco object.

Parameters:

loco – Pointer to a loco object
facing – Direction the loco is facing (FacingForward|FacingReversed)

void addLoco(int address, Facing facing)

DEPRECATED Add a loco to the consist using a DCC address.

Parameters:

address – DCC address of the loco to add
facing – Direction the loco is facing (FacingForward|FacingReversed)

void removeLoco(Loco *loco)

DEPRECATED Remove a loco from the consist - Loco objects with LocoSourceEntry will also be deleted.

Parameters:: loco – Pointer to a loco object to remove

void removeAllLocos(): DEPRECATED Remove all locos from a consist - Loco objects with LocoSourceEntry will also be deleted.

void setLocoFacing(Loco *loco, Facing facing)

DEPRECATED Update the direction of a loco in the consist.

Parameters:

loco – Pointer to the loco object to update
facing – Direction to set it to (FacingForward|FacingReversed)

int getLocoCount()

DEPRECATED Get the count of locos in the consist.

Returns:: Count of locos

bool inConsist(Loco *loco)

DEPRECATED Check if the provided loco is in the consist.

Parameters:: loco – Pointer to the loco object to check
Returns:: true|false

bool inConsist(int address)

DEPRECATED Check if the loco with the provided address is in the consist.

Parameters:: address – DCC address of loco to check
Returns:: true|false

int getSpeed()

DEPRECATED Get consist speed - obtained from first linked loco.

Returns:: Current speed (0 - 126)

Direction getDirection()

DEPRECATED Get consist direction - obtained from first linked loco.

Returns:: Current direction (Forward|Reverse)

ConsistLoco *getFirst()

DEPRECATED Get the first loco in the consist.

Returns:: Pointer to the first ConsistLoco object

ConsistLoco *getByAddress(int address)

DEPRECATED Get the loco in the consist with the specified address.

Parameters:: address – DCC address of loco to retrieve
Returns:: Pointer to the first ConsistLoco object

~Consist(): DEPRECATED Destructor for a Consist.

Private Functions

void _addLocoToConsist(ConsistLoco *consistLoco)

Private Members

char *_name

int _locoCount

ConsistLoco *_first

class ConsistLoco

#include <DCCEXLoco.h>

DEPRECATED! Class to add an additional attribute to a Loco object to specify the direction it is facing in a consist.

As of version 1.3.0, all Consist and related classes and methods are being deprecated in favour of the new command station consists.

Public Functions

ConsistLoco(Loco *loco, Facing facing)

DEPRECATED Constructor.

Parameters:

loco – Pointer to the Loco object to add
facing – Direction loco is facing in the consist (FacingForward|FacingReversed)

Loco *getLoco()

DEPRECATED Get the associated Loco object for this consist entry.

Returns:: Pointer to the Loco object

void setFacing(Facing facing)

DEPRECATED Set which way the loco is facing in the consist (FacingForward, FacingReversed)

Parameters:: facing – FacingForward|FacingReversed

Facing getFacing()

DEPRECATED Get which way the loco is facing in the consist (FacingForward, FacingReversed)

Returns:: FacingForward|FacingReversed

ConsistLoco *getNext()

DEPRECATED Get the next consist loco object.

Returns:: Pointer to the next ConsistLoco object

void setNext(ConsistLoco *consistLoco)

DEPRECATED Set the next consist loco object.

Parameters:: consistLoco – Pointer to the ConsistLoco object

~ConsistLoco(): DEPRECATED Destructor for a ConsistLoco.

Private Members

Loco *_loco

Facing _facing

ConsistLoco *_next

Friends

friend class Consist

class CSConsist

#include <DCCEXCSConsist.h>

Class to assist managing command station consists.

In order for the command station to accept a CSConsist, at least two locos are required. Each member loco is a CSConsistMember object, enabling them to be operated in reverse compared to normal direction of travel. Each CSConsist instance is in a linked list accessible via CSConsist::getFirst(). It is recommended to always create and delete CSConsist objects using the methods provided in DCCEXProtocol class to ensure your command station is updated appropriately.

Public Functions

CSConsist(bool replicateFunctions = false)

Construct a new CSConsist object.

Parameters:: replicateFunctions – Replicate function control to all member locos (default false)

CSConsist *getNext()

Get the Next object.

Returns:: CSConsist* Pointer to the next CSConsist object

void addMember(int address, bool reversed)

Add a loco by address to the consist.

This method attempts to find an existing Loco object and will use that instead of creating a new object.

Parameters:

address – DCC address of the loco to be added
reversed – True if loco is reversed to normal direction of travel

void removeMember(int address)

Remove a loco by address from the consist.

Parameters:: address – DCC address of the loco to be removed

void removeAllMembers(): Remove all CSConsistMember objects from this consist.

CSConsistMember *getFirstMember()

Get the First Member object.

Returns:: CSConsistMember* Pointer to the first CSConsistMember object

CSConsistMember *getMember(int address)

Get the Member Loco object.

Parameters:: address – DCC address of the loco associated with the member
Returns:: CSConsistMember* Pointer to the CSConsistMember object

bool isInConsist(int address)

Check by address if a loco is in this consist.

Parameters:: address – DCC address of the loco
Returns:: true If loco address is in consist
Returns:: false If not

bool isReversed(int address)

Check by address if the loco is reversed in this consist.

Parameters:: address – DCC address of the loco
Returns:: true If loco address is in consist and reversed
Returns:: false If loco address is not in consist or is not reversed

bool isValid()

Check if this is a valid consist with more than 1 member.

Returns:: true Valid CSConsist
Returns:: false Invalid (less than 2 members)

int getMemberCount()

Get the number of members in the CSConsist.

Returns:: int Member count

bool getAlwaysReplicateFunctions()

Get the Always Replicate Functions setting.

Returns:: true If static/global flag enabled
Returns:: false If not

void setReplicateFunctions(bool replicate)

Set the Replicate Functions flag for this CSConsist.

Parameters:: replicate – True if function control should apply to all members

bool getReplicateFunctions()

Get the Replicate Functions flag for this CSConsist.

Returns:: true True if function control should apply to all members
Returns:: false False if not

~CSConsist(): Destroy the CSConsist object.

Public Static Functions

static CSConsist *getFirst()

Get the First object.

Returns:: CSConsist* Pointer to the first CSConsist object

static void clearCSConsists(): Clear all CSConsists from the list.

static CSConsist *getLeadLocoCSConsist(int address)

Get the CSConsist the provided address is lead loco of.

Parameters:: address – DCC address of the lead loco to check for
Returns:: CSConsist* Pointer to the CSConsist object, or nullptr if none found

static CSConsist *getMemberCSConsist(int address)

Get the CSConsist the provided address is a member of.

Parameters:: address – DCC address of the member loco to check for
Returns:: CSConsist* Pointer to the CSConsist object, or nullptr if none found

static void setAlwaysReplicateFunctions(bool replicate)

Set the default behaviour for function replication for all new CSConsist objects.

Call this method once before creating any CSConsist objects to ensure all inherit this behaviour.

Parameters:: replicate – True if all newly created CSConsist objects should replicate functions

Private Members

bool _replicateFunctions

CSConsistMember *_firstMember

CSConsist *_next

int _memberCount

Private Static Attributes

static CSConsist *_first = nullptr

static bool _alwaysReplicateFunctions = false

struct CSConsistMember

#include <DCCEXCSConsist.h>

Structure for a CSConsistMember.

Public Functions

inline CSConsistMember(int address, bool reversed)

Construct a new CSConsistMember object.

Parameters:

address – DCC address of the member
reversed – True if reversed to normal direction of travel

Public Members

uint16_t address

uint16_t reversed

CSConsistMember *next

class DCCEXInbound

#include <DCCEXInbound.h>

Inbound DCC-EX command parser class to parse commands and provide interpreted parameters.

Public Static Functions

static void setup(int16_t maxParameterValues)

Setup parser once with enough space to handle the maximum number of parameters expected from the command station.

Parameters:: maxParameterValues – Maximum parameter values to accommodate

static void cleanup(): Cleanup parser.

static bool parse(char *command)

Pass in a command string to parse.

Parameters:: command – Char array of command to parse
Returns:: True if parsed ok, false if badly terminated command or too many parameters

static byte getOpcode(): Gets the DCC-EX OPCODE of the parsed command (the first char after the <)

static int16_t getParameterCount()

Gets number of parameters detected after OPCODE <JR 1 2 3> is 4 parameters!

Returns:: Number of parameters

static int32_t getNumber(int16_t parameterNumber)

Gets a numeric parameter (or hashed keyword) from parsed command.

Returns:: The numeric parameter

static bool isTextParameter(int16_t parameterNumber)

Checks if a parameter is actually text rather than numeric.

Parameters:: parameterNumber – The number of the parameter to check
Returns:: true|false

static char *getTextParameter(int16_t parameterNumber)

Gets address of text type parameter. does not create permanent copy.

Parameters:: parameterNumber – The number of the parameter to retrieve
Returns:: Char array of text (use once and discard)

static char *copyTextParameter(int16_t parameterNumber)

gets address of a heap copy of text type parameter.

Parameters:: parameterNumber –
Returns:

static void dump(Print*)

dump list of parameters obtained

Parameters:: out – Address of output e.g. &Serial

Private Static Functions

static bool _isTextInternal(int16_t n)

Private Static Attributes

static int16_t _maxParams = 0

static int16_t _parameterCount = 0

static byte _opcode = 0

static int32_t *_parameterValues = nullptr

static char *_cmdBuffer = nullptr

class DCCEXProtocol

#include <DCCEXProtocol.h>

Main class for the DCCEXProtocol library.

Public Functions

DCCEXProtocol(int maxCmdBuffer = 500, int maxCommandParams = 50, unsigned long userChangeDelay = 100)

Constructor for the DCCEXProtocol object.

Parameters:

maxCmdBuffer – Optional - maximum number of bytes for the command buffer (default 500)
maxCommandParams – Optional - maximum number of parameters to parse via the DCCEXInbound parser (default 50)
userChangeDelay – Optional - time in ms between sending throttle changes (default 100)

~DCCEXProtocol(): Destructor for the DCCEXProtocol object.

void setDelegate(DCCEXProtocolDelegate *delegate)

Set the delegate object for callbacks.

Parameters:: delegate –

void setLogStream(Stream *console)

Set the stream object for console output.

Parameters:: console –

void enableHeartbeat(unsigned long heartbeatDelay = 60000)

Enable heartbeat if required - can help WiFi connections that drop out.

Parameters:: heartbeatDelay – Time in milliseconds between heartbeats - defaults to one minute (60000ms)

void connect(Stream *stream)

Connect the stream object to interact with DCC-EX.

Parameters:: stream –

void disconnect()

DEPRECATED - Does nothing, retained for backwards compatibility only.

Will be removed in 2.0.0.

void check(): Check for incoming DCC-EX broadcasts/responses and parse them.

void sendCommand(const char *cmd)

allows sending of an arbitray command

Parameters:: cmd – Command to send

void getLists(bool rosterRequired = true, bool turnoutListRequired = true, bool routeListRequired = true, bool turntableListRequired = true)

Request DCC-EX object lists (Roster, Turnouts, Routes, Turntables)

Parameters:

rosterRequired – Request the roster list (true|false)
turnoutListRequired – Request the turnout list (true|false)
routeListRequired – Request the route list (true|false)
turntableListRequired – Request the turntable list (true|false)

bool receivedLists()

Check if all lists have been received (roster, routes, turnouts, turntables)

Returns:: true|false

void requestServerVersion(): Request server version information.

bool receivedVersion()

Check if server version has been received.

Returns:

int getMajorVersion()

Retrieve the major version of EX-CommandStation.

Returns:: Major version number eg. 5.y.z

int getMinorVersion()

Retrieve the minor version of EX-Commandstation.

Returns:: Minor version number eg. x.0.z

int getPatchVersion()

Retreive the patch version of EX-CommandStation.

Returns:: Patch version number eg. x.y.7

unsigned long getLastServerResponseTime()

Retrieve the last time the server responded.

Returns:: Last response time in milliseconds (from millis())

void clearAllLists(): Clear roster, turnout, turntable, and route lists.

void refreshAllLists(): Clear roster, turnout, turntable, and route lists and request new ones.

void setDebug(bool debug)

Set the Debug flag.

Parameters:: debug – True to send output commands to the console (defaults to False, no output)

void setThrottle(Loco *loco, int speed, Direction direction)

Set the provided loco to the specified speed and direction.

Parameters:

loco – Pointer to a Loco object
speed – Speed (0 - 126)
direction – Direction (Forward|Reverse)

void setThrottle(Consist *consist, int speed, Direction direction)

DEPRECATED Set all locos in the provided consist to the specified speed and direction.

Will be removed in 2.0.0, use setThrottle(CSConsist *consist, int speed, Direction direction)

Parameters:

consist – Pointer to a consist object
speed – Speed (0 - 126)
direction – Direction (Forward|Reverse) - reverse facing locos will be adjusted automatically

void setThrottle(CSConsist *csConsist, int speed, Direction direction)

Set the provided command station consist to the specified speed and direction.

If this consist does not exist, it will be created first, and if it is not valid, this command will be ignored.

Parameters:

csConsist – Pointer to the CSConsist object
speed – Speed (0 - 126)
direction – Direction (Forward|Reverse)

void functionOn(Loco *loco, int function)

Turn the specified function on for the provided loco.

Parameters:

loco – Pointer to a loco object
function – Function number (0 - 27)

void functionOn(Consist *consist, int function)

DEPRECATED Turn the specified function on for the provided consist.

Will be removed in 2.0.0, use functionOn(CSConsist *csConsist, int function)

Parameters:

consist – Pointer to a consist object
function – Function number (0 - 27)

void functionOn(CSConsist *csConsist, int function)

Turn the specified function on for the provided CSConsist.

Parameters:

csConsist – Pointer to the CSConsist object
function – Function number (0 - 27)

void functionOff(Loco *loco, int function)

Turn the specified function off for the provided loco.

Parameters:

loco – Pointer to a loco object
function – Function number (0 - 27)

void functionOff(Consist *consist, int function)

DEPRECATED Turn the specified function off for the provided consist.

Will be removed in 2.0.0, use functionOff(CSConsist *csConsist, int function)

Parameters:

consist – Pointer to a consist object
function – Function number (0 - 27)

void functionOff(CSConsist *csConsist, int function)

Turn the specified function off for the provided CSConsist.

Parameters:

csConsist – Pointer to the CSConsist object
function – Function number (0 - 27)

bool isFunctionOn(Loco *loco, int function)

Test if the specified function for the provided loco is on.

Parameters:

loco – Pointer to a loco object
function – Function number to test (0 - 27)

Returns:

true = on, false = off

bool isFunctionOn(Consist *consist, int function)

DEPRECATED Test if the specified function for the provided consist is on (Checks first loco)

Will be removed in 2.0.0, use isFunctionOn(CSConsist *csConsist, int function)

Parameters:

consist – Pointer to a consist object
function – Function number to test (0 - 27)

Returns:

true = on, false = off

bool isFunctionOn(CSConsist *csConsist, int function)

Test if the specified function for the provided CSConsist is on (checks first Loco)

Parameters:

csConsist – Pointer to the CSConsist object
function – Function number to test (0 - 27)

Returns:

true Function on

Returns:

false Function off, or CSConsist object is invalid

void requestLocoUpdate(int address)

Explicitly request an update for the specified loco.

Parameters:: address – DCC address of the loco

void readLoco(): Initiate reading a loco address from the programming track, response will be a delegate notification.

void emergencyStop(): Initiate an emergency stop.

int getRosterCount()

Get the number of roster entries.

Returns:: Number of roster entries received

bool receivedRoster()

Check if roster has been received.

Returns:: true|false

Loco *findLocoInRoster(int address)

Search for the specified DCC address in the roster.

Parameters:: address – DCC address to search for
Returns:: Pointer to the Loco object

void clearRoster(): Clear the roster.

void clearLocalLocos(): Clear the list of local locos.

void refreshRoster(): Clear the roster and request again.

void requestCSConsists(): Request the list of CSConsists from the command station, will create CSConsist objects.

CSConsist *createCSConsist(int leadLoco, bool reversed = false, bool replicateFunctions = false)

Create a CSConsist.

Parameters:

leadLoco – DCC address of the lead loco
reversed – True if loco reversed to normal direction of travel (sending Forward will cause it to reverse)

Returns:

CSConsist* Pointer to the created CSConsist object

bool addCSConsistMember(CSConsist *csConsist, int address, bool reversed = false)

Add a member to the CSConsist.

Parameters:

address – DCC address of the member
reversed – True if loco reversed to normal direction of travel (sending Forward will cause it to reverse)

Returns:

bool True if added successfully, otherwise false

CSConsist *getCSConsistByLeadLoco(int address)

Get a CSConsist by the lead loco DCC address.

Parameters:: address – DCC address of the lead loco
Returns:: CSConsist* Pointer to the CSConsist object the loco is lead for, or nullptr if none exist

CSConsist *getCSConsistByLeadLoco(Loco *loco)

Get a CSConsist by the lead Loco object.

Parameters:: address – Pointer to the lead Loco object
Returns:: CSConsist* Pointer to the CSConsist object the loco is lead for, or nullptr if none exist

CSConsist *getCSConsistByMemberLoco(int address)

Get a CSConsist by a member DCC address.

Parameters:: address – DCC address of the member
Returns:: CSConsist* Pointer to the CSConsist object the loco is a member of, or nullptr if none exist

CSConsist *getCSConsistByMemberLoco(Loco *loco)

Get a CSConsist by a member Loco object.

Parameters:: address – Pointer to the member Loco object
Returns:: CSConsist* Pointer to the CSConsist object the loco is a member of, or nullptr if none exist

bool removeCSConsistMember(CSConsist *csConsist, int address)

Remove a member from the CSConsist.

Parameters:: address – DCC address of the member
Returns:: bool True if removed successfully, otherwise false

void deleteCSConsist(int leadLoco)

Delete the CSConsist using the lead loco address.

Parameters:: address – DCC address of the lead loco

void deleteCSConsist(CSConsist *csConsist)

Delete the CSConsist.

Parameters:: csConsist – Pointer to the CSConsist object to delete

void clearCSConsists(): Clears all CSConsist objects.

void setMomentumAlgorithm(MomentumAlgorithm algorithm)

Set the Momentum Algorithm.

Parameters:: algorithm – MomentumAlgorithm (Linear, Power)

void setDefaultMomentum(int momentum)

Set the Default Momentum for accelerating/braking.

Parameters:: momentum – Momentum value

void setDefaultMomentum(int accelerating, int braking)

Set the Default Momentum for separate accelerating/braking.

Parameters:

accelerating – Accelerating momentum value
braking – Braking momentum value

void setMomentum(int address, int momentum)

Set momentum for the specified loco/DC track.

Parameters:

address – DCC address
momentum – Momentum value

void setMomentum(Loco *loco, int momentum)

Set the Momentum for the specified Loco.

Parameters:

loco – Pointer to a Loco object
momentum – Momentum value

void setMomentum(int address, int accelerating, int braking)

Set the Momentum for separate accelerating/braking.

Parameters:

address – DCC address
accelerating – Accelerating momentum value
braking – Braking momentum value

void setMomentum(Loco *loco, int accelerating, int braking)

Set the Momentum for separate accelerating/braking.

Parameters:

loco – Pointer to a Loco object
accelerating – Accelerating momentum value
braking – Braking momentum value

int getTurnoutCount()

Get the number of turnouts.

Returns:: Number of turnouts received

bool receivedTurnoutList()

Check if turnout list has been received.

Returns:: true|false

Turnout *getTurnoutById(int turnoutId)

Retrieve a turnout/point object by its ID.

Parameters:: turnoutId – ID of the turnout/point
Returns:: The turnout/point object

void closeTurnout(int turnoutId)

Close the specified turnout/point.

Parameters:: turnoutId – ID of the turnout/point

void throwTurnout(int turnoutId)

Throw the specified turnout/point.

Parameters:: turnoutId – ID of the turnout/point

void toggleTurnout(int turnoutId)

Toggle the specified turnout/point (if closed, will throw, and vice versa)

Parameters:: turnoutId – ID of the turnout/point

void clearTurnoutList(): Clear the list of turnouts.

void refreshTurnoutList(): Clear the list of turnouts and request again.

int getRouteCount()

Get the number of route entries.

Returns:: Number of routes received

bool receivedRouteList()

Check if route list has been received.

Returns:: true|false

void startRoute(int routeId)

Start a route/automation.

Parameters:: routeId – ID of the route/automation to start

void handOffLoco(int locoAddress, int automationId)

Hand off a Loco to an Automation - note you must retrieve the ROUTE list to use this.

Parameters:

locoAddress – DCC address of the Loco to hand off
automationId – ID of the automation to start, must be RouteType::RouteTypeAutomation

void pauseRoutes(): Pause all routes/automations.

void resumeRoutes(): Resume all routes/automations.

void clearRouteList(): Clear all routes.

void refreshRouteList(): Clear all routes and request a new list.

int getTurntableCount()

Get the number of turntable entries.

Returns:: Number of turntables received

bool receivedTurntableList()

Check if turntable list has been received.

Returns:: true|false

Turntable *getTurntableById(int turntableId)

Retrieve a turntable object by its ID.

Parameters:: turntableId – ID of the turntable
Returns:: The turntable object

void rotateTurntable(int turntableId, int position, int activity = 0)

Rotate a turntable object.

Parameters:

turntableId – ID of the turntable
position – Position index to rotate to
activity – Optional activity for EX-Turntable objects only

void clearTurntableList(): Clear all turntables.

void refreshTurntableList(): Clear all turntables and request a new list.

void powerOn(): Global track power on command.

void powerOff(): Global track power off command.

void powerMainOn(): Main track power on command.

void powerMainOff(): Main track power off command.

void powerProgOn(): Prog track power on command.

void powerProgOff(): Prog track power off command.

void joinProg(): Join Prog track to Main.

void powerTrackOn(char track)

Turn power on for the specified track.

Parameters:: track – Track name (A - H)

void powerTrackOff(char track)

Turn power off for the specified track.

Parameters:: track – Track name (A - H)

void setTrackType(char track, TrackManagerMode type, int address)

set track type for the specified track

Parameters:

track – Track name (A - H)
type – Track type (MAIN, PROG, DC, DCX, NONE)
address – dcc address for DC and DCX (Required, but ignored if not DC or DCX)

void requestTrackCurrentGauges(): Request the current limit set for each track.

void requestTrackCurrents(): Request the latest current value for each track.

void activateAccessory(int accessoryAddress, int accessorySubAddr)

Activate DCC accessory at the specified address and subaddress.

Parameters:

accessoryAddress – Address of the DCC accessory
accessorySubAddr – Subaddress of the DCC accessory

void deactivateAccessory(int accessoryAddress, int accessorySubAddr)

Deactivate DCC accessory at the specified address and subaddress.

Parameters:

accessoryAddress – Address of the DCC accessory
accessorySubAddr – Subaddress of the DCC accessory

void activateLinearAccessory(int linearAddress)

Activate DCC accessory at the specified linear address.

Parameters:: linearAddress – Linear address of the DCC accessory

void deactivateLinearAccessory(int linearAddress)

Deactivate DCC accessory at the specified linear address.

Parameters:: linearAddress – Linear address of the DCC accessory

void getNumberSupportedLocos(): Request the number of supported cabs(locos)

void readCV(int cv)

Read the value of the provided CV from the Loco on the programming track.

Parameters:: cv – CV number to read the value of

void validateCV(int cv, int value)

Validate the provided value is stored in the provided CV.

Parameters:

cv – CV number to validate the value of
value – Value to validate

void validateCVBit(int cv, int bit, int value)

Validate the provided bit is set to the specified value for the provided CV.

Parameters:

cv – CV number to validate the bit of
bit – Bit for the CV to validate
value – Value to validate (0|1)

void writeLocoAddress(int address)

Write Loco address to the Loco on the programming track.

Parameters:: address – DCC address to write

void writeCV(int cv, int value)

Write the provided value to the specified CV on the programming track.

Parameters:

cv – CV number to write to
value – Value to write to the CV

void writeCVBit(int cv, int bit, int value)

Write the provided value to the specified bit and CV on the programming track. Note that the response is in legacy DCC++ formatting and is not supported by the DCCEXInbound parser. Therefore, the throttle will not receive a response. We suggest writing full CVs.

Parameters:

cv – CV number to write to
bit – Bit for the CV to write
value – Value to write (0|1)

void writeCVOnMain(int address, int cv, int value)

Write the provided value to the specified Loco address and CV on the main track.

Parameters:

address – DCC address of the Loco
cv – CV number to write to
value – Value to write to the CV

void writeCVBitOnMain(int address, int cv, int bit, int value)

Write the provided value to the specified Loco, CV, and bit on the main track.

Parameters:

address – DCC address of the Loco
cv – CV number to write to
bit – Bit for the CV to write
value – Value to write (0|1)

void setFastClock(int minutes, int speedFactor)

Set the fast clock time and speed factor.

Parameters:

minutes – Time from midnight in minutes (eg. 60 = 1am)
speedFactor – Speed factor multiplier (eg. 4 = 1 minute every 15 seconds)

void requestFastClockTime(): Request the current fast clock time.

Public Members

Loco *roster = nullptr: Linked list of Loco objects to form the roster, call roster->getFirst()

Turnout *turnouts = nullptr: Linked list of Turnout objects to form the turnout list, call turnouts->getFirst()

Route *routes = nullptr: Linked list of Route objects to form the list of routes and automations, call routes->getFirst()

Turntable *turntables = nullptr: Linked list of Turntable objects to form the list of turntables, call turntables->getFirst()

CSConsist *csConsists = nullptr: Linked list of CSConsist objects to make these accessible via the DCCEXProtocol class, call csConsists->getFirst()

Public Static Functions

static const char *getLibraryVersion()

Get the current DCCEXProtocol library version.

Returns:: const char* Version string

Private Functions

void _init()

void _sendCommand()

void _processCommand()

void _processServerDescription()

void _processMessage()

void _processScreenUpdate()

void _sendHeartbeat()

void _processLocoBroadcast()

int _getValidFunctionMap(int functionMap)

int _getSpeedFromSpeedByte(int speedByte)

Direction _getDirectionFromSpeedByte(int speedByte)

void _setLocos(Loco *firstLoco)

void _updateLocos(Loco *firstLoco, int address, int speedByte, Direction direction, int functionMap)

void _processReadResponse()

void _processPendingUserChanges()

void _processCSConsist()

void _buildCSConsist(CSConsist *csConsist, int memberCount)

void _sendCreateCSConsist(CSConsist *csConsist)

void _sendDeleteCSConsist(CSConsist *csConsist)

void _setCSConsistMemberFunction(CSConsistMember *member, int function, bool state)

void _getRoster()

bool _requestedRoster()

void _processRosterList()

void _requestRosterEntry(int address)

void _processRosterEntry()

void _getTurnouts()

bool _requestedTurnouts()

void _processTurnoutList()

void _requestTurnoutEntry(int id)

void _processTurnoutEntry()

void _processTurnoutBroadcast()

void _getRoutes()

bool _requestedRoutes()

void _processRouteList()

void _requestRouteEntry(int id)

void _processRouteEntry()

void _getTurntables()

bool _requestedTurntables()

void _processTurntableList()

void _requestTurntableEntry(int id)

void _processTurntableEntry()

void _requestTurntableIndexEntry(int id)

void _processTurntableIndexEntry()

void _processTurntableBroadcast()

void _processTrackPower()

void _processTrackType()

void _processTrackCurrentGauges()

void _processTrackCurrents()

void _processValidateCVResponse()

void _processValidateCVBitResponse()

void _processWriteLocoResponse()

void _processWriteCVResponse()

void _processSetFastClock()

void _processFastClockTime()

void _cmdStart(char opcode = '\0')

Start the command with “<” and the OPCODE if required.

Parameters:: opcode – Single character OPCODE to append

void _cmdAppend(const char *s)

Append a string to the command.

Parameters:: s – String to append

void _cmdAppend(int n)

Append an integer value to the command.

Parameters:: n – Integer to append

void _cmdAppend(char c)

Append a single char to the command.

Parameters:: c – Char to append

void _cmdSend(): Append the closing “>” and call _sendCommand()

void _sendOpcode(char opcode)

Formatter for opcode only outbound commands.

Parameters:: opcode – OPCODE to send

void _sendOneParam(char opcode, char param)

Formatter for opcode and one parameter.

Parameters:

opcode – OPCODE to send
param – Single char parameter to send

void _sendOneParam(char opcode, const char *param)

Formatter for opcode and one parameter.

Parameters:

opcode – OPCODE to send
param – Single string parameter to send

void _sendOneParam(char opcode, int param)

Formatter for opcode and one parameter.

Parameters:

opcode – OPCODE to send
param – Single int parameter to send

void _sendTwoParams(char opcode, char param1, int param2)