Skip to content

Commit

Permalink
Deploying to gh-pages from @ b475178 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@peteGSX
peteGSX committed Apr 27, 2024
1 parent 22c0d53 commit 0c85b85
Show file tree
Hide file tree
Showing 13 changed files with 32 additions and 8 deletions.
9 changes: 8 additions & 1 deletion _sources/examples.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,17 @@ For example, when setting the speed based on the position of a rotary encoder, s
This ensures that the user of the throttle sees the accurate results of what the throttle is doing, and provides validation that the EX-CommandStation is responding to the user input.

DCCEXProtocol_Track_type
------------------------------------
------------------------

This example demonstrates how client throttle software can change the Track type of any track/channel. (MAIN\|PROG\|DC\|DCX\|NONE)

DCCEXProtocol_Serial
--------------------

This example demonstrates how to connect to an |EX-CS| using a serial based throttle, using a dedicated serial port for the connection in addition to the standard USB serial port.

This has been tested using an Arduino Mega2560, with the default USB port as the console/output serial port, and the second serial port "Serial1" as the |EX-CS| connection.

----

Additional Examples
Expand Down
1 change: 1 addition & 0 deletions bugs-requests.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions contribute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
19 changes: 13 additions & 6 deletions examples.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down Expand Up @@ -514,10 +515,11 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
<li><p><a class="reference internal" href="#dccexprotocol-turnout-control" id="id6">DCCEXProtocol_Turnout_control</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-multi-throttle-control" id="id7">DCCEXProtocol_Multi_Throttle_Control</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-track-type" id="id8">DCCEXProtocol_Track_type</a></p></li>
<li><p><a class="reference internal" href="#additional-examples" id="id9">Additional Examples</a></p>
<li><p><a class="reference internal" href="#dccexprotocol-serial" id="id9">DCCEXProtocol_Serial</a></p></li>
<li><p><a class="reference internal" href="#additional-examples" id="id10">Additional Examples</a></p>
<ul>
<li><p><a class="reference internal" href="#dccexprotocol-ssid" id="id10">DCCEXProtocol_SSID</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-mdns" id="id11">DCCEXProtocol_mDNS</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-ssid" id="id11">DCCEXProtocol_SSID</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-mdns" id="id12">DCCEXProtocol_mDNS</a></p></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -568,16 +570,21 @@ <h2><a class="toc-backref" href="#id7" role="doc-backlink">DCCEXProtocol_Multi_T
<h2><a class="toc-backref" href="#id8" role="doc-backlink">DCCEXProtocol_Track_type</a><a class="headerlink" href="#dccexprotocol-track-type" title="Link to this heading"></a></h2>
<p>This example demonstrates how client throttle software can change the Track type of any track/channel. (MAIN|PROG|DC|DCX|NONE)</p>
</section>
<section id="dccexprotocol-serial">
<h2><a class="toc-backref" href="#id9" role="doc-backlink">DCCEXProtocol_Serial</a><a class="headerlink" href="#dccexprotocol-serial" title="Link to this heading"></a></h2>
<p>This example demonstrates how to connect to an <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a> using a serial based throttle, using a dedicated serial port for the connection in addition to the standard USB serial port.</p>
<p>This has been tested using an Arduino Mega2560, with the default USB port as the console/output serial port, and the second serial port “Serial1” as the <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a> connection.</p>
</section>
<hr class="docutils" />
<section id="additional-examples">
<h2><a class="toc-backref" href="#id9" role="doc-backlink">Additional Examples</a><a class="headerlink" href="#additional-examples" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Additional Examples</a><a class="headerlink" href="#additional-examples" title="Link to this heading"></a></h2>
<p>The following examples are not strictly related to the <span class="ex-prefix">DCCEX</span><span class="ex-suffix">Protocol library</span>, but hopefully will be useful for anyone developing a throttle to use with any <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a>.</p>
<section id="dccexprotocol-ssid">
<h3><a class="toc-backref" href="#id10" role="doc-backlink">DCCEXProtocol_SSID</a><a class="headerlink" href="#dccexprotocol-ssid" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id11" role="doc-backlink">DCCEXProtocol_SSID</a><a class="headerlink" href="#dccexprotocol-ssid" title="Link to this heading"></a></h3>
<p>This example demonstrates how client throttle software may be written to find all the SSIDs (networks) that are available.</p>
</section>
<section id="dccexprotocol-mdns">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">DCCEXProtocol_mDNS</a><a class="headerlink" href="#dccexprotocol-mdns" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id12" role="doc-backlink">DCCEXProtocol_mDNS</a><a class="headerlink" href="#dccexprotocol-mdns" title="Link to this heading"></a></h3>
<p>This example demonstrates how client throttle software may be written to find all the <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a> and WiThrottle servers that are advertising via mDNS.</p>
<p>Note that <a href="https://dcc-ex.com/"><span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span></a> <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a> only advertise as <code class="docutils literal notranslate"><span class="pre">wiThrottle</span></code> servers, but will use and respond with either the <strong>WiThrottle protocol</strong> or the <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span>
<span class="ex-suffix"> native command protocol</span> depending the type of command it first receives from the client (throttle).</p>
Expand Down
1 change: 1 addition & 0 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions include/include.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
<li class="toctree-l2"><a class="reference internal" href="../examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="../examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions library.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions site-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down
1 change: 1 addition & 0 deletions usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-turnout-control">DCCEXProtocol_Turnout_control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-multi-throttle-control">DCCEXProtocol_Multi_Throttle_Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-track-type">DCCEXProtocol_Track_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dccexprotocol-serial">DCCEXProtocol_Serial</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#additional-examples">Additional Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-ssid">DCCEXProtocol_SSID</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples.html#dccexprotocol-mdns">DCCEXProtocol_mDNS</a></li>
Expand Down

0 comments on commit 0c85b85

Please sign in to comment.