Skip to content

Commit

Permalink
Deploying to gh-pages from @ 5c10d80 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@peteGSX
peteGSX committed Nov 3, 2024
1 parent 994bc06 commit 9899fd1
Show file tree
Hide file tree
Showing 55 changed files with 860 additions and 711 deletions.
782 changes: 396 additions & 386 deletions DCCEXProtocol_8h_source.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions DCCEXTurntables_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,16 +192,16 @@
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassTurntableIndex_html"><div class="ttname"><a href="classTurntableIndex.html">TurntableIndex</a></div><div class="ttdoc">Class to contain and maintain the various Turntable Index attributes and methods associated with a Tu...</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.h:41</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a2d3e9f8bd9bd7fd8051cdb2bdc981b26"><div class="ttname"><a href="classTurntableIndex.html#a2d3e9f8bd9bd7fd8051cdb2bdc981b26">TurntableIndex::TurntableIndex</a></div><div class="ttdeci">TurntableIndex(int ttId, int id, int angle, char *name)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:37</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a4ba2249037936f7b56af4c8188943202"><div class="ttname"><a href="classTurntableIndex.html#a4ba2249037936f7b56af4c8188943202">TurntableIndex::getName</a></div><div class="ttdeci">char * getName()</div><div class="ttdoc">Get index name.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:51</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a703aa0c89761025fd6d401a34359bea2"><div class="ttname"><a href="classTurntableIndex.html#a703aa0c89761025fd6d401a34359bea2">TurntableIndex::getTTId</a></div><div class="ttdeci">int getTTId()</div><div class="ttdoc">Get the turntable ID.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:45</div></div>
<div class="ttc" id="aclassTurntableIndex_html_ace808391dae72b5eee99d999484cfe87"><div class="ttname"><a href="classTurntableIndex.html#ace808391dae72b5eee99d999484cfe87">TurntableIndex::getNextIndex</a></div><div class="ttdeci">TurntableIndex * getNextIndex()</div><div class="ttdoc">Get next TurntableIndex object.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:53</div></div>
<div class="ttc" id="aclassTurntableIndex_html_ae23cf2bd97435dcd280eea0659ce3780"><div class="ttname"><a href="classTurntableIndex.html#ae23cf2bd97435dcd280eea0659ce3780">TurntableIndex::getAngle</a></div><div class="ttdeci">int getAngle()</div><div class="ttdoc">Get angle of the index from home.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:49</div></div>
<div class="ttc" id="aclassTurntableIndex_html_af30c96c682e460d542610e632f40fab0"><div class="ttname"><a href="classTurntableIndex.html#af30c96c682e460d542610e632f40fab0">TurntableIndex::getId</a></div><div class="ttdeci">int getId()</div><div class="ttdoc">Get index ID (0 is always home)</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:47</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a2d3e9f8bd9bd7fd8051cdb2bdc981b26"><div class="ttname"><a href="classTurntableIndex.html#a2d3e9f8bd9bd7fd8051cdb2bdc981b26">TurntableIndex::TurntableIndex</a></div><div class="ttdeci">TurntableIndex(int ttId, int id, int angle, char *name)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:36</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a4ba2249037936f7b56af4c8188943202"><div class="ttname"><a href="classTurntableIndex.html#a4ba2249037936f7b56af4c8188943202">TurntableIndex::getName</a></div><div class="ttdeci">char * getName()</div><div class="ttdoc">Get index name.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:50</div></div>
<div class="ttc" id="aclassTurntableIndex_html_a703aa0c89761025fd6d401a34359bea2"><div class="ttname"><a href="classTurntableIndex.html#a703aa0c89761025fd6d401a34359bea2">TurntableIndex::getTTId</a></div><div class="ttdeci">int getTTId()</div><div class="ttdoc">Get the turntable ID.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:44</div></div>
<div class="ttc" id="aclassTurntableIndex_html_ace808391dae72b5eee99d999484cfe87"><div class="ttname"><a href="classTurntableIndex.html#ace808391dae72b5eee99d999484cfe87">TurntableIndex::getNextIndex</a></div><div class="ttdeci">TurntableIndex * getNextIndex()</div><div class="ttdoc">Get next TurntableIndex object.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:52</div></div>
<div class="ttc" id="aclassTurntableIndex_html_ae23cf2bd97435dcd280eea0659ce3780"><div class="ttname"><a href="classTurntableIndex.html#ae23cf2bd97435dcd280eea0659ce3780">TurntableIndex::getAngle</a></div><div class="ttdeci">int getAngle()</div><div class="ttdoc">Get angle of the index from home.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:48</div></div>
<div class="ttc" id="aclassTurntableIndex_html_af30c96c682e460d542610e632f40fab0"><div class="ttname"><a href="classTurntableIndex.html#af30c96c682e460d542610e632f40fab0">TurntableIndex::getId</a></div><div class="ttdeci">int getId()</div><div class="ttdoc">Get index ID (0 is always home)</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:46</div></div>
<div class="ttc" id="aclassTurntable_html"><div class="ttname"><a href="classTurntable.html">Turntable</a></div><div class="ttdoc">Class to contain and maintain the various Turntable attributes and methods.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.h:82</div></div>
<div class="ttc" id="aclassTurntable_html_a04d9bb1cf0f9962470295bece44741b5"><div class="ttname"><a href="classTurntable.html#a04d9bb1cf0f9962470295bece44741b5">Turntable::getNumberOfIndexes</a></div><div class="ttdeci">int getNumberOfIndexes()</div><div class="ttdoc">Get the number of indexes defined for the turntable.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:92</div></div>
<div class="ttc" id="aclassTurntable_html_a086860cd8b4074252a1ae5e135a64d09"><div class="ttname"><a href="classTurntable.html#a086860cd8b4074252a1ae5e135a64d09">Turntable::getIndexCount</a></div><div class="ttdeci">int getIndexCount()</div><div class="ttdoc">Get the count of indexes added to the index list (counted from the &lt;JP id&gt; command response)</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:104</div></div>
<div class="ttc" id="aclassTurntable_html_a0b7f8ac65048f7f6b30131adaa45dd6b"><div class="ttname"><a href="classTurntable.html#a0b7f8ac65048f7f6b30131adaa45dd6b">Turntable::Turntable</a></div><div class="ttdeci">Turntable(int id)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:59</div></div>
<div class="ttc" id="aclassTurntable_html_a0b7f8ac65048f7f6b30131adaa45dd6b"><div class="ttname"><a href="classTurntable.html#a0b7f8ac65048f7f6b30131adaa45dd6b">Turntable::Turntable</a></div><div class="ttdeci">Turntable(int id)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:58</div></div>
<div class="ttc" id="aclassTurntable_html_a0c53f08796cb2e2fbb9d516f86d6e53d"><div class="ttname"><a href="classTurntable.html#a0c53f08796cb2e2fbb9d516f86d6e53d">Turntable::getFirst</a></div><div class="ttdeci">static Turntable * getFirst()</div><div class="ttdoc">Get the first turntable object.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:106</div></div>
<div class="ttc" id="aclassTurntable_html_a3e15940499290b9f56b3783e844b8470"><div class="ttname"><a href="classTurntable.html#a3e15940499290b9f56b3783e844b8470">Turntable::setNumberOfIndexes</a></div><div class="ttdeci">void setNumberOfIndexes(int numberOfIndexes)</div><div class="ttdoc">Set the number of indexes the turntable has defined (from the &lt;JT id&gt; command response)</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:90</div></div>
<div class="ttc" id="aclassTurntable_html_a447c8554fa9ffb6419c18896ab8c6bd4"><div class="ttname"><a href="classTurntable.html#a447c8554fa9ffb6419c18896ab8c6bd4">Turntable::getCount</a></div><div class="ttdeci">int getCount()</div><div class="ttdoc">Get the number of turntables.</div><div class="ttdef"><b>Definition:</b> DCCEXTurntables.cpp:102</div></div>
Expand Down
5 changes: 4 additions & 1 deletion _sources/usage.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Once the `DCCEXProtocol` object is instantiated, a connection must be made to th

It is also recommended to enable logging to an Arduino Stream using the `setLogStream(&stream)` method.

For WiFi clients, long periods of no interactive commands being sent may cause the WiFi client to be disconnected, so it is recommended to enable heartbeats for these, which defaults to sending a heartbeat every 60 seconds. If commands are sent regularly, no heartbeats are sent.

An example using an ESP32 with WiFi to connect to EX-CommandStation, with logging to the serial console:

.. code-block:: cpp
Expand All @@ -34,6 +36,7 @@ An example using an ESP32 with WiFi to connect to EX-CommandStation, with loggin
while(1) delay(1000);
}
dccexProtocol.setLogStream(&Serial);
dccexProtocol.enableHeartbeat();
dccexProtocol.connect(&client);
}
Expand Down Expand Up @@ -100,7 +103,7 @@ All objects are contained within linked lists and can be access via for loops:
// route methods are available here
}
for (Turntable* turntable=dccexProtocol.roster->getFirst(); turntable; turntable=turntable->getNext()) {
for (Turntable* turntable=dccexProtocol.turntables->getFirst(); turntable; turntable=turntable->getNext()) {
// turntable methods are available here
for (TurntableIndex* ttIndex=turntable->getFirstIndex(); ttIndex; ttIndex=ttIndex->getNextIndex()) {
// turntable index methods are available here
Expand Down
5 changes: 5 additions & 0 deletions bugs-requests.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocolD0Ev"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::~DCCEXProtocol()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol11setDelegateEP21DCCEXProtocolDelegate"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::setDelegate()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol12setLogStreamEP6Stream"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::setLogStream()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol15enableHeartbeatEm"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::enableHeartbeat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol7connectEP6Stream"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::connect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol10disconnectEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::disconnect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol5checkEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::check()</span></code></a></li>
Expand Down Expand Up @@ -203,6 +204,7 @@
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol25_processServerDescriptionEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_processServerDescription()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol15_processMessageEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_processMessage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol20_processScreenUpdateEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_processScreenUpdate()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol14_sendHeartbeatEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_sendHeartbeat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol21_processLocoBroadcastEv"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_processLocoBroadcast()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol20_getValidFunctionMapEi"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_getValidFunctionMap()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol22_getSpeedFromSpeedByteEi"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_getSpeedFromSpeedByte()</span></code></a></li>
Expand Down Expand Up @@ -261,6 +263,9 @@
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol18_receivedRouteListE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_receivedRouteList</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol23_turntableListRequestedE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_turntableListRequested</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol22_receivedTurntableListE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_receivedTurntableList</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol16_enableHeartbeatE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_enableHeartbeat</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol15_heartbeatDelayE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_heartbeatDelay</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="library.html#_CPPv4N13DCCEXProtocol14_lastHeartbeatE"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocol::_lastHeartbeat</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="library.html#_CPPv421DCCEXProtocolDelegate"><code class="docutils literal notranslate"><span class="pre">DCCEXProtocolDelegate</span></code></a><ul>
Expand Down
Loading

0 comments on commit 9899fd1

Please sign in to comment.