Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1085cb5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
flash62au committed Dec 7, 2023
1 parent d9337a9 commit 2d4447d
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 7 deletions.
10 changes: 8 additions & 2 deletions _sources/examples.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This example demonstrates the basics of creating a WiFi connection to your |EX-C
DCCEXProtocol_Delegate
----------------------

This example builds on the basic example and, in addition, demonstrates how to implement a custom DCCEXProtocolDelegate class to respond to broadcasts and command responses received from |EX-CS|.
This example builds on the basic example and, in addition, demonstrates how to implement a custom `DCCEXProtocolDelegate`` class to respond to broadcasts and command responses received from |EX-CS|.

DCCEXProtocol_Roster_etc
------------------------
Expand Down Expand Up @@ -72,10 +72,16 @@ Additional Examples

The following examples are not strictly related to the |EX-PL|, but hopefully will be useful for anyone developing a throttle to use with any |EX-CS|.

DCCEXProtocol_SSID
~~~~~~~~~~~~~~~~~~

This example demonstrates how client throttle software may be written to find all the SSIDs (networks) that are available.


DCCEXProtocol_mDNS
~~~~~~~~~~~~~~~~~~

This example demonstrates how client throttle software may be written to find all the |EX-CS| and WiThrottle servers that are advertising via mDNS.

Note that |DCC-EX| |EX-CS| only advertise as ``wiThrottle`` servers, but will use and respond with either the **WiThrottle protocol** or the |EX-PL| depending the type of command it first receives from the client (throttle).
Note that |DCC-EX| |EX-CS| only advertise as ``wiThrottle`` servers, but will use and respond with either the **WiThrottle protocol** or the |EX-NP| depending the type of command it first receives from the client (throttle).

1 change: 1 addition & 0 deletions documentation.html
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#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>
</ul>
</li>
Expand Down
15 changes: 11 additions & 4 deletions examples.html
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="#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>
</ul>
</li>
Expand Down Expand Up @@ -497,7 +498,8 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
<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="#additional-examples" id="id8">Additional Examples</a></p>
<ul>
<li><p><a class="reference internal" href="#dccexprotocol-mdns" id="id9">DCCEXProtocol_mDNS</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-ssid" id="id9">DCCEXProtocol_SSID</a></p></li>
<li><p><a class="reference internal" href="#dccexprotocol-mdns" id="id10">DCCEXProtocol_mDNS</a></p></li>
</ul>
</li>
</ul>
Expand All @@ -518,7 +520,7 @@ <h2><a class="toc-backref" href="#id1" role="doc-backlink">DCCEXProtocol_Basic</
</section>
<section id="dccexprotocol-delegate">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">DCCEXProtocol_Delegate</a><a class="headerlink" href="#dccexprotocol-delegate" title="Link to this heading"></a></h2>
<p>This example builds on the basic example and, in addition, demonstrates how to implement a custom DCCEXProtocolDelegate class to respond to broadcasts and command responses received from <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span>.</p>
<p>This example builds on the basic example and, in addition, demonstrates how to implement a custom <cite>DCCEXProtocolDelegate`</cite> class to respond to broadcasts and command responses received from <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span>.</p>
</section>
<section id="dccexprotocol-roster-etc">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">DCCEXProtocol_Roster_etc</a><a class="headerlink" href="#dccexprotocol-roster-etc" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -548,10 +550,15 @@ <h2><a class="toc-backref" href="#id7" role="doc-backlink">DCCEXProtocol_Multi_T
<section id="additional-examples">
<h2><a class="toc-backref" href="#id8" 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 <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span>.</p>
<section id="dccexprotocol-ssid">
<h3><a class="toc-backref" href="#id9" 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="#id9" 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="#id10" 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 <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span> and WiThrottle servers that are advertising via mDNS.</p>
<p>Note that <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span> <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span> 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="ex-prefix">DCCEX</span><span class="ex-suffix">Protocol library</span> depending the type of command it first receives from the client (throttle).</p>
<p>Note that <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span> <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span> 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 protocol</span> depending the type of command it first receives from the client (throttle).</p>
</section>
</section>
</section>
Expand Down
1 change: 1 addition & 0 deletions genindex.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions include/include.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions index.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions library.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions overview.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions search.html
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#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>
</ul>
</li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions site-index.html
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#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>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions usage.html
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#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>
</ul>
</li>
Expand Down

0 comments on commit 2d4447d

Please sign in to comment.