Skip to content

Commit

Permalink
Deploying to gh-pages from @ 0731bf7 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
flash62au committed Dec 7, 2023
1 parent 52d3e05 commit e90999a
Show file tree
Hide file tree
Showing 17 changed files with 39 additions and 29 deletions.
2 changes: 1 addition & 1 deletion _sources/examples.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,5 @@ 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-NP| 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-NCP| depending the type of command it first receives from the client (throttle).

13 changes: 11 additions & 2 deletions _sources/include/include.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,23 @@

<span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span>
..
.. |EX-NCL| raw:: html

<span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span>
<span class="ex-suffix">Native command protocol library</span>
..
.. |EX-P| raw:: html

<span class="ex-prefix">DCCEX</span><span class="ex-suffix">Protocol</span>
..
.. |EX-PL| raw:: html

<span class="ex-prefix">DCCEX</span><span class="ex-suffix">Protocol library</span>
..
.. |EX-NP| raw:: html
.. |EX-NCP| raw:: html

<span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span>
<span class="ex-suffix"> native protocol</span>
<span class="ex-suffix"> native command protocol</span>
..
.. |br| raw:: html

Expand Down
8 changes: 4 additions & 4 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. include:: /include/include.rst

Documentation for the DCC-EX Native command library - DCCEXProtocol
===================================================================
Documentation for the DCC-EX Native command protocol library - DCCEXProtocol
============================================================================

.. toctree::
:maxdepth: 4
:hidden:

DCC-EX Native command library <self>
DCC-EX Native command protocol library <self>
overview
usage
examples
Expand All @@ -19,7 +19,7 @@ Documentation for the DCC-EX Native command library - DCCEXProtocol
DCC-EX Native command protocol library
--------------------------------------

This library implements the **DCC-EX** Native command protocol (as used in the |DCC-EX| |EX-CS| ONLY), allowing a device to connect to the server and act as a client (such as a hardware based throttle).
This library implements the |EX-NCP| (as used in the |DCC-EX| |EX-CS| ONLY), allowing a device to connect to the server and act as a client (such as a hardware based throttle).

The implementation of this library is tested on ESP32 based devices running the Arduino framework. There's nothing in here that's specific to the ESP32, and little of Arduino that couldn't be replaced as needed.

Expand Down
2 changes: 1 addition & 1 deletion _sources/overview.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ First of all, this library implements the DCC-EX Native protocol in a non-blocki

Then, you call the ```check()``` method as often as you can (ideally, once per invocation of the ```loop()``` method) and the library will manage the I/O stream, reading in/parsing commands and calling methods on the delegate as information is available.

These patterns (Dependency Injection and Delegation) allow you to keep the different parts of your sketch from becoming too intertwined with each other. Nothing in the code that manages the pushbuttons or speed knobs needs to have any detailed knowledge of the |EX-NP|.
These patterns (Dependency Injection and Delegation) allow you to keep the different parts of your sketch from becoming too intertwined with each other. Nothing in the code that manages the pushbuttons or speed knobs needs to have any detailed knowledge of the |EX-NCP|.

DCCEXProtocol Class
-------------------
Expand Down
2 changes: 1 addition & 1 deletion bugs-requests.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
2 changes: 1 addition & 1 deletion contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
4 changes: 2 additions & 2 deletions examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down Expand Up @@ -563,7 +563,7 @@ <h3><a class="toc-backref" href="#id9" role="doc-backlink">DCCEXProtocol_SSID</a
<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="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>
<span class="ex-suffix"> native command protocol</span> depending the type of command it first receives from the client (throttle).</p>
</section>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
2 changes: 1 addition & 1 deletion include/include.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
13 changes: 7 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta content="DCC-EX DCC DCC++ EX DCC++EX" name="keywords" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation for the DCC-EX Native command library - DCCEXProtocol &mdash; DCCEXProtocol documentation</title>
<title>Documentation for the DCC-EX Native command protocol library - DCCEXProtocol &mdash; DCCEXProtocol documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/dccex_theme.css?v=2e0e464c" />
Expand Down Expand Up @@ -54,7 +54,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">DCC-EX Native command library</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down Expand Up @@ -477,7 +477,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Documentation for the DCC-EX Native command library - DCCEXProtocol</li>
<li class="breadcrumb-item active">Documentation for the DCC-EX Native command protocol library - DCCEXProtocol</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/DCC-EX/dccexprotocol/blob/sphinx/docs/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
Expand All @@ -487,13 +487,14 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="documentation-for-the-dcc-ex-native-command-library-dccexprotocol">
<h1>Documentation for the DCC-EX Native command library - DCCEXProtocol<a class="headerlink" href="#documentation-for-the-dcc-ex-native-command-library-dccexprotocol" title="Link to this heading"></a></h1>
<section id="documentation-for-the-dcc-ex-native-command-protocol-library-dccexprotocol">
<h1>Documentation for the DCC-EX Native command protocol library - DCCEXProtocol<a class="headerlink" href="#documentation-for-the-dcc-ex-native-command-protocol-library-dccexprotocol" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
</div>
<section id="dcc-ex-native-command-protocol-library">
<h2>DCC-EX Native command protocol library<a class="headerlink" href="#dcc-ex-native-command-protocol-library" title="Link to this heading"></a></h2>
<p>This library implements the <strong>DCC-EX</strong> Native command protocol (as used in the <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), allowing a device to connect to the server and act as a client (such as a hardware based throttle).</p>
<p>This library implements the <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span>
<span class="ex-suffix"> native command protocol</span> (as used in the <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), allowing a device to connect to the server and act as a client (such as a hardware based throttle).</p>
<p>The implementation of this library is tested on ESP32 based devices running the Arduino framework. There’s nothing in here that’s specific to the ESP32, and little of Arduino that couldn’t be replaced as needed.</p>
<p>There has also been limited testing on STM32F103C8 Bluepill with a serial connection.</p>
</section>
Expand Down
2 changes: 1 addition & 1 deletion library.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
Binary file modified objects.inv
Binary file not shown.
8 changes: 4 additions & 4 deletions overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Usage" href="usage.html" />
<link rel="prev" title="Documentation for the DCC-EX Native command library - DCCEXProtocol" href="index.html" />
<link rel="prev" title="Documentation for the DCC-EX Native command protocol library - DCCEXProtocol" href="index.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -55,7 +55,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down Expand Up @@ -502,7 +502,7 @@ <h1>Library Design Principles<a class="headerlink" href="#library-design-princip
<p>First of all, this library implements the DCC-EX Native protocol in a non-blocking fashion. After creating a DCCEXProtocol object, you set up various necessities such as the network connection and a debug console.</p>
<p>Then, you call the <code class="docutils literal notranslate"><span class="pre">`check()`</span></code> method as often as you can (ideally, once per invocation of the <code class="docutils literal notranslate"><span class="pre">`loop()`</span></code> method) and the library will manage the I/O stream, reading in/parsing commands and calling methods on the delegate as information is available.</p>
<p>These patterns (Dependency Injection and Delegation) allow you to keep the different parts of your sketch from becoming too intertwined with each other. Nothing in the code that manages the pushbuttons or speed knobs needs to have any detailed knowledge of the <span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span>
<span class="ex-suffix"> native protocol</span>.</p>
<span class="ex-suffix"> native command protocol</span>.</p>
<section id="dccexprotocol-class">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">DCCEXProtocol Class</a><a class="headerlink" href="#dccexprotocol-class" title="Link to this heading"></a></h2>
<p>The <cite>DCCEXProtocol</cite> class manages all relevant objects advertised by a <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> and exposes simple methods to control these objects from the client software.</p>
Expand All @@ -526,7 +526,7 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">DCCEXProtocolDelegate
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Documentation for the DCC-EX Native command library - DCCEXProtocol" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="index.html" class="btn btn-neutral float-left" title="Documentation for the DCC-EX Native command protocol library - DCCEXProtocol" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion site-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down
2 changes: 1 addition & 1 deletion usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command library</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">DCC-EX Native command protocol library</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Library Design Principles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocol-class">DCCEXProtocol Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#dccexprotocoldelegate-class">DCCEXProtocolDelegate Class</a></li>
Expand Down

0 comments on commit e90999a

Please sign in to comment.