Updating

In this section we will explain how to update the firmware and IP address of your module.

First download the latest firmware for the Qblox Pulsar QCM, Pulsar QRM and/or Cluster. The firmware can then be installed using the Qblox Configuration Manager tool, shipped with the Qblox instruments Python package (make sure it’s installed).

Note

We used to ship the configuration manager with each firmware release, rather than with Qblox instruments. This is, however, an older version of the tool, that will not be able to communicate with instruments running newer firmware versions. The configuration manager shipped with Qblox instruments should however be able to communicate with all firmware versions. If you nonetheless run into problems with it (in particular when downgrading), you may have to update Qblox instruments first:

$ pip install --upgrade qblox-instruments

Once you’ve updated or downgraded all your instruments, you may have to install a different version of Qblox instruments again, in order for it to be compatible with the firmware version you installed.

When ready, you can update the firmware of your instruments as follows using a terminal of your choice, replacing <filename> with the file you downloaded:

$ qblox-cfg 192.168.0.2 update <filename>

Note

The default IP address of the module is 192.168.0.2. Replace the IP address of any following instruction accordingly if the module’s IP address was ever changed.

You can also use the configuration manager to update the IP address of your instrument:

$ qblox-cfg 192.168.0.2 set-ip <new-ip-address>

Tip

The instruments support more than just static IPv4 addresses: you can also configure them to use DHCP, and/or you can add a static IPv6 address if needed. Run qblox-cfg --help for more information.

Or to change its name:

$ qblox-cfg 192.168.0.2 set-name <new-name>

You can also perform several operations at once, if you want. For example, this will set the IP address and update the instrument (originally) at 192.168.0.2:

$ qblox-cfg 192.168.0.2 set-ip <new-ip-address> update <filename>

After executing one of the commands above, follow the instructions given by the Qblox Configuration Manager. The module will reboot, after which the update is complete.

During reboot, the status (S) LED will turn yellow, and the other LEDs will turn off (if you’re updating from an old firmware version, the LEDs may also turn purple/red). This indicates that the instrument is rebooting. When the LEDs turn green/blue again, the reboot is finished.

If the module does not finish rebooting within 1-2 minutes, please remove power from the module and wait one minute before powering it on again. This might be required up to two times: once to start the internal update process, and a second time to start using the updated firmware.

When done, please make sure your installed Qblox instruments package is compatible with the installed firmware. See Qblox instruments PyPI and section Installation.

Tip

If you’re connected to your instrument(s) directly or only via network switches (NOT via VPN or a router), you can also use the instrument name or serial number instead of the IP address to select an instrument. Or you can update all instruments at once:

$ qblox-cfg -k all update <filename>

Note that this will only update the instruments that the update file you specify is compatible with. The tool will report that it failed if one of the instruments it found wasn’t compatible, but (due to the -k flag, short for “keep going”) it will try to apply the updates to all instruments, instead of stopping after immediately after trying to update an incompatible instrument.

Tip

By default, the tool will ask you to confirm that you really want to update after printing a summary of the operations it will be performing. You can get more information by adding -v or -vv to the command line, or by reading the log file. Alternatively, if you want to automate qblox-cfg, you may want to disable the prompt (a.k.a. non-interactive mode), which you can do with -y.

Tip

In general, the Qblox Configuration Manager tool can do much more than what’s listed here. Run qblox-cfg --help for more information.