more troubleshooting for p/p3-roc

missionpinball · May 9, 2020 · 1e812fb · 1e812fb
1 parent c62eb27
commit 1e812fb
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 0 deletions.
diff --git a/hardware/include_troubleshooting.rst b/hardware/include_troubleshooting.rst
@@ -4,6 +4,8 @@ Add debugging to related devices
 If you got problems with some switches also add ``debug: true`` to those as
 it will give to more insights into the intentions of those devices.
 Same will work for flippers, coils, lights, servos, steppers and more.
+See :doc:`general debugging section </troubleshooting/general_debugging>`
+for details.
 
 Run MPF with verbose flag
 -------------------------

diff --git a/hardware/multimorphic/connecting.rst b/hardware/multimorphic/connecting.rst
@@ -17,6 +17,9 @@ Then connect switches and driver according to the manual
 (see :doc:`/hardware/existing_machines/index` for specific machines).
 If you are using a PD-Master board see below for switches and drivers.
 
+:doc:`mpf hardware scan </running/commands/hardware>` will show the firmware
+version and revision of your P-Roc if it is connected correctly.
+
 P3-Roc
 ------
 
@@ -30,6 +33,9 @@ all nodes.
 
 .. image:: /hardware/images/multimorphic_p3_roc_wireing.jpg
 
+:doc:`mpf hardware scan </running/commands/hardware>` will show the firmware
+version and revision of your P3-Roc if it is connected correctly.
+
 SW-16
 ~~~~~
 
@@ -41,6 +47,18 @@ It does not matter on which of the two switch busses the boards are connected.
 Terminate the bus at the last board.
 See :doc:`switches_p3_roc` for how to configure those boards.
 
+You can list all SW-16 using :doc:`mpf hardware scan </running/commands/hardware>`:
+
+.. code-block:: console
+
+   $ mpf hardware scan
+
+   Firmware Version: 2 Firmware Revision: 6 Hardware Board ID: 1
+   SW-16 boards found:
+    - Board: 0 Switches: 16 Device Type: A3 Board ID: 0
+    - Board: 1 Switches: 16 Device Type: A3 Board ID: 1
+    - Board: 2 Switches: 16 Device Type: A4 Board ID: 2
+
 PD-16/PD-8x8
 ~~~~~~~~~~~~
 
@@ -53,6 +71,9 @@ It does not matter on which of the two driver busses the boards are connected.
 Terminate the bus at the last board.
 See :doc:`drivers` and :doc:`lights` for how to configure those boards.
 
+MPF and the P3-Roc do not know if those boards are connected as the
+communication is one-way only.
+
 PD-LED
 ~~~~~~
 
@@ -64,3 +85,6 @@ However, they overlap with the PD-16 addresses so plan accordingly.
 It does not matter on which of the two driver busses the boards are connected.
 Terminate the bus at the last board.
 See :doc:`leds` for how to configure those boards.
+
+MPF and the P3-Roc do not know if those boards are connected as the
+communication is one-way only.
diff --git a/hardware/multimorphic/drivers.rst b/hardware/multimorphic/drivers.rst
@@ -183,6 +183,10 @@ This is an example:
 Common Issues
 -------------
 
+Have a look at our
+:doc:`troubleshooting guide for the P/P3-Roc <troubleshooting>`.
+Here are some driver specific things:
+
 All Coils Turn On When I Power Up My Machine
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/hardware/multimorphic/troubleshooting.rst b/hardware/multimorphic/troubleshooting.rst
@@ -26,6 +26,7 @@ Additionally, it will show you which ``SW-16`` are connected:
 
 Unfortunately, MPF cannot know which ``PD-16`` or ``PD-LED`` are connected
 as this information is not available.
+See :doc:`/running/commands/hardware` for details.
 
 Enable Debugging
 ----------------
@@ -57,4 +58,10 @@ This will cause a lot of additional log lines and might considerably slow down
 MPF.
 Definitely disable this after you finished debugging.
 
+Issues With Coils
+-----------------
+
+See the :doc:`common coil issues section <drivers>`.
+
+
 .. include:: ../include_troubleshooting.rst
diff --git a/running/commands/format.rst b/running/commands/format.rst
@@ -0,0 +1,4 @@
+mpf format (command-line utility)
+=================================
+
+See :doc:`/tools/format/index`.
diff --git a/running/commands/index.rst b/running/commands/index.rst
@@ -56,3 +56,5 @@ To update the firmware of your hardware controllers (if supported by your platfo
    mpf hardware <hardware>
    mpf service <service>
    mpf build <build>
+   mpf test <test>
+   mpf format <format>
diff --git a/running/commands/test.rst b/running/commands/test.rst
@@ -0,0 +1,4 @@
+mpf test (command-line utility)
+===============================
+
+See :doc:`/tools/test/index`.