Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 7 additions & 1 deletion docs/exrail/exrail-command-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@ EXRAIL Command Reference

|EX-CS| provides full automation and accessory control through the Extended Railroad Automation Instruction Language (|EX-R|).

This page includes a reference for all available |EX-R| commands.
This page includes a reference for most available |EX-R| commands.


.. note::

Also refer to our new, currently incomplete, web site for additional information on the commands described here: `DCC-EX Command Station Native Commands <https://dcc-ex.com/mkdocs-test/products/ex-commandstation/exrail/command-list/>`_ |EXTERNAL-LINK|. Some commands that have only been added recently may not be covered on this page, but may be included on the new web site page.

See Also:

- :doc:`Introduction to EXRAIL <getting-started>`
- :doc:`/exrail/examples`
- `DCC-EX Command Station Native Commands <https://dcc-ex.com/mkdocs-test/products/ex-commandstation/exrail/command-list/>`_ |EXTERNAL-LINK|

.. warning::
:class: warning-no-clear
Expand Down
4 changes: 2 additions & 2 deletions docs/products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Our *open source* hardware products currently include:
:header-rows: 0

* - |EX-CSB1-LOGO-SMALL|
- Our ready-to-run |DCC| & |DC| command station / booster for controlling your model railroad
- Our ready-to-run |DCC| & |DC| command station / booster |BR| for controlling your model railroad
* - |EX-MS-LOGO-SMALL|
- Our dual 5A output |motor shield| for DIY command stations and adding additional power districts to the |EX-CSB1-SHORT|
- Our dual 5A output |motor shield| for DIY command stations |BR| and adding additional power districts to the |EX-CSB1-SHORT|
* - |EX-WS-LOGO-SMALL|
- Our WiFi add-on board for DIY command stations

Expand Down
16 changes: 14 additions & 2 deletions docs/reference/hardware/microcontrollers/esp32.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The appeal of the ESP32 series is that they are very compact and come with WiFi
- To generate a clean DCC signal you need to program the special RMT hardware, normally used for IR remote controls
- Once we had done this, the DCC signal was very good

The port is currently in very active beta testing, and is for the most part very reliable. At present, the hardware modifications needed for the ESPduino32 and connectivity challenges with the various Devkit modules makes the hardware for tinkerers and engineers only.
The port is for the most part very reliable. At present, the hardware modifications needed for the ESPduino32 and connectivity challenges with the various Devkit modules makes the hardware for tinkerers and engineers only.

.. note::
DCC-EX can only run on the ESP32-WROOM-32 module, and none of the other ESP32 modules (S2, S3, C3 etc.) are supported at present. This is because other ESP32 modules do not have the necessary RMT hardware, or do not have enough such hardware to run DCC-EX.
Expand All @@ -67,10 +67,22 @@ The ESP32 development boards that have been tested include the WeMos D1 R32/ESPD
:alt: LILYGO® TTGO T-Energy T18 V3.0 ESP32-WROVER-E
:scale: 15%

Known Working Boards
--------------------

Our new, currently incomplete, web site has additional information on the following boards:

* `WeMos D1 R32 + EX8874 <https://dcc-ex.com/mkdocs-test/reference/esp32/esp32-ex8874/>`_ |EXTERNAL-LINK|. Also described in the WeMos D1 R32/ESPDUINO-32 section below.
* `ACEBOTT ESP32 Max v1.0 + EX8874 <https://dcc-ex.com/mkdocs-test/reference/esp32/esp32-acebott/>`_ |EXTERNAL-LINK| This requires fewer hardware modifications than the WeMos D1 R32.
* `Keyestudio IOT ESP32 PLUS Development Board + EX8874 <https://dcc-ex.com/mkdocs-test/reference/esp32/esp32-keyestudio/>`_ |EXTERNAL-LINK| This requires fewer hardware modifications than the WeMos D1 R32.
* `ESP32 + L298 Shields (Genuine Arduino R3) <https://dcc-ex.com/mkdocs-test/reference/esp32/esp32-l298/>`_ |EXTERNAL-LINK| Also described in the Additional information on the use of L298 Clone motor shields section below.

WeMos D1 R32/ESPDUINO-32 board
------------------------------

The recommended hardware for now is the WeMos D1 R32, also referred to as the ESPDUINO-32.
(Also refer to `WeMos D1 R32 + EX8874 <https://dcc-ex.com/mkdocs-test/reference/esp32/esp32-ex8874/>`_ |EXTERNAL-LINK| on the new web site.)

The initial hardware supported was the WeMos D1 R32, also referred to as the ESPDUINO-32.
This consists of an `ESP32-WROOM-32 <https://www.espressif.com/en/products/modules/esp32>`_ module mounted on a UNO form factor board with UNO R3 style connectors. Pictured here:

.. image:: /_static/images/esp32/espduino-32.png
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/software/command-summary-consolidated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ DCC-EX Native Commands Summary Reference

This page describes all the |DCC-EX Native commands| that the |EX-CS| supports.

.. note::

Also refer to our new, currently incomplete, web site for additional information on the commands described here: `DCC-EX Command Station Native Commands <https://dcc-ex.com/mkdocs-test/reference/serial-commands/>`_ |EXTERNAL-LINK|. Some commands that have only been added recently may not be covered on this page, but may be included on the new web site page as the process is automated directly from the code.

Conventions used on this page
=============================

Expand Down
Loading