Skip to content

Commit

Permalink
Add documentation on updating a PandA through the web interface
Browse files Browse the repository at this point in the history
  • Loading branch information
tomtrafford committed Jul 29, 2024
1 parent cbe96ba commit 3ae6b7a
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 3 deletions.
4 changes: 1 addition & 3 deletions docs/how-to/remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Updating a PandA via SSH
========================

The Admin interface of the PandA can be used to update the firmware as detailed
in the quickstart_doc_, but sometimes it is necessary to update a number of
in the _web_doc, but sometimes it is necessary to update a number of
PandAs at once. The SSH interface can be used to do this.

To gain access over SSH, either add an ``authorized_keys`` file to the SD card,
Expand All @@ -21,8 +21,6 @@ It is then possible to log in remotely and perform operations on the PandA.
First update rootfs and then, after a reboot, update to the latest available zpkg
packages (while making sure to match the major versions of everything).

.. _quickstart_doc: https://pandablocks.github.io/PandABlocks-rootfs/master/quickstart.html

Updating the rootfs
-------------------

Expand Down
57 changes: 57 additions & 0 deletions docs/how-to/web-interface.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _web_doc:

Updating a PandA via web interface
==================================

To update the firmware installed on a PandA, it is recommended to use the Web Admin
interface. To do this you will need physical access to the PandA and a USB memory
stick with the new firmware copied onto it. You can find the latest firmware from
GitHub_.

Information about updating a PandA by SSH can be found in the _ssh_doc.

The Web Interface of a PandA is accessible by typing its ip address or hostname into
a browser.


Updating the rootfs
-------------------

On the Web Admin interface, Navigate to Admin on the bottom banner. You will then be
able to read your current Version information.

On a memory stick you will need the ``boot-x.x.zip`` file from GitHub_. There is no
need to unzip it.

.. note::
If your current rootfs version is less than 2.1 you will need to unzip the file
and select to install ``imagefile.cpio.gz``.

With a prepared USB memory stick inserted in the USB slot in the back of a PandA,
navigate to Packages under Admin Commands and then Install Rootfs from USB. You can
select your zip file from the list and follow the on screen instructions to install
your new version of the rootfs.

.. note::
If you are installing a major upgrade to the rootfs, it is recommended to
uninstall all the installed zpkgs before upgrading the rootfs. For PandA v3.1 an
option is available to do this as part of the rootfs install.

You can power cycle the box and it will install the new rootfs.


Updating zpkg packages
----------------------

A PandA firmware installation consists of 4 Zpkgs:
- panda-fpga\@*.zpg
- panda-server\@*.zpg
- panda-webcontrol\@*.zpg
- panda-slowfpga\@*.zpg (PandA 3.0 onwards)

Download new zpkg files from GitHub_, and add them to the USB memory stick. Navigate
to Packages under Admin Commands and then Install Packages from USB. You can select
which zpkgs from the USB stick you will want to install.


.. _GitHub: https://github.com/PandABlocks/PandABlocks.github.io/releases

0 comments on commit 3ae6b7a

Please sign in to comment.