I-Spector firmware: user guide

What the firmware does

The firmware runs on the instrument's microcontroller. It:

• controls the SiPM bias (HV module);
• configures the digital pulse processor (FPGA);
• reads the spectrum, the PSD map (PSD instruments) and the waveform;
• evaluates the count-rate alarms;
• serves the web interface.

The instrument can be used in three ways:

• Web browser: open http://<instrument IP> (default 192.168.50.2).
• Scintilla: the desktop application. It manages several I-Spectors at once, over USB or Ethernet.
• Your own software: HTTP or USB HID, same API (see docs/api.md).

Files in the NI packages i-spector-uc-firmware-mca and i-spector-uc-firmware-psd

The variant is shown on the Firmware page. The version string starts with PSD- on PSD instruments. A file of the wrong variant is refused.

Updating the firmware (normal way)

1. Open the web interface and go to Firmware. Alternatively, use the Firmware panel of Scintilla, over USB or Ethernet.
2. Select the .dtfw file and press Upload. The file is stored in the instrument's external flash and verified. The running firmware is not touched yet.
3. When the state is "Verified, ready to install", press Install and restart. The instrument installs the new firmware and restarts after about 20 seconds.

The settings, the calibration and the network configuration are kept.

Why two kinds of files

• .dtfw is the update file. It carries the version and checksums, and the instrument verifies it before installing it.
• .hex is only for the recovery tool (NI bootloader, UDP port 6234). Use it when the instrument no longer starts its application, for example after a power loss while installing. Start the recovery tool, connect to the instrument's IP and load the .hex of the right variant.

Updating the FPGA of the MCA board

On the Firmware page, in the "FPGA firmware" card, select the .rpd file and start the update. The MCA board is power-cycled and reprogrammed, which takes several minutes. Do not switch the instrument off until the state is ok.

First start after the old firmware

The first time this firmware starts on an instrument that ran the old firmware, it copies these items into the external flash:

• the factory data (serial number, calibration, installed boards);
• the user settings (MCA parameters, energy calibration, alarms, network).

From then on the settings are kept in two copies with checksums. The old copies in the internal flash are left untouched.

Network

The default network is 192.168.50.2/24, gateway 192.168.50.1, host name ISPECTOR. Change it on the Configuration page; the change takes effect immediately. If the address is lost, you can recover the instrument in either of these ways:

• Connect it over USB with Scintilla and restore the network from there.
• Call /reset_network.cgi over USB.