add hardware scan example for p-roc

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

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/config/p_roc.rst b/config/p_roc.rst
@@ -89,7 +89,10 @@ trace_bus:
 ~~~~~~~~~~
 Single value, type: ``boolean`` (``true``/``false``). Default: ``false``
 
-.. todo:: :doc:`/about/help_us_to_write_it`
+Log all calls to libpinproc.
+This will cause a lot of additional log lines and might considerably slow down
+MPF.
+Use only during debugging.
 
 use_separate_thread:
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/hardware/multimorphic/troubleshooting.rst b/hardware/multimorphic/troubleshooting.rst
@@ -5,6 +5,28 @@ If you got problems with your hardware platform we first recommend to read our
 :doc:`troubleshooting guide </troubleshooting/index>`.
 Here are some hardware platform specific steps:
 
+
+Run Hardware Scan
+-----------------
+
+Using ``mpf hardware scan`` you can find out if your P/P3-Roc is talking
+properly to MPF using USB.
+Additionally, it will show you which ``SW-16`` are connected:
+
+.. 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
+
+
+Unfortunately, MPF cannot know which ``PD-16`` or ``PD-LED`` are connected
+as this information is not available.
+
 Enable Debugging
 ----------------
 
@@ -35,6 +57,4 @@ This will cause a lot of additional log lines and might considerably slow down
 MPF.
 Definitely disable this after you finished debugging.
 
-
-
 .. include:: ../include_troubleshooting.rst