.. _nao-v4-upgrade:

NAO v4: Rescue software update
==============================

Introduction
------------

This section will help you update your NAO v4, and only NAO v4, in the
**rescue** mode.

If you are not sure whether your robot is a NAO v4 or not, refer to
:ref:`this section <software-update-steps>` of the manual.


.. warning::

    Achieving a **rescue software update** will *reset all settings* you may
    have set to the factory ones.

    Any data or settings that you may have put in the robot will be lost at
    the end of this procedure.

.. note::

  This is a **rescue** procedure.

  This is not the standard way to update the software version of NAO.

  If your robot is booting normally please use Choregraphe's
  :ref:`choregraphe-howto-update-nao-system`.

.. _nao-v4-upgrade-getting-image:

Getting the new software version
--------------------------------

The software version for NAO v3.X is gzip file (".gz" extension) and should have
a name like ``opennao-atom-system-image-X.Y.Z.opn`` [#f1]_.

Download the OpenNAO software version if you do not already have it.


.. _nao-v4-upgrade-getting-usbstick:

Getting the USB stick
---------------------

Just take one of your own USB sticks (its size must be larger or equal to 512MB).

.. warning::

    This process erase the whole USB stick.

    Any data on the USB stick will be irreparably lost.

.. _nao-v4-upgrade-create-rescue-usbstick:

Writing the image on the USB stick
----------------------------------

#.  Insert your USB stick in your computer.

    .. note::

        On Windows and Mac OSX, you might encounter a prompt telling you that the USB
        drive you inserted is not readable, and that you should format it.

        This happens because they do not recognize what is on the USB stick. This is perfectly normal.

        Please ignore this and click on the "Cancel" button or similar.

        If you allready formated your drive or if you have a file system on it (if you took one of your
        own usb sticks it is probably the case), try :ref:`cleaning up your drive<usb-cleanup>`.

#.  Launch the **flasher** executable.

    It should look roughly like this:

    .. image:: /medias/opennao/nao-flasher01.png

#.  Click the **browse** button (or press Ctrl+O) to select the image you want to flash in your
    local filesystem. You can also copy/paste the file's address directly in the text box.

    .. image:: /medias/opennao/nao-flasher02.png

#.  Select your USB stick from the list (if your USB stick  doesn't appear in the list
    try the **Refresh** button after inserting it in your computer):

    .. image:: /medias/opennao/nao-flasher03.png

    Check the **Factory Reset** box if you want a brand new system:

    .. warning::

        Factory Reset will remove all the data from your robot, please backup your data
        before running the program.

    .. image:: /medias/opennao/nao-flasher07.png

#.  Click the **write** button to start the process:

    .. note::

      If you get an error telling you that the usb stick contains a file system,
      try :ref:`cleaning up your drive<usb-cleanup>`.

    .. image:: /medias/opennao/nao-flasher04.png

    .. image:: /medias/opennao/nao-flasher05.png

#.  When NAO-flasher is done, it should look like this:

    .. image:: /medias/opennao/nao-flasher06.png

.. _nao-v4-upgrade-reboot:

Upgrading the NAO's system and running the new software version
---------------------------------------------------------------

.. warning::

    Ensure that NAO is plugged to its adapter during the system update process.


#.  Shutdown the robot.

#.  After having flashed the USB stick, you can plug it into the USB connector at the rear
    of the NAO's head.

#.  Boot the robot **keeping the torse button pushed for 5 seconds**
    (*do not release the torse button until it is blinking in blue*).

The NAO's system will be upgraded during the boot. The new software version will be automatically started.

.. warning::

    If you enabled the *factory reset* option, this may take a very long time to complete
    (the duration directly depends on the size of the flash memory dedicated to user purposes).

    So be patient or go have a beer in the mean time.

.. note::

    To understand the ears lighting during the boot, refer to the
    :ref:`ears lightning on boot <nao-manual-ears-on-boot>` section of the manual.

    To understand the ears lighting during upgrade process, refer to the
    :ref:`ears lightning on upgrade <nao-manual-ears-on-upgrade>` section of the manual.


.. rubric:: Footnotes

.. [#f1] ``X.Y.Z`` is the version number of the system contained in the OpenNAO software release.