Deploying to gh-pages from @ 763e0ff 🚀

_sources/ex-rail/EX-RAIL-command-reference.rst.txt

@@ -790,8 +790,8 @@ Also refer to :ref:`ex-turntable/test-and-tune:ex-rail automation`.
 
 |hr-dashed|
 
-``MOVETT( id, steps, activity )`` - Move the specified |EX-TT| to the provided step position and perform the specified activity
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``MOVETT( vpin, steps, activity )`` - Move the specified |EX-TT| to the provided step position and perform the specified activity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
   |NEW-IN-V5| Move the specified |EX-TT| to the provided step position and perform the specified activity
 
@@ -801,15 +801,15 @@ Also refer to :ref:`ex-turntable/test-and-tune:ex-rail automation`.
 
 |hr-dashed|
 
-``IFRE ( id, value )`` - Test if a rotary encoder has been set to the specified value
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``IFRE ( vpin, value )`` - Test if a rotary encoder has been set to the specified value
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
   |NEW-IN-V5| Test if a rotary encoder has been set to the specified value
 
 |hr-dashed|
 
-``ONCHANGE( id )`` - Detects a rotary encoder has changed position
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``ONCHANGE( vpin )`` - Detects a rotary encoder has changed position
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
   |NEW-IN-V5| Detects a rotary encoder has changed position
 
@@ -858,18 +858,29 @@ To fully define a turntable/traverser object, you need to define the object firs
 
 |hr-dashed|
 
-``EXTT_TURNTABLE( id, vpin, i2c_address, home, [, "description"] )`` - Define an EX-Turntable turntable/traverser
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``EXTT_TURNTABLE( id, vpin, home, [, "description"] )`` - Define an EX-Turntable turntable/traverser
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+  Define an EX-Turntable turntable/traverser at the specified **id** and **vpin** with a **home** angle.
 
-  Define an EX-Turntable turntable/traverser at the specified **id**, **vpin**, and **i2c_address**, with a **home** angle.
+  This statement will create the |EX-TT| turntable/traverser object only, so you will need a separate ``HAL()`` statement for an |EX-TT| device to create the HAL device. It is not recommended to create it via "myHal.cpp".
 
-  This statement will both create the |EX-TT| device as well as the turntable/traverser object, so you do not need a separate ``HAL()`` statement for an |EX-TT| device, nor do you need to create it via "myHal.cpp".
+  The HAL creation will require the **vpin** and **i2c_address** parameters.
+
+  Where:
 
   - id - the id of the turntable/traverser, valid IDs are 1 - 32767
   - vpin - the id of the vpin where the |EX-TT| device is located
   - i2c_address - the |I2C| address of the |EX-TT| device
   - angle - the angle of the home position, valid angles are 0 - 3600
 
+  Example creation and definition:
+
+  .. code-block:: 
+
+    HAL(EXTurntable,600,1,0x60)            // Create your EX-Turntable device driver
+    EXTT_TURNTABLE(1,600,45,"My EX-Turntable")  // Create your EX-Turntable object to enable control
+
 |hr-dashed|
 
 ``TT_ADDPOSITION( turntable_id, position_id, value, angle [, "description"] )`` - Add a turntable position

_sources/ex-turntable/test-and-tune.rst.txt

@@ -87,7 +87,7 @@ Development version commands
 
 |NOT-IN-PROD-VERSION|
 
-For users keeping up with the |EX-CS| development releases, version 5.1.5 introduced a new turntable/traverser object, allowing for similar definition and control to that of turnouts/points.
+For users keeping up with the |EX-CS| development releases, version 5.1.16 introduced a new turntable/traverser object, allowing for similar definition and control to that of turnouts/points.
 
 The existing methods of control for |EX-TT| using the native ``<D TT ...>`` command and ``MOVETT()`` |EX-R| command remain as-is, however there are now more complete methods of definition and control available.
 
@@ -505,7 +505,7 @@ NEW - Development version control of EX-Turntable
 
 |NOT-IN-PROD-VERSION|
 
-As mentioned previously, for users of the development version of |EX-CS|, version 5.1.5 introduces a new turntable object that can be used to define and control |EX-TT|.
+As mentioned previously, for users of the development version of |EX-CS|, version 5.1.16 introduces a new turntable object that can be used to define and control |EX-TT|.
 
 Here are some examples for defining a turntable as per the examples above, but using the new turntable object in both native commands, and |EX-R|.
 
@@ -552,7 +552,8 @@ To define our turntable as above but in |EX-R|, it looks like this:
 
 .. code-block:: 
 
-  EXTT_TURNTABLE(600,600,0x60,0,"My EX-Turntable")
+  HAL(EXTurntable,600,1,0x60)
+  EXTT_TURNTABLE(1,600,0,"My EX-Turntable")
   TT_ADDPOSITION(600,1,114,0,"Roundhouse stall 1")
   TT_ADDPOSITION(600,2,227,0,"Roundhouse stall 2")
   TT_ADDPOSITION(600,3,341,0,"Roundhouse stall 3")

ex-rail/EX-RAIL-command-reference.html

@@ -1366,12 +1366,12 @@ <h3><a class="toc-backref" href="#id31" role="doc-backlink">Turntable/Traverser
 <nav class="contents in-this-section local" id="id5">
 <p class="topic-title">In This Section</p>
 <ul class="simple">
-<li><p><a class="reference internal" href="#movett-id-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity" id="id98"><code class="docutils literal notranslate"><span class="pre">MOVETT(</span> <span class="pre">id,</span> <span class="pre">steps,</span> <span class="pre">activity</span> <span class="pre">)</span></code> - Move the specified <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> to the provided step position and perform the specified activity</a></p></li>
-<li><p><a class="reference internal" href="#ifre-id-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value" id="id99"><code class="docutils literal notranslate"><span class="pre">IFRE</span> <span class="pre">(</span> <span class="pre">id,</span> <span class="pre">value</span> <span class="pre">)</span></code> - Test if a rotary encoder has been set to the specified value</a></p></li>
-<li><p><a class="reference internal" href="#onchange-id-detects-a-rotary-encoder-has-changed-position" id="id100"><code class="docutils literal notranslate"><span class="pre">ONCHANGE(</span> <span class="pre">id</span> <span class="pre">)</span></code> - Detects a rotary encoder has changed position</a></p></li>
+<li><p><a class="reference internal" href="#movett-vpin-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity" id="id98"><code class="docutils literal notranslate"><span class="pre">MOVETT(</span> <span class="pre">vpin,</span> <span class="pre">steps,</span> <span class="pre">activity</span> <span class="pre">)</span></code> - Move the specified <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> to the provided step position and perform the specified activity</a></p></li>
+<li><p><a class="reference internal" href="#ifre-vpin-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value" id="id99"><code class="docutils literal notranslate"><span class="pre">IFRE</span> <span class="pre">(</span> <span class="pre">vpin,</span> <span class="pre">value</span> <span class="pre">)</span></code> - Test if a rotary encoder has been set to the specified value</a></p></li>
+<li><p><a class="reference internal" href="#onchange-vpin-detects-a-rotary-encoder-has-changed-position" id="id100"><code class="docutils literal notranslate"><span class="pre">ONCHANGE(</span> <span class="pre">vpin</span> <span class="pre">)</span></code> - Detects a rotary encoder has changed position</a></p></li>
 <li><p><a class="reference internal" href="#turntable-development-features-not-in-the-current-production-version" id="id101">Turntable development features not in the current production version</a></p></li>
 <li><p><a class="reference internal" href="#dcc-turntable-id-home-description-define-a-dcc-accessory-turntable-traverser" id="id102"><code class="docutils literal notranslate"><span class="pre">DCC_TURNTABLE(</span> <span class="pre">id,</span> <span class="pre">home,</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Define a DCC accessory turntable/traverser</a></p></li>
-<li><p><a class="reference internal" href="#extt-turntable-id-vpin-i2c-address-home-description-define-an-ex-turntable-turntable-traverser" id="id103"><code class="docutils literal notranslate"><span class="pre">EXTT_TURNTABLE(</span> <span class="pre">id,</span> <span class="pre">vpin,</span> <span class="pre">i2c_address,</span> <span class="pre">home,</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Define an EX-Turntable turntable/traverser</a></p></li>
+<li><p><a class="reference internal" href="#extt-turntable-id-vpin-home-description-define-an-ex-turntable-turntable-traverser" id="id103"><code class="docutils literal notranslate"><span class="pre">EXTT_TURNTABLE(</span> <span class="pre">id,</span> <span class="pre">vpin,</span> <span class="pre">home,</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Define an EX-Turntable turntable/traverser</a></p></li>
 <li><p><a class="reference internal" href="#tt-addposition-turntable-id-position-id-value-angle-description-add-a-turntable-position" id="id104"><code class="docutils literal notranslate"><span class="pre">TT_ADDPOSITION(</span> <span class="pre">turntable_id,</span> <span class="pre">position_id,</span> <span class="pre">value,</span> <span class="pre">angle</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Add a turntable position</a></p></li>
 <li><p><a class="reference internal" href="#if-ttposition-id-position-test-if-turntable-traverser-is-at-a-position" id="id105"><code class="docutils literal notranslate"><span class="pre">IF_TTPOSITION(</span> <span class="pre">id,</span> <span class="pre">position</span> <span class="pre">)</span></code> - Test if turntable/traverser is at a position</a></p></li>
 <li><p><a class="reference internal" href="#onrotate-id-event-handler-for-when-a-turntable-traverser-is-rotated" id="id106"><code class="docutils literal notranslate"><span class="pre">ONROTATE(</span> <span class="pre">id</span> <span class="pre">)</span></code> - Event handler for when a turntable/traverser is rotated</a></p></li>
@@ -1383,8 +1383,8 @@ <h3><a class="toc-backref" href="#id31" role="doc-backlink">Turntable/Traverser
 <p><a class="reference external" href="../news/posts/20230807.html"><img alt="EX-MotorShield8874" class="image-min-width-144" src="../_images/new_in_version_5.png" style="width: 240.0px; height: 48.0px;" /></a></p>
 <p>Also refer to <a class="reference internal" href="../ex-turntable/test-and-tune.html#ex-rail-automation"><span class="std std-ref">EX-RAIL automation</span></a>.</p>
 <p><hr class="hr-dashed" /></p>
-<section id="movett-id-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity">
-<h4><a class="toc-backref" href="#id98" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">MOVETT(</span> <span class="pre">id,</span> <span class="pre">steps,</span> <span class="pre">activity</span> <span class="pre">)</span></code> - Move the specified <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> to the provided step position and perform the specified activity</a><a class="headerlink" href="#movett-id-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity" title="Permalink to this heading"></a></h4>
+<section id="movett-vpin-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity">
+<h4><a class="toc-backref" href="#id98" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">MOVETT(</span> <span class="pre">vpin,</span> <span class="pre">steps,</span> <span class="pre">activity</span> <span class="pre">)</span></code> - Move the specified <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> to the provided step position and perform the specified activity</a><a class="headerlink" href="#movett-vpin-steps-activity-move-the-specified-ex-tt-to-the-provided-step-position-and-perform-the-specified-activity" title="Permalink to this heading"></a></h4>
 <blockquote>
 <div><p><span class="new-in-v5">New in version 5 </span> Move the specified <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> to the provided step position and perform the specified activity</p>
 <div class="admonition note">
@@ -1394,15 +1394,15 @@ <h4><a class="toc-backref" href="#id98" role="doc-backlink"><code class="docutil
 </div></blockquote>
 <p><hr class="hr-dashed" /></p>
 </section>
-<section id="ifre-id-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value">
-<h4><a class="toc-backref" href="#id99" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">IFRE</span> <span class="pre">(</span> <span class="pre">id,</span> <span class="pre">value</span> <span class="pre">)</span></code> - Test if a rotary encoder has been set to the specified value</a><a class="headerlink" href="#ifre-id-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value" title="Permalink to this heading"></a></h4>
+<section id="ifre-vpin-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value">
+<h4><a class="toc-backref" href="#id99" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">IFRE</span> <span class="pre">(</span> <span class="pre">vpin,</span> <span class="pre">value</span> <span class="pre">)</span></code> - Test if a rotary encoder has been set to the specified value</a><a class="headerlink" href="#ifre-vpin-value-test-if-a-rotary-encoder-has-been-set-to-the-specified-value" title="Permalink to this heading"></a></h4>
 <blockquote>
 <div><p><span class="new-in-v5">New in version 5 </span> Test if a rotary encoder has been set to the specified value</p>
 </div></blockquote>
 <p><hr class="hr-dashed" /></p>
 </section>
-<section id="onchange-id-detects-a-rotary-encoder-has-changed-position">
-<h4><a class="toc-backref" href="#id100" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">ONCHANGE(</span> <span class="pre">id</span> <span class="pre">)</span></code> - Detects a rotary encoder has changed position</a><a class="headerlink" href="#onchange-id-detects-a-rotary-encoder-has-changed-position" title="Permalink to this heading"></a></h4>
+<section id="onchange-vpin-detects-a-rotary-encoder-has-changed-position">
+<h4><a class="toc-backref" href="#id100" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">ONCHANGE(</span> <span class="pre">vpin</span> <span class="pre">)</span></code> - Detects a rotary encoder has changed position</a><a class="headerlink" href="#onchange-vpin-detects-a-rotary-encoder-has-changed-position" title="Permalink to this heading"></a></h4>
 <blockquote>
 <div><p><span class="new-in-v5">New in version 5 </span> Detects a rotary encoder has changed position</p>
 <details class="summary-for-example-click-to-show">
@@ -1439,17 +1439,24 @@ <h4><a class="toc-backref" href="#id102" role="doc-backlink"><code class="docuti
 </div></blockquote>
 <p><hr class="hr-dashed" /></p>
 </section>
-<section id="extt-turntable-id-vpin-i2c-address-home-description-define-an-ex-turntable-turntable-traverser">
-<h4><a class="toc-backref" href="#id103" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">EXTT_TURNTABLE(</span> <span class="pre">id,</span> <span class="pre">vpin,</span> <span class="pre">i2c_address,</span> <span class="pre">home,</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Define an EX-Turntable turntable/traverser</a><a class="headerlink" href="#extt-turntable-id-vpin-i2c-address-home-description-define-an-ex-turntable-turntable-traverser" title="Permalink to this heading"></a></h4>
+<section id="extt-turntable-id-vpin-home-description-define-an-ex-turntable-turntable-traverser">
+<h4><a class="toc-backref" href="#id103" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">EXTT_TURNTABLE(</span> <span class="pre">id,</span> <span class="pre">vpin,</span> <span class="pre">home,</span> <span class="pre">[,</span> <span class="pre">&quot;description&quot;]</span> <span class="pre">)</span></code> - Define an EX-Turntable turntable/traverser</a><a class="headerlink" href="#extt-turntable-id-vpin-home-description-define-an-ex-turntable-turntable-traverser" title="Permalink to this heading"></a></h4>
 <blockquote>
-<div><p>Define an EX-Turntable turntable/traverser at the specified <strong>id</strong>, <strong>vpin</strong>, and <strong>i2c_address</strong>, with a <strong>home</strong> angle.</p>
-<p>This statement will both create the <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> device as well as the turntable/traverser object, so you do not need a separate <code class="docutils literal notranslate"><span class="pre">HAL()</span></code> statement for an <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> device, nor do you need to create it via “myHal.cpp”.</p>
+<div><p>Define an EX-Turntable turntable/traverser at the specified <strong>id</strong> and <strong>vpin</strong> with a <strong>home</strong> angle.</p>
+<p>This statement will create the <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> turntable/traverser object only, so you will need a separate <code class="docutils literal notranslate"><span class="pre">HAL()</span></code> statement for an <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> device to create the HAL device. It is not recommended to create it via “myHal.cpp”.</p>
+<p>The HAL creation will require the <strong>vpin</strong> and <strong>i2c_address</strong> parameters.</p>
+<p>Where:</p>
 <ul class="simple">
 <li><p>id - the id of the turntable/traverser, valid IDs are 1 - 32767</p></li>
 <li><p>vpin - the id of the vpin where the <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> device is located</p></li>
 <li><p>i2c_address - the I<sup>2</sup>C address of the <span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Turntable</span> device</p></li>
 <li><p>angle - the angle of the home position, valid angles are 0 - 3600</p></li>
 </ul>
+<p>Example creation and definition:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>HAL(EXTurntable,600,1,0x60)            // Create your EX-Turntable device driver
+EXTT_TURNTABLE(1,600,45,&quot;My EX-Turntable&quot;)  // Create your EX-Turntable object to enable control
+</pre></div>
+</div>
 </div></blockquote>
 <p><hr class="hr-dashed" /></p>
 </section>