Merge pull request #1255 from flash62au/sphinx

overload cookbook example

Author: flash62au

docs/conf.py

@@ -38,7 +38,7 @@
     # 'sphinx.ext.ifconfig',
     # 'sphinx.ext.viewcode',
     # 'sphinx.ext.graphviz',
-    'sphinx_sitemap',
+    # 'sphinx_sitemap',
     # 'sphinx.ext.inheritance_diagram',
     'sphinxcontrib.spelling',
     'sphinx_toolbox.collapse',

docs/exrail/cookbooks/index.rst

@@ -31,6 +31,7 @@ The following cookbooks are currently available:
     vpins
     animation-sensors
     estop-button
+    overload-messsage
 
 .. toctree::
     :maxdepth: 2

docs/exrail/cookbooks/overload-messsage.rst

@@ -0,0 +1,28 @@
+.. include:: /include/include.rst
+.. include:: /include/include-l2.rst
+.. include:: /include/include-ex-r.rst
+|EX-R-LOGO|
+
+**************************************
+Message on Overload or Short Circuit
+**************************************
+
+|SUITABLE| |tinkerer| |engineer| |support-button|
+
+``ONOVERLOAD(output)`` will start a sequence when an overload or short circuit is detected on the track/output. |BR|
+``MESSAGE(message)`` will display a message on all throttles. |BR|
+``AFTEROVERLOAD(output)`` will continute the sequence at this point after the overload or short circuit is cleared.
+
+.. code-block:: cpp
+
+    ONOVERLOAD(A)
+      PRINT("Overload Detected on A")
+      BROADCAST("Overload Track A")
+      MESSAGE("Overload Track A")
+      AFTEROVERLOAD(A)
+        DELAY(2000)
+        BROADCAST("Overload Track A - Cleared")
+        MESSAGE("Overload Track A - Cleared")
+    DONE
+
+For tracks/outputs B-H, duplicate the entire block above and replace 'A' with the appropriate track/output letter.

docs/exrail/examples.rst

@@ -27,6 +27,9 @@ Objects:
 - Active low IR sensors connected to Mega2560 I/O pins 40 through 46
 - An active low push button on Mega2560 I/O pin 30
 
+
+Also see the :doc:`/exrail/cookbooks/index` for a collection of step-by-step instructions for building various |EX-R| based sequences and components for your model railroad.
+
 ----
 
 Turn Track Power On at Startup

docs/index.rst

@@ -98,7 +98,7 @@ DCC-EX Model Railroading
    :hidden:
    :maxdepth: 4
 
-   EXRAIL & TRACK MANAGER<add-ons>
+   PURCHASING & MERCHANDISE<purchasing-and-merchandise>
 
 .. toctree::
    :hidden:
@@ -110,25 +110,19 @@ DCC-EX Model Railroading
    :hidden:
    :maxdepth: 4
 
-   SUPPORT & INFO<support-and-info>
-
-.. toctree::
-   :hidden:
-   :maxdepth: 4
-
-   DOWNLOADS<download/index>
+   SUPPORT, INFO & IDEAS<support-and-info>
 
 .. toctree::
    :hidden:
    :maxdepth: 4
 
-   PURCHASING & MERCHANDISE<purchasing-and-merchandise>
+   EXRAIL & TRACK MANAGER<add-ons>
 
 .. toctree::
    :hidden:
    :maxdepth: 4
 
-   DETAILED INFORMATION<reference/index>
+   REFERENCE & DETAILED INFO<reference/index>
 
 .. .. toctree::
 ..   :hidden:
@@ -139,6 +133,12 @@ DCC-EX Model Railroading
 ..   external-references/standards
 ..   reference/accessories/index
 
+.. toctree::
+   :hidden:
+   :maxdepth: 4
+
+   DOWNLOADS<download/index>
+
 .. toctree::
    :hidden:
    :maxdepth: 4