R5560 Base Update Packet
Software update for the base (controller) board of an R5560 rack digitizer that is already installed. It updates the base display and control application and the x5560 web dashboard without touching the operating system or the settings of the board. The packet is uploaded from the web dashboard (manually or with the online update) and is applied at the next reboot. The DAQ boards of the rack have their own update packets.
Compatibility
| Product | Board | Variant | Device | Operating system |
|---|---|---|---|---|
| R5560 | base (controller) board, Enclustra Mars ZX2 | all (A, B, D) | Zynq 7010 | PetaLinux 2020.1 base image (r5560-base-image) |
Not for: the R5560SE base board (use r5560se-base-update-packet) and the DAQ boards (use
r5560-a-daq-update-packet or r5560-b-daq-update-packet according to the variant).
What's in this package
| Artifact | File | OS / architecture |
|---|---|---|
r5560-base-update-packet | R5560_Base_Update.BSU | linux-zynq / armhf |
The .BSU file is a gzip-compressed tar archive with an installation script, run_update.sh,
and an update/ folder. At the next boot the base board extracts it into /ni and the script
installs:
Content of update/ | Installed to | Purpose |
|---|---|---|
r5560se_displayapp.elf | /ni/software/ | base display and control application (touch display, rack I/O, clock, sync, pulser, DAQ management over PPP) |
dashboard/ni-dashboard, ni-dashboard-loop.sh, config.example.json, VERSION, keys/ | /ni/software/ | x5560 web dashboard server and the public keys used to verify signed update packets |
ni-dashboard-www/ | /ni/software/ni-dashboard-www/ | x5560 web dashboard user interface |
legacy_web.json | /ni/settings/legacy_web.json | moves the internal web server of the display application to 127.0.0.1:8080, behind the dashboard (only on an operating system that starts the dashboard, see below) |
The script then sets the permissions of /ni and deletes update/ and itself. Network,
routing, pulser, analog and dashboard settings in /ni/settings and /ni/ni-dashboard are kept.
On boards whose operating system does not yet start the x5560 dashboard, the packet installs it
but the existing web interface stays in use on port 80; the full dashboard becomes active with
an operating system image that includes it (r5560-base-image).
How to install
From the web dashboard (manual upload)
- Download
R5560_Base_Update.BSUfrom NI Packages to the PC. - Open the dashboard of the base board at
http://<base-ip>/orhttps://<base-ip>/and log in. At the first login with the factory default password the dashboard asks for a new password. - Open Device Update and, under Manual update, choose or drop the
.BSUfile. - The board reads the file header and shows format, product, board, version and whether the
packet is compatible. A
.BSUpacket is shown as "Legacy update (unsigned)": install it only if it comes from NI Packages or another trusted source. - Click Upload and stage. The packet is verified and staged; the page shows the staged update, which can still be discarded.
- Reboot the base board with the Reboot button (administrator) or by a power cycle. The update is applied during the next start-up. Do not turn off the device until the procedure ends.
Online update (FOTA)
The online update uses the Internet connection of the PC running the browser; the base board itself does not need Internet access.
- Open Device Update on the base dashboard and click Check for updates. The browser
asks
https://downloads.nuclearinstruments.eufor the latest release ofr5560-base-update-packetand shows its version and changelog. - Click Download and install: the browser downloads the packet, verifies its SHA-256 checksum and uploads it to the board, as in a manual upload.
- Reboot the base board to apply it.
Without the dashboard
On a base board whose operating system does not yet start the x5560 dashboard, upload the
.BSU file with the update function of the existing web interface. The installation at the
next boot is the same.
Check the result
- After the reboot open Device Update again: Last result shows time, version and success or failure of the update.
- On Device Status check the dashboard version.
- On the Rack page check that the DAQ boards are listed and reachable.
Requirements
- An R5560 base board running the base operating system image (PetaLinux 2020.1).
- A PC with a browser that reaches the base board over Ethernet.
- A dashboard account. By default the upload works for any logged-in user; the reboot from the
dashboard needs the administrator (
root). An administrator can also copy an update token from the Security page for update tools that work without login. - For the online update: Internet access on the PC running the browser.
Versioning and releases
- Versions use the date format
YYYY.MM.DD.NN(for example2026.10.11.00). - Every release lists its changes in the changelog shown with the release on this portal and in the online update.
- Release channel on this portal: stable.
Related packages
| Package | Relation |
|---|---|
r5560x-base-display-app | display and control application contained in the packet |
x5560-dashboard-backend | web dashboard server contained in the packet |
x5560-dashboard-frontend | web dashboard user interface contained in the packet |
r5560-base-image | complete SD card image of the base board (factory programming, recovery) |
r5560-a-daq-update-packet, r5560-b-daq-update-packet | update packets of the DAQ boards of the rack |
Known limitations and notes
- The packet does not update the operating system, the FPGA bitstream or the boot loader of the
base board: these change only with a new
r5560-base-image. - The packet uses the legacy unsigned format; when the board is configured to accept only signed updates it is refused.
- The factory copy of
/nistored in the operating system image is not changed by the packet. If the board ever restores/nifrom the factory copy, apply the update packet again. - The update is applied at the next start-up: a staged packet has no effect until the board is rebooted.
Source and support
- Development repository: https://gitlab.lanni/nuclear-instruments/prodotti/x5560/fw-sw/r5560/r5560-base-update-packet
- For support contact Nuclear Instruments / CAEN support.
R5560 Base Update Packet
Update packet (.BSU) for the R5560 base board already in the field: display application and web app. Uploaded from the dashboard and applied at the next boot.
License:
Trending Products
R5560SE
High-density, rack-mountable digitizer designed for large-scale physics experiments requiring fast digitization and flexible data processing
DAQ121
High-performance, fully integrated digitizer developed by Nuclear Instruments for advanced SiPM-based muon detection systems.
DAQ141-6
High-performance, 6-channel waveform digitizer developed by Nuclear Instruments for demanding scientific and industrial data acquisition.
