Skip to content

Commit

Permalink
add firmware upgrade section and fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jabdoa2 committed Oct 11, 2020
1 parent 8fb185f commit 79323b2
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 5 deletions.
42 changes: 42 additions & 0 deletions hardware/multimorphic/firmware_upgrade.rst
@@ -0,0 +1,42 @@
How to update the Firmware of the P-Roc or P3-Roc
=================================================

If you experience problems around hardware rules or such consider upgrading
your P/P3-Roc firmware.
Sometimes bugs in the firmware get fixed or stuff becomes more robust.
For some known cases MPF will crash intentionally and tell you to upgrade but
there might be cases which we do not know.

Finding out the current firmware version
----------------------------------------

You can find out your current firmware version using ``mpf hardware scan``:


.. 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
In this example the P3-Roc is running firmwar ``2.6``.

Upgrading the firmware of the P-Roc or P3-Roc
---------------------------------------------

1. Go to the `Multimorphic Customer Support Site <https://www.multimorphic.com/support/projects/customer-support/wiki/Firmware>`_.
2. If you do not yet have an account create one. Otherwise login.
3. Download the firmware upgrade tool and the newest firmware for your controller.
4. Perform the upgrade as described by Multimorphic

What if it did not work?
------------------------

In case you got troubles with the upgrade we recommend you to contact the
Multimorphic support team.
If you got a problem with MPF have a look at the :doc:`troubleshooting`
section.
1 change: 1 addition & 0 deletions hardware/multimorphic/index.rst
Expand Up @@ -45,4 +45,5 @@ the P-ROC or P3-ROC.
Power Entry Board <power_entry>
Servos on PD-LED <servos>
Steppers on PD-LED <steppers>
Firmware Upgrade <firmware_upgrade>
Troubleshooting <troubleshooting>
11 changes: 6 additions & 5 deletions hardware/multimorphic/troubleshooting.rst
Expand Up @@ -8,8 +8,9 @@ Here are some hardware platform specific steps:
P/P3-Roc Does Not Show Up In Device Manager or dmesg Log
--------------------------------------------------------

If your P/P3-Roc does not show up in device manager (Windows) or creates a line
in ``dmesg`` or ``lsusb`` (Linux/Mac) have a look at the USB cable and connection.
If your P/P3-Roc does not show up in device manager (Windows) or does not
create a line in ``dmesg`` or ``lsusb`` (Linux/Mac) have a look at the USB
cable and connection.
Bad cables are a thing (especially for longer cables).
Try removing USB hubs.

Expand Down Expand Up @@ -109,7 +110,7 @@ Enable Bus Tracing
------------------

If your hardware behaves different from the way you told it to in MPF or
if you are seeing lags or delays it might be wise to turn on bug tracing.
if you are seeing lags or delays it might be wise to turn on bus tracing.

.. code-block:: mpf-config
Expand All @@ -131,8 +132,8 @@ your P/P3-Roc firmware.
Sometimes bugs in the firmware get fixed or stuff becomes more robust.
For some known cases MPF will crash intentionally and tell you to upgrade but
there might be cases which we do not know.
You can find out your current firmware version using ``mpf hardware scan``
(see above).

See :doc:`firmware_upgrade` for details about firmware upgrades.

All Coils Turn On When I Power Up My Machine
--------------------------------------------
Expand Down

0 comments on commit 79323b2

Please sign in to comment.