Logo
  • DCC-EX Native command protocol library
  • Library Design Principles
    • DCCEXProtocol Class
    • DCCEXProtocolDelegate Class
  • Usage
    • Setup
      • A Note on DCCEXProtocolDelegate
    • Control and Inputs
    • Retrieving and referring to object lists
      • Command Station Consist (CSConsist) list
    • Speed Update Queuing and Throttling
    • Object ownership
  • Examples
    • DCCEXProtocol_Basic
    • DCCEXProtocol_Delegate
    • DCCEXProtocol_Roster_etc
    • DCCEXProtocol_Loco_Control
    • DCCEXProtocol_CSConsist_Control
    • DCCEXProtocol_Consist_Control - DEPRECATED
    • DCCEXProtocol_Turnout_control
    • DCCEXProtocol_Multi_Throttle_Control
    • DCCEXProtocol_Track_type
    • DCCEXProtocol_Serial
    • Additional Examples
      • DCCEXProtocol_SSID
      • DCCEXProtocol_mDNS
  • Library
    • Consist
      • Consist::Consist()
      • Consist::setName()
      • Consist::getName()
      • Consist::addLoco()
      • Consist::addLoco()
      • Consist::removeLoco()
      • Consist::removeAllLocos()
      • Consist::setLocoFacing()
      • Consist::getLocoCount()
      • Consist::inConsist()
      • Consist::inConsist()
      • Consist::getSpeed()
      • Consist::getDirection()
      • Consist::getFirst()
      • Consist::getByAddress()
      • Consist::~Consist()
      • Consist::_addLocoToConsist()
      • Consist::_name
      • Consist::_locoCount
      • Consist::_first
    • ConsistLoco
      • ConsistLoco::ConsistLoco()
      • ConsistLoco::getLoco()
      • ConsistLoco::setFacing()
      • ConsistLoco::getFacing()
      • ConsistLoco::getNext()
      • ConsistLoco::setNext()
      • ConsistLoco::~ConsistLoco()
      • ConsistLoco::_loco
      • ConsistLoco::_facing
      • ConsistLoco::_next
    • CSConsist
      • CSConsist::CSConsist()
      • CSConsist::getNext()
      • CSConsist::addMember()
      • CSConsist::removeMember()
      • CSConsist::removeAllMembers()
      • CSConsist::getFirstMember()
      • CSConsist::getMember()
      • CSConsist::isInConsist()
      • CSConsist::isReversed()
      • CSConsist::isValid()
      • CSConsist::getMemberCount()
      • CSConsist::getAlwaysReplicateFunctions()
      • CSConsist::setReplicateFunctions()
      • CSConsist::getReplicateFunctions()
      • CSConsist::~CSConsist()
      • CSConsist::getFirst()
      • CSConsist::clearCSConsists()
      • CSConsist::getLeadLocoCSConsist()
      • CSConsist::getMemberCSConsist()
      • CSConsist::setAlwaysReplicateFunctions()
      • CSConsist::_replicateFunctions
      • CSConsist::_firstMember
      • CSConsist::_next
      • CSConsist::_memberCount
      • CSConsist::_first
      • CSConsist::_alwaysReplicateFunctions
    • CSConsistMember
      • CSConsistMember::CSConsistMember()
      • CSConsistMember::address
      • CSConsistMember::reversed
      • CSConsistMember::next
    • DCCEXInbound
      • DCCEXInbound::setup()
      • DCCEXInbound::cleanup()
      • DCCEXInbound::parse()
      • DCCEXInbound::getOpcode()
      • DCCEXInbound::getParameterCount()
      • DCCEXInbound::getNumber()
      • DCCEXInbound::isTextParameter()
      • DCCEXInbound::getTextParameter()
      • DCCEXInbound::copyTextParameter()
      • DCCEXInbound::dump()
      • DCCEXInbound::_isTextInternal()
      • DCCEXInbound::_maxParams
      • DCCEXInbound::_parameterCount
      • DCCEXInbound::_opcode
      • DCCEXInbound::_parameterValues
      • DCCEXInbound::_cmdBuffer
    • DCCEXProtocol
      • DCCEXProtocol::DCCEXProtocol()
      • DCCEXProtocol::~DCCEXProtocol()
      • DCCEXProtocol::setDelegate()
      • DCCEXProtocol::setLogStream()
      • DCCEXProtocol::enableHeartbeat()
      • DCCEXProtocol::connect()
      • DCCEXProtocol::disconnect()
      • DCCEXProtocol::check()
      • DCCEXProtocol::sendCommand()
      • DCCEXProtocol::getLists()
      • DCCEXProtocol::receivedLists()
      • DCCEXProtocol::requestServerVersion()
      • DCCEXProtocol::receivedVersion()
      • DCCEXProtocol::getMajorVersion()
      • DCCEXProtocol::getMinorVersion()
      • DCCEXProtocol::getPatchVersion()
      • DCCEXProtocol::getLastServerResponseTime()
      • DCCEXProtocol::clearAllLists()
      • DCCEXProtocol::refreshAllLists()
      • DCCEXProtocol::setDebug()
      • DCCEXProtocol::setThrottle()
      • DCCEXProtocol::setThrottle()
      • DCCEXProtocol::setThrottle()
      • DCCEXProtocol::functionOn()
      • DCCEXProtocol::functionOn()
      • DCCEXProtocol::functionOn()
      • DCCEXProtocol::functionOff()
      • DCCEXProtocol::functionOff()
      • DCCEXProtocol::functionOff()
      • DCCEXProtocol::isFunctionOn()
      • DCCEXProtocol::isFunctionOn()
      • DCCEXProtocol::isFunctionOn()
      • DCCEXProtocol::requestLocoUpdate()
      • DCCEXProtocol::readLoco()
      • DCCEXProtocol::emergencyStop()
      • DCCEXProtocol::getRosterCount()
      • DCCEXProtocol::receivedRoster()
      • DCCEXProtocol::findLocoInRoster()
      • DCCEXProtocol::clearRoster()
      • DCCEXProtocol::clearLocalLocos()
      • DCCEXProtocol::refreshRoster()
      • DCCEXProtocol::requestCSConsists()
      • DCCEXProtocol::createCSConsist()
      • DCCEXProtocol::addCSConsistMember()
      • DCCEXProtocol::getCSConsistByLeadLoco()
      • DCCEXProtocol::getCSConsistByLeadLoco()
      • DCCEXProtocol::getCSConsistByMemberLoco()
      • DCCEXProtocol::getCSConsistByMemberLoco()
      • DCCEXProtocol::removeCSConsistMember()
      • DCCEXProtocol::deleteCSConsist()
      • DCCEXProtocol::deleteCSConsist()
      • DCCEXProtocol::clearCSConsists()
      • DCCEXProtocol::setMomentumAlgorithm()
      • DCCEXProtocol::setDefaultMomentum()
      • DCCEXProtocol::setDefaultMomentum()
      • DCCEXProtocol::setMomentum()
      • DCCEXProtocol::setMomentum()
      • DCCEXProtocol::setMomentum()
      • DCCEXProtocol::setMomentum()
      • DCCEXProtocol::getTurnoutCount()
      • DCCEXProtocol::receivedTurnoutList()
      • DCCEXProtocol::getTurnoutById()
      • DCCEXProtocol::closeTurnout()
      • DCCEXProtocol::throwTurnout()
      • DCCEXProtocol::toggleTurnout()
      • DCCEXProtocol::clearTurnoutList()
      • DCCEXProtocol::refreshTurnoutList()
      • DCCEXProtocol::getRouteCount()
      • DCCEXProtocol::receivedRouteList()
      • DCCEXProtocol::startRoute()
      • DCCEXProtocol::handOffLoco()
      • DCCEXProtocol::pauseRoutes()
      • DCCEXProtocol::resumeRoutes()
      • DCCEXProtocol::clearRouteList()
      • DCCEXProtocol::refreshRouteList()
      • DCCEXProtocol::getTurntableCount()
      • DCCEXProtocol::receivedTurntableList()
      • DCCEXProtocol::getTurntableById()
      • DCCEXProtocol::rotateTurntable()
      • DCCEXProtocol::clearTurntableList()
      • DCCEXProtocol::refreshTurntableList()
      • DCCEXProtocol::powerOn()
      • DCCEXProtocol::powerOff()
      • DCCEXProtocol::powerMainOn()
      • DCCEXProtocol::powerMainOff()
      • DCCEXProtocol::powerProgOn()
      • DCCEXProtocol::powerProgOff()
      • DCCEXProtocol::joinProg()
      • DCCEXProtocol::powerTrackOn()
      • DCCEXProtocol::powerTrackOff()
      • DCCEXProtocol::setTrackType()
      • DCCEXProtocol::requestTrackCurrentGauges()
      • DCCEXProtocol::requestTrackCurrents()
      • DCCEXProtocol::activateAccessory()
      • DCCEXProtocol::deactivateAccessory()
      • DCCEXProtocol::activateLinearAccessory()
      • DCCEXProtocol::deactivateLinearAccessory()
      • DCCEXProtocol::getNumberSupportedLocos()
      • DCCEXProtocol::readCV()
      • DCCEXProtocol::validateCV()
      • DCCEXProtocol::validateCVBit()
      • DCCEXProtocol::writeLocoAddress()
      • DCCEXProtocol::writeCV()
      • DCCEXProtocol::writeCVBit()
      • DCCEXProtocol::writeCVOnMain()
      • DCCEXProtocol::writeCVBitOnMain()
      • DCCEXProtocol::setFastClock()
      • DCCEXProtocol::requestFastClockTime()
      • DCCEXProtocol::roster
      • DCCEXProtocol::turnouts
      • DCCEXProtocol::routes
      • DCCEXProtocol::turntables
      • DCCEXProtocol::csConsists
      • DCCEXProtocol::getLibraryVersion()
      • DCCEXProtocol::_init()
      • DCCEXProtocol::_sendCommand()
      • DCCEXProtocol::_processCommand()
      • DCCEXProtocol::_processServerDescription()
      • DCCEXProtocol::_processMessage()
      • DCCEXProtocol::_processScreenUpdate()
      • DCCEXProtocol::_sendHeartbeat()
      • DCCEXProtocol::_processLocoBroadcast()
      • DCCEXProtocol::_getValidFunctionMap()
      • DCCEXProtocol::_getSpeedFromSpeedByte()
      • DCCEXProtocol::_getDirectionFromSpeedByte()
      • DCCEXProtocol::_setLocos()
      • DCCEXProtocol::_updateLocos()
      • DCCEXProtocol::_processReadResponse()
      • DCCEXProtocol::_processPendingUserChanges()
      • DCCEXProtocol::_processCSConsist()
      • DCCEXProtocol::_buildCSConsist()
      • DCCEXProtocol::_sendCreateCSConsist()
      • DCCEXProtocol::_sendDeleteCSConsist()
      • DCCEXProtocol::_setCSConsistMemberFunction()
      • DCCEXProtocol::_getRoster()
      • DCCEXProtocol::_requestedRoster()
      • DCCEXProtocol::_processRosterList()
      • DCCEXProtocol::_requestRosterEntry()
      • DCCEXProtocol::_processRosterEntry()
      • DCCEXProtocol::_getTurnouts()
      • DCCEXProtocol::_requestedTurnouts()
      • DCCEXProtocol::_processTurnoutList()
      • DCCEXProtocol::_requestTurnoutEntry()
      • DCCEXProtocol::_processTurnoutEntry()
      • DCCEXProtocol::_processTurnoutBroadcast()
      • DCCEXProtocol::_getRoutes()
      • DCCEXProtocol::_requestedRoutes()
      • DCCEXProtocol::_processRouteList()
      • DCCEXProtocol::_requestRouteEntry()
      • DCCEXProtocol::_processRouteEntry()
      • DCCEXProtocol::_getTurntables()
      • DCCEXProtocol::_requestedTurntables()
      • DCCEXProtocol::_processTurntableList()
      • DCCEXProtocol::_requestTurntableEntry()
      • DCCEXProtocol::_processTurntableEntry()
      • DCCEXProtocol::_requestTurntableIndexEntry()
      • DCCEXProtocol::_processTurntableIndexEntry()
      • DCCEXProtocol::_processTurntableBroadcast()
      • DCCEXProtocol::_processTrackPower()
      • DCCEXProtocol::_processTrackType()
      • DCCEXProtocol::_processTrackCurrentGauges()
      • DCCEXProtocol::_processTrackCurrents()
      • DCCEXProtocol::_processValidateCVResponse()
      • DCCEXProtocol::_processValidateCVBitResponse()
      • DCCEXProtocol::_processWriteLocoResponse()
      • DCCEXProtocol::_processWriteCVResponse()
      • DCCEXProtocol::_processSetFastClock()
      • DCCEXProtocol::_processFastClockTime()
      • DCCEXProtocol::_cmdStart()
      • DCCEXProtocol::_cmdAppend()
      • DCCEXProtocol::_cmdAppend()
      • DCCEXProtocol::_cmdAppend()
      • DCCEXProtocol::_cmdSend()
      • DCCEXProtocol::_sendOpcode()
      • DCCEXProtocol::_sendOneParam()
      • DCCEXProtocol::_sendOneParam()
      • DCCEXProtocol::_sendOneParam()
      • DCCEXProtocol::_sendTwoParams()
      • DCCEXProtocol::_sendTwoParams()
      • DCCEXProtocol::_sendTwoParams()
      • DCCEXProtocol::_sendTwoParams()
      • DCCEXProtocol::_sendTwoParams()
      • DCCEXProtocol::_sendThreeParams()
      • DCCEXProtocol::_sendThreeParams()
      • DCCEXProtocol::_sendThreeParams()
      • DCCEXProtocol::_sendThreeParams()
      • DCCEXProtocol::_sendFourParams()
      • DCCEXProtocol::_rosterCount
      • DCCEXProtocol::_turnoutCount
      • DCCEXProtocol::_routeCount
      • DCCEXProtocol::_turntableCount
      • DCCEXProtocol::_version
      • DCCEXProtocol::_stream
      • DCCEXProtocol::_console
      • DCCEXProtocol::_nullStream
      • DCCEXProtocol::_bufflen
      • DCCEXProtocol::_maxCmdBuffer
      • DCCEXProtocol::_cmdBuffer
      • DCCEXProtocol::_outboundCommand
      • DCCEXProtocol::_delegate
      • DCCEXProtocol::_lastServerResponseTime
      • DCCEXProtocol::_inputBuffer
      • DCCEXProtocol::_nextChar
      • DCCEXProtocol::_receivedVersion
      • DCCEXProtocol::_receivedLists
      • DCCEXProtocol::_rosterRequested
      • DCCEXProtocol::_receivedRoster
      • DCCEXProtocol::_turnoutListRequested
      • DCCEXProtocol::_receivedTurnoutList
      • DCCEXProtocol::_routeListRequested
      • DCCEXProtocol::_receivedRouteList
      • DCCEXProtocol::_turntableListRequested
      • DCCEXProtocol::_receivedTurntableList
      • DCCEXProtocol::_enableHeartbeat
      • DCCEXProtocol::_heartbeatDelay
      • DCCEXProtocol::_lastHeartbeat
      • DCCEXProtocol::_cmdIndex
      • DCCEXProtocol::_userChangeDelay
      • DCCEXProtocol::_lastUserChange
      • DCCEXProtocol::_debug
    • DCCEXProtocolDelegate
      • DCCEXProtocolDelegate::receivedServerVersion()
      • DCCEXProtocolDelegate::receivedMessage()
      • DCCEXProtocolDelegate::receivedRosterList()
      • DCCEXProtocolDelegate::receivedTurnoutList()
      • DCCEXProtocolDelegate::receivedRouteList()
      • DCCEXProtocolDelegate::receivedTurntableList()
      • DCCEXProtocolDelegate::receivedLocoUpdate()
      • DCCEXProtocolDelegate::receivedLocoBroadcast()
      • DCCEXProtocolDelegate::receivedTrackPower()
      • DCCEXProtocolDelegate::receivedTrackCurrentGauge()
      • DCCEXProtocolDelegate::receivedTrackCurrent()
      • DCCEXProtocolDelegate::receivedIndividualTrackPower()
      • DCCEXProtocolDelegate::receivedTrackType()
      • DCCEXProtocolDelegate::receivedTurnoutAction()
      • DCCEXProtocolDelegate::receivedTurntableAction()
      • DCCEXProtocolDelegate::receivedReadLoco()
      • DCCEXProtocolDelegate::receivedValidateCV()
      • DCCEXProtocolDelegate::receivedValidateCVBit()
      • DCCEXProtocolDelegate::receivedWriteLoco()
      • DCCEXProtocolDelegate::receivedWriteCV()
      • DCCEXProtocolDelegate::receivedScreenUpdate()
      • DCCEXProtocolDelegate::receivedCSConsist()
      • DCCEXProtocolDelegate::receivedSetFastClock()
      • DCCEXProtocolDelegate::receivedFastClockTime()
      • DCCEXProtocolDelegate::~DCCEXProtocolDelegate()
    • Loco
      • Loco::Loco()
      • Loco::getAddress()
      • Loco::setName()
      • Loco::getName()
      • Loco::setSpeed()
      • Loco::getSpeed()
      • Loco::setDirection()
      • Loco::getDirection()
      • Loco::getSource()
      • Loco::setupFunctions()
      • Loco::isFunctionOn()
      • Loco::setFunctionStates()
      • Loco::getFunctionStates()
      • Loco::getFunctionName()
      • Loco::isFunctionMomentary()
      • Loco::setNext()
      • Loco::getNext()
      • Loco::setUserSpeed()
      • Loco::getUserSpeed()
      • Loco::setUserDirection()
      • Loco::getUserDirection()
      • Loco::resetUserChangePending()
      • Loco::getUserChangePending()
      • Loco::~Loco()
      • Loco::getFirst()
      • Loco::getByAddress()
      • Loco::clearRoster()
      • Loco::getFirstLocalLoco()
      • Loco::clearLocalLocos()
      • Loco::_address
      • Loco::_name
      • Loco::_speed
      • Loco::_direction
      • Loco::_source
      • Loco::_functionNames
      • Loco::_functionStates
      • Loco::_momentaryFlags
      • Loco::_next
      • Loco::_userSpeed
      • Loco::_userDirection
      • Loco::_userChangePending
      • Loco::_addToList()
      • Loco::_findAddressInList()
      • Loco::_removeFromList()
      • Loco::_clearList()
      • Loco::_first
      • Loco::_firstLocalLoco
    • NullStream
      • NullStream::NullStream()
      • NullStream::available()
      • NullStream::flush()
      • NullStream::peek()
      • NullStream::read()
      • NullStream::write()
      • NullStream::write()
    • Route
      • Route::Route()
      • Route::getId()
      • Route::setName()
      • Route::getName()
      • Route::setType()
      • Route::getType()
      • Route::setNext()
      • Route::getNext()
      • Route::~Route()
      • Route::getFirst()
      • Route::getById()
      • Route::clearRouteList()
      • Route::_removeFromList()
      • Route::_id
      • Route::_name
      • Route::_type
      • Route::_next
      • Route::_first
    • Turnout
      • Turnout::Turnout()
      • Turnout::setThrown()
      • Turnout::setName()
      • Turnout::getId()
      • Turnout::getName()
      • Turnout::getThrown()
      • Turnout::setNext()
      • Turnout::getNext()
      • Turnout::~Turnout()
      • Turnout::getFirst()
      • Turnout::getById()
      • Turnout::clearTurnoutList()
      • Turnout::_removeFromList()
      • Turnout::_next
      • Turnout::_id
      • Turnout::_name
      • Turnout::_thrown
      • Turnout::_first
    • Turntable
      • Turntable::Turntable()
      • Turntable::getId()
      • Turntable::setType()
      • Turntable::getType()
      • Turntable::setIndex()
      • Turntable::getIndex()
      • Turntable::setNumberOfIndexes()
      • Turntable::getNumberOfIndexes()
      • Turntable::setName()
      • Turntable::getName()
      • Turntable::setMoving()
      • Turntable::isMoving()
      • Turntable::getIndexCount()
      • Turntable::setNext()
      • Turntable::getNext()
      • Turntable::addIndex()
      • Turntable::getFirstIndex()
      • Turntable::getIndexById()
      • Turntable::~Turntable()
      • Turntable::getFirst()
      • Turntable::getById()
      • Turntable::clearTurntableList()
      • Turntable::_removeFromList()
      • Turntable::_id
      • Turntable::_type
      • Turntable::_index
      • Turntable::_numberOfIndexes
      • Turntable::_name
      • Turntable::_isMoving
      • Turntable::_indexCount
      • Turntable::_next
      • Turntable::_firstIndex
      • Turntable::_first
    • TurntableIndex
      • TurntableIndex::TurntableIndex()
      • TurntableIndex::getTTId()
      • TurntableIndex::getId()
      • TurntableIndex::getAngle()
      • TurntableIndex::getName()
      • TurntableIndex::getNextIndex()
      • TurntableIndex::~TurntableIndex()
      • TurntableIndex::_ttId
      • TurntableIndex::_id
      • TurntableIndex::_angle
      • TurntableIndex::_name
      • TurntableIndex::_nextIndex
    • splitState
      • splitState::FIND_START
      • splitState::SET_OPCODE
      • splitState::SKIP_SPACES
      • splitState::CHECK_SIGN
      • splitState::BUILD_PARAM
      • splitState::SKIPOVER_TEXT
      • splitState::COMPLETE_i_COMMAND
    • QUOTE_FLAG
    • QUOTE_FLAG_AREA
    • Direction
      • Direction::Reverse
      • Direction::Forward
    • LocoSource
      • LocoSource::LocoSourceRoster
      • LocoSource::LocoSourceEntry
    • Facing
      • Facing::FacingForward
      • Facing::FacingReversed
    • MAX_FUNCTIONS
    • MAX_OBJECT_NAME_LENGTH
    • MIN_SPEED
    • MAX_SPEED
    • TrackPower
      • TrackPower::PowerOff
      • TrackPower::PowerOn
      • TrackPower::PowerUnknown
    • TrackManagerMode
      • TrackManagerMode::MAIN
      • TrackManagerMode::PROG
      • TrackManagerMode::DC
      • TrackManagerMode::DCX
      • TrackManagerMode::NONE
    • MomentumAlgorithm
      • MomentumAlgorithm::Linear
      • MomentumAlgorithm::Power
    • MAX_OUTBOUND_COMMAND_LENGTH
    • RouteType
      • RouteType::RouteTypeRoute
      • RouteType::RouteTypeAutomation
    • TurntableType
      • TurntableType::TurntableTypeDCC
      • TurntableType::TurntableTypeEXTT
      • TurntableType::TurntableTypeUnknown
  • Bugs and Requests
  • Library Tests
    • Test Coverage
    • Legacy cmake Tests
  • Contributions
    • Library Maintenance
    • Documentation
  • Indices and tables
DCCEXProtocol
  • Search

© Copyright 2026 - Peter Cole, Peter Akers.

Built with Sphinx using a theme provided by Read the Docs.