TODO Report¶
Scanned docs root: /home/runner/work/mkdocs-test/mkdocs-test/docs
High TODOs¶
Total High TODO matches: 87
| File | Line | Line text |
|---|---|---|
| docs/contributing/release-checklist.md | 128 | - TODO Really need some pages with diagrams and picture covering physical installation of the CS. See /purchasing/physical-installation.md and installer/physical-installation.md |
| docs/purchasing/physical-installation.md | 3 | TODO new page on physically connecting the EX-CSB1 to a layout. Should be in a snippet and reused |
| docs/purchasing/next-steps.md | 7 | (LOTS OF TODO in this file) |
| docs/throttles/dc.md | 3 | TODO basic intro to TrackManager and links to the appropriate TrackManager pages |
| docs/throttles/connecting-usb.md | 3 | TODO Connecting a USB Throttle to your EX-CommandStation |
| docs/throttles/dcc-accessories.md | 3 | TODO how to control DCC Accessories |
| docs/throttles/connecting-wifi.md | 3 | TODO Connecting a WiFi Throttle to your EX-CommandStation |
| docs/diy/mega-harder.md | 18 | - an Arduino Standard Motor-Shield (or others as noted in TODO) to power the track. |
| docs/support/faq.md | 9 | TODO Rework this so that it includes GUI options (EX-WebThrottle, Engine Driver, etc.) |
| docs/support/faq.md | 19 | TODO Rework this so that it includes GUI options (EX-WebThrottle, Engine Driver, etc.) |
| docs/installer/install-ex-ioexpander.md | 3 | TODO complete EX-Installer EX-IOExpander page needed |
| docs/installer/physical-installation.md | 3 | TODO new page on physically connecting the EX-CS to a layout. Should be in a snippet and reused |
| docs/installer/install-ex-turntable.md | 3 | TODO complete EX-Installer EX-Turntable page needed |
| docs/installer/platformio.md | 3 | TODO - provide setup help. |
| docs/reference/throttle-writers/throttle-writers-guide.md | 68 | TODO Controlling Locos |
| docs/reference/throttle-writers/throttle-writers-guide.md | 140 | TODO DCC Accessory Control |
| docs/reference/throttle-writers/throttle-writers-guide.md | 166 | Routes and Automations can also have their current status and caption altered dynamically by EXRAIL (docs TODO) |
| docs/reference/throttle-writers/throttle-writers-guide.md | 170 | TODO Route Status |
| docs/reference/throttle-writers/throttle-writers-guide.md | 201 | ## COMMANDS TO AVOID TODO |
| docs/reference/throttle-writers/throttle-writers-guide.md | 217 | TODO Gauges |
| docs/reference/throttle-writers/throttle-writers-guide.md | 223 | TODO TCP VS UDP |
| docs/reference/serial-commands/serial-command-ii_not_in_nav.md | 25 | TODO move legacy docs |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 120 | TODO Response for <r «loco» «cv»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 134 | TODO Response for <W CONSIST «loco»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 138 | TODO Response for <W CONSIST «loco» REVERSE> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 151 | TODO Response for `<W «cv» «bitValue» «bit»> |
| docs/reference/serial-commands/serial-command-rr-and-ww_not_in_nav.md | 169 | TODO Response for <b «loco» «cv» «bitValue» «bit»> |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 23 | * accelerating: TODO |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 24 | * braking: TODO |
| docs/reference/serial-commands/serial-command-m_not_in_nav.md | 25 | * momentum: TODO |
| docs/reference/serial-commands/shell_serial-command-xyz_not_in_nav.md | 40 | TODO MENU - Responses |
| docs/reference/serial-commands/serial-command-zz-and-z_not_in_nav.md | 79 | TODO Response |
| docs/reference/serial-commands/serial-command-ff_not_in_nav.md | 29 | * TODO = Mid frequency - 490Hz |
| docs/reference/serial-commands/serial-command-ff_not_in_nav.md | 30 | * TODO = High frequency - 3400Hz |
| docs/reference/serial-commands/serial-command-ff_not_in_nav.md | 31 | * TODO = Supersonic - 62500Hz |
| docs/reference/serial-commands/serial-command-jj-mm_not_in_nav.md | 27 | * StashId: Id of the stash to set, clear or get (0 - TODO) |
| docs/reference/serial-commands/serial-command-aa-and-a_not_in_nav.md | 36 | TODO responses |
| docs/reference/serial-commands/serial-command-aa-and-a_not_in_nav.md | 54 | TODO move this spreadsheet to the new web site |
| docs/reference/serial-commands/serial-command-dd-anin-anout_not_in_nav.md | 15 | * <D ANOUT «vpin» «position» «profile»> see TODO |
| docs/reference/serial-commands/serial-command-dd-anin-anout_not_in_nav.md | 16 | * <D ANOUT «vpin» «position»> see TODO |
| docs/reference/serial-commands/serial-command-dd-anin-anout_not_in_nav.md | 21 | * position: TODO |
| docs/reference/serial-commands/serial-command-dd-anin-anout_not_in_nav.md | 22 | * profile: TODO |
| docs/reference/serial-commands/serial-command-dd_and_e_and_ee_not_in_nav.md | 20 | * numEntries: optional TODO explain the parameter |
| docs/reference/trackmanager/dc-mode-frequency.md | 82 | - TODO How to effectively use DC mode when using multiple frequencies. |
| docs/reference/trackmanager/dcc-vs-dc.md | 43 | Brake Pin: In order for TrackManager to operate in DC mode, the motor shield must have a brake pin defined in your "config.h" motor shield definition. There are a very limited number of motor drivers that are known to be suitable for use with DC mode. The current list is available in TODO :ref: reference/hardware/motor-boards:trackmanager dc compatible boards. Any other motor drivers, not explicitly listed, are not supported. |
| docs/reference/trackmanager/dcc-vs-dc.md | 99 | TODO XXX - map of function number to frequency |
| docs/reference/trackmanager/dcc-vs-dc.md | 166 | There are a very limited number of motor drivers that are known to be suitable for use with DC mode. The current list is available in TODO :ref:reference/hardware/motor-boards:trackmanager dc compatible boards. Any other motor drivers, not explicitly listed, are not supported. |
| docs/reference/microcontrollers/ex-csb1/csb1-technical.md | 22 | TODO EX-CSB1 Technical Reference |
| docs/reference/microcontrollers/nucleo/nucleo-144-ex8874.md | 59 | TODO - update MotorDrivers.h for D8 |
| docs/reference/microcontrollers/esp32/esp32-ex8874.md | 110 | TODO Stacked EX8874 Checklist |
| docs/reference/microcontrollers/esp32/esp32-acebott.md | 99 | TODO Stacked EX8874 Checklist |
| docs/reference/hardware/ethernet-boards/index.md | 3 | TODO Move the legacy pages |
| docs/reference/hardware/hal/hal-config.md | 3 | TODO change references to the Arduino IDE to VSC |
| docs/reference/hardware/hal/hal-config.md | 185 | This will need to be done in the TODO :doc:Arduino-IDE </ex-commandstation/advanced-setup/installation-options/arduino-ide>, so first make sure you have followed these steps to load up the Arduino IDE. |
| docs/reference/hardware/hal/hal-config.md | 189 | First you will need to add a new file, just like the TODO :ref:config.h file <ex-commandstation/advanced-setup/installation-options/arduino-ide:Copy the config.example.h file (or rename it)>. |
| docs/reference/hardware/hal/hal-config.md | 252 | Finally, upload the code to the Arduino as you would do during the standard TODO :ref:Arduino IDE Setup <ex-commandstation/advanced-setup/installation-options/arduino-ide:upload the software>. |
| docs/reference/hardware/bluetooth-devices/index.md | 3 | TODO Move the legacy pages |
| docs/reference/hardware/wifi-boards/index.md | 3 | TODO Move the legacy pages |
| docs/reference/wiring/i2C/i2c-wiring.md | 54 | - When using separate power sources, there is potential for a ground loop. TODO |
| docs/products/ex-ioexpander/ex-ioexpander.md | 8 | TODO move legacy docs |
| docs/products/ex-wifishield8266/ex-wifishield8266.md | 8 | TODO Improve intro paragraph |
| docs/products/ex-dccinspector/index.md | 8 | TODO move legacy docs |
| docs/products/ex-webthrottle/ex-webthrottle.md | 6 | TODO Split into separate pages for overview plus installing and using. |
| docs/products/ex-turntable/test-and-tune.md | 54 | Referring to adding a new device, skip ahead to TODO checking the driver, and the output you're looking for to validate the EX-Turntable device driver is loaded and connected successfully is below: |
| docs/products/ex-turntable/test-and-tune.md | 180 | For full details on using the new commands available, refer to TODO :ref:reference/software/command-summary-consolidated:turntables/traversers (configuring the ex-commandstation) and :ref:reference/software/command-summary-consolidated:turntables/traversers, and also the EXRAIL commands in :ref:exrail/exrail-command-reference:turntable/traverser objects - definition and control and :ref:exrail/exrail-command-reference:turntable features. |
| docs/products/ex-turntable/ex-tt-troubleshooting.md | 7 | TODO Frequently Asked Questions |
| docs/products/ex-turntable/configure.md | 3 | TODO check the current version number of EX-Turntable and adjust the version notes on this page as needed |
| docs/products/ex-turntable/assembly.md | 188 | Further to this, note that you will need to end up with two separate folders; one containing the EX-CommandStation software as per TODO :doc:/ex-commandstation/advanced-setup/installation-options/arduino-ide, and an additional folder containing the EX-Turntable software. The EX-Turntable software is not a component of EX-CommandStation or vice versa, and as such they should not exist in the same folder. |
| docs/products/ex-turntable/assembly.md | 196 | The process here is the same as installing CommandStation-EX via the Arduino IDE which you can find on the TODO :doc:/ex-commandstation/advanced-setup/installation-options/arduino-ide page. |
| docs/products/ex-turntable/assembly.md | 327 | - VPIN=600 - This is the default virtual pin (Vpin) ID that is used to send EX-Turntable commands to. Vpin IDs need to be unique, so if this ID is used elsewhere, change as necessary (refer TODO :ref:reference/developers/hal:overview). |
| docs/products/ex-commandstation/testing.md | 3 | (LOTS OF TODO in this file) |
| docs/products/ex-commandstation/loco-programming/programming-tips.md | 14 | TODO Fill this page out. Also move the references from the old site |
| docs/products/ex-commandstation/trackmanager/index.md | 104 | - A motor shield with a brake pin. (See the list of compatible boards at TODO :ref: reference/hardware/motor-boards:trackmanager dc compatible boards.) (The EX-CSB1 and EX‑MotorShield8874 have a brake pin.) |
| docs/products/ex-commandstation/exrail/exrail-objects-introduction.md | 151 | TODO You can also refer to :doc:/ex-commandstation/accessories/turnouts/solenoid-turnouts for more information. |
| docs/products/ex-commandstation/exrail/exrail-objects-introduction.md | 208 | TODO Add a diagram for the EX-CSB1 to a PCA9685 |
| docs/products/ex-commandstation/exrail/exrail-objects-introduction.md | 362 | TODO Link here to recommended pin/vpin allocations etc. |
| docs/products/ex-commandstation/exrail/exrail-objects-introduction.md | 364 | TODO Add a diagram for the EX-CSB1 to an IO Expander |
| docs/products/ex-commandstation/accessories/i2c-servo-led-modules.md | 180 | LEDs can be connected with either the anode (positive) or cathode (negative) to the PWM pin of the PCA9685, and to set the required intensity for the LED, you will need to add a configuration setting to your "mySetup.h" file. Refer to TODO :doc:/ex-commandstation/advanced-setup/startup-config for further information on this file. |
| docs/products/ex-commandstation/accessories/i2c-servo-led-modules.md | 220 | An output is defined by using the <Z id vpin iflag> command. Refer to TODO :ref:reference/software/command-summary-consolidated:outputs (configuring the ex-commandstation) for further information on this command. |
| docs/products/ex-commandstation/accessories/i2c-multiplexers.md | 5 | TODO move legacy docs |
| docs/products/ex-commandstation/accessories/i2c-displays.md | 193 | As you can see from the comments in this code, both of these displays can now be written to from EXRAIL using the SCREEN() directive. See the EXRAIL TODO :ref:exrail/exrail-command-reference:communication and display functions for more information. |
| docs/products/ex-commandstation/exrail/cookbooks/timecontrol.md | 92 | NB: TODO See the following page for details on running sound files. |
| docs/products/ex-commandstation/exrail/cookbooks/big-picture/stage6.md | 404 | Remember, these are virtual blocks, and do not necessarily need to be electrically isolated from each other. Don't confuse isolated blocks of track or block occupancy detection with these virtual blocks. For further background, refer to TODO exrail/exrail-command-reference:virtual block control. |
| docs/products/ex-commandstation/exrail/cookbooks/big-picture/stage6.md | 446 | Using the LATCH() command gives us a way to automatically alternate between the main track and the station siding. LATCH() simply sets the state of a pin (either real or virtual) which can then be tested by an IF() statement. In this particular case, we have defined pin 60 (alias "CHOOSE_BLK2") to be latched and unlatched, as this pin does not exist on the Mega2560, nor does it exist on any of our I/O expander boards. Further reading on LATCH() and UNLATCH() can be found in the TODO exrail/exrail-command-reference:sensors/inputs - reading and responding section of the EXRAIL reference. |
| docs/products/ex-commandstation/exrail/cookbooks/big-picture/stage3.md | 169 | You can also refer to TODO exrail/exrail-command-reference:virtual block control for more information. |
| docs/installer/download/download-linux.md | 7 | TODO - Add screenshots & fix page flow |
| docs/installer/download/index.md | 3 | TODO Downloading EX-Installer - Overview |
Medium priority TODOs¶
Total medium priority TODO matches: 18
Low priority TODOs¶
Total low priority TODO matches: 63