add lisy and apc troubleshooting guide

missionpinball · May 10, 2020 · 96bd193 · 96bd193
1 parent bfc7a5d
commit 96bd193
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 5 deletions.
diff --git a/hardware/apc/connection.rst b/hardware/apc/connection.rst
@@ -58,8 +58,4 @@ Start MPF and MPF-MC on you PC:
 What if it does not work?
 -------------------------
 
-If it does not work disable text ui and increase verbosity to get more debug output:
-
-.. code-block:: shell
-
-   mpf both -t -v -V
+Have a look at the :doc:`LISY troubleshooting guide </hardware/lisy/troubleshooting>`.
diff --git a/hardware/apc/index.rst b/hardware/apc/index.rst
@@ -44,6 +44,11 @@ This is an example config:
      default:
        label: APC
 
+
+See the :doc:`LISY platform </hardware/lisy/index>` for more details on
+configuring hardware.
+
+
 .. toctree::
    :titlesonly:
 

diff --git a/hardware/lisy/connection.rst b/hardware/lisy/connection.rst
@@ -169,3 +169,8 @@ Power up your system and enjoy.
 ----------------------------------------------
 
 Start MPF on you PC. Optionally start MPF-MC (if you want to use an additional DMD or LCD).
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/drivers.rst b/hardware/lisy/drivers.rst
@@ -35,4 +35,9 @@ use coil ``105``:
        number: 107
        default_pulse_ms: 10
 
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
+
 .. include:: ../driver_related_howto_guides.rst
diff --git a/hardware/lisy/flippers_slings_popbumpers.rst b/hardware/lisy/flippers_slings_popbumpers.rst
@@ -40,3 +40,8 @@ You can use this example to enable flippers:
 This config will automatically enable the flippers on ball start and disable
 them on ball end. You can add more events to enable/disable them during the
 game.
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/index.rst b/hardware/lisy/index.rst
@@ -64,3 +64,4 @@ This includes:
    segment_displays
    sound
    protocol
+   troubleshooting
diff --git a/hardware/lisy/lights.rst b/hardware/lisy/lights.rst
@@ -23,3 +23,8 @@ are not real lights. Those can be configured as
 :doc:`digital outputs </config/digital_outputs>`.
 See :doc:`flippers_slings_popbumpers` for details about the
 ``game_over_relay``.
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/segment_displays.rst b/hardware/lisy/segment_displays.rst
@@ -28,3 +28,8 @@ Configure them like this:
 
 Note that the :doc:`/displays/display/alpha_numeric` guide has more details
 on using alpha numeric and segment displays.
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/sound.rst b/hardware/lisy/sound.rst
@@ -138,3 +138,8 @@ You can also use any of the actions above in a show instead of in a standalone
            no_cache: true
      duration: 2s
 
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/switches_lisy1.rst b/hardware/lisy/switches_lisy1.rst
@@ -41,3 +41,8 @@ You can start with this config:
 
 Then just add your switches according to the manual of your machine.
 See :doc:`/config/switches` for more details about switches.
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/switches_lisy80.rst b/hardware/lisy/switches_lisy80.rst
@@ -39,3 +39,8 @@ You can start with this config:
 
 Then just add your switches according to the manual of your machine.
 See :doc:`/config/switches` for more details about switches.
+
+What if it did not work?
+------------------------
+
+Have a look at our :doc:`LISY troubleshooting guide <troubleshooting>`.
diff --git a/hardware/lisy/troubleshooting.rst b/hardware/lisy/troubleshooting.rst
@@ -0,0 +1,47 @@
+Troubleshooting LISY
+====================
+
+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 LISY based platform is
+talking properly to MPF.
+Additionally, it will show you details about the hardware:
+
+.. code-block:: console
+
+   $ mpf hardware scan
+
+   LISY connected via network at localhost:1234
+   Hardware: LISY1 Lisy Version: 4.01 API Version: 0.8
+   Input count: 88 Input map: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87']
+   Coil count: 9
+   Modern lights count: 0
+   Traditional lights count: 40
+   Display count: 5
+
+See :doc:`/running/commands/hardware` for details about the command.
+
+Enable Debugging
+----------------
+
+If you got problems with your platform try to enable ``debug`` first.
+As described in the
+:doc:`general debugging section </troubleshooting/general_debugging>`
+of our :doc:`troubleshooting guide </troubleshooting/index>`
+this is done by
+adding ``debug: true`` to your ``lisy`` config section:
+
+.. code-block:: mpf-config
+
+   lisy:
+     debug: true
+
+This will add a lot more debugging and might slow down MPF a bit.
+We recommend to disable/remove it after finishing debugging.
+
+.. include:: ../include_troubleshooting.rst