English   |   Italiano   |   Freeware

otSPAD operator guide

For a target change with cooling already active, go to Change the operating temperature.

Before sending a command

Identify the camera and its approved operating procedure. Check the permitted detector temperature, comparator threshold, optical exposure and cooling conditions for that particular assembly. Obtain its requirements for heat removal, condensation control, bias sequencing and warm-up. If any limit or step is unknown, leave the corresponding command unused until the camera documentation or its responsible technician establishes it.

The program accepts target entries from −60 to +50 °C and comparator entries from 0 to 3 V. These are input ranges. The camera’s permitted operating range must come from its own specifications. Stored entries reappear when otSPAD starts. Review them before enabling the cooler or calibrating.

Contents

Connect and read the temperatures

Connect opens the first matching USB interface. With multiple compatible cameras attached, establish which unit will receive commands before proceeding. Look for “SPAD camera ready” in Log, then wait for fresh readings. Opening the link starts temperature polling. It does not send the stored target, calibrate the bias or query the pre-existing cooler state.

SPAD Controls shows Cold plate, Heatsink and Environment in °C. The status bar also gives kelvin. The host normally requests an update once per second. Busy operations can delay it, and Meter suspends periodic readings. After “Temperature read failed” the previous numbers can remain visible. Resume operation only after fresh readings and the checks required by the camera procedure.

Contents

Change the operating temperature

Peltier drive shows the BF518 command (0–100%) and the requested voltage calculated for the 2× driver (100% = 3.40 V). n.d. means unavailable. The CSV records peltier_drive_pct on valid thermal readings. Electrical power in watts requires measured voltage and current.

Starting cooling. Enter the approved Target temperature in °C, then select Cooler. The program sends the target to the camera. An acknowledged command enables Apply. Read the measured cold-plate temperature separately and allow the camera to meet its specified stability criterion before taking reference data.

Camera already cooled. With Cooler selected and Apply available, enter the new target, press Apply once and check Log for “Camera acknowledged target” with the intended value. Follow the three temperatures during the transition. Apply sends one temperature request. It issues no cooler-off, bias, threshold, integration or calibration command. Changing the entry alone sends nothing.

If the reply is missing. “Cooler (?)” means the physical state is unknown. Apply is disabled. The next press of Cooler requests OFF. Check the camera and follow its recovery procedure before deciding whether to send OFF or re-enable cooling. On a normal OFF acknowledgement, Apply becomes unavailable until the next successful start.

Contents

Calibrate, Vbr and Vbr Off

Check temperature, illumination and the approved bias procedure. Set Comparator threshold in volts, then press Calibrate. This is a hardware command. The firmware receives the comparator threshold and returns the detector bias chosen by calibration. The number under Calibrated Vbr (V) is that reply, with two decimal places. The log records it too. The threshold and the returned bias are different quantities.

The read-only Vbr field supplies neither a manual bias setting nor a continuous electrical measurement. After a temperature change it can still show the earlier calibration. Follow the camera procedure to decide when recalibration is required. A failed calibration clears the field. Three dashes mean there is no usable value to display, including after disconnect or a Vbr Off request.

Vbr Off requests removal of detector bias. Check Log for an acknowledgement. An unconfirmed command leaves the electrical state uncertain. Use the verification prescribed for the instrument before handling it. Neither Apply nor Pause issues Vbr Off.

Contents

Acquire, pause and preserve a run

Select Integration time before starting Grab. The preset sets the integration interval (0.1 to 30 s). Each successful sample supplies FAST and AVG count rates in cps. Show data when Grab opens a rolling monitor of the acquisition. Toggle Grab off to stop. Plot opens a snapshot from the acquisition buffers. Select that plot and use File → Save data to keep a copy before starting a new run or disconnecting.

Scope asks for the number of samples in its rolling view. Confirming a new Scope while Grab is running stops Grab and starts a fresh acquisition, clearing the acquisition buffers. Pause stops host acquisition polling and the elapsed-time clock. Resume with Pause again. Pausing does not send a stop, cooler or bias command to the camera.

Contents

With USB protocol 102 or 103 each Scope row uses the BF518 gate-end time since capture start. The curve CSV includes sequence number, raw counts, live ticks, clock frequency, end ticks and the number of missing gates. FAST divides counts by the software-measured open time. AVG uses up to ten consecutive gates. Resuming after Pause discards gates from the pause and the gate in progress. Sequence gaps are recorded in the CSV. With firmware 100/101 the curve uses nominal time.

Build and apply a dark reference

Acquire the reference under the dark conditions specified for the setup. Keep the integration selection fixed. Press Dark to calculate channel statistics from the raw samples already in memory. Dark stores the reference means, sample count, integration and last detector temperature. The button does not block light or start a new measurement.

Acquire the signal with matching settings, then press Offset. It subtracts the corresponding dark mean from each raw channel into separate corrected buffers. Check the mismatch dialog if integration differs, temperature is unavailable, or the temperature difference exceeds 0.05 °C. This comparison is a data-quality check. It establishes no safe temperature tolerance. Reacquire the reference if conditions are unsuitable.

Contents

Sensitivity test

Open Tools → Sensitivity test with the camera connected and Grab, Scope and Meter stopped. Enter approved temperatures separated by semicolons. Tolerance, slope and dwell define the thermal qualification criteria. Reports default to the reports folder beside the executable. To choose a different location, use Output folder before the test. The choice is remembered. The Input covered button creates the session and starts the test in one click. If startup is blocked, the panel and Log show the reason. Optionally select a light exposure and identify the source and setting. The session uses the comparator threshold shown in SPAD Controls when started.

The AD590 measures the cold plate. After the first stable window, Settling before calibration (min) adds a continuous wait before each test calibration. The initial 5 minutes can be set from 0 to 30. Zero keeps the original stable-window check alone. A missing reading or a window outside the band or slope limit restarts the wait after requalification. The usual post-calibration thermal check follows. This delay does not measure junction temperature or dark-count stability.

Automatic dark sweep. Leave Automatic temperature sweep (dark) selected, verify that every listed temperature is approved for this camera, cover the input and press Input covered - start automatic sweep once. At each point otSPAD requests Vbr Off, checks the acknowledgement, keeps the current target if the cooler is active and that target was acknowledged in this connection, otherwise sends the new target and waits for a stable window. It then calibrates the bias and qualifies another full window before counting. The next point starts automatically. Band and slope are checked against measured cold-plate temperature.

A sample outside the temperature band immediately invalidates the attempt. An excessive slope starts a warning: drift invalidates the exposure when it persists in the same direction for the configured stable window. A fresh qualified thermal reading after counting is required for acceptance. In automatic mode thermal loss closes acquisition, excludes that attempt, requests bias OFF and repeats qualification and calibration at the same target. After three unsuccessful thermal or acquisition attempts with valid communication, the automatic run marks the point incomplete and continues to the next point. Isolated delays start a new statistical block. Beyond 2.5 s without a sample, with valid telemetry and confirmed process closure, the program retries after a fresh thermal window. Communication errors and unconfirmed commands stop the session. Log lists phases and progress. The report labels diagnostic tables from partial exposures separately from qualified results. Raw CSV includes the discarded attempts.

Clear automatic sweep for manual cooler operation and manual light verification. Manual mode requires authorization at each point. The status bar shows point, phase and planned sample progress. Stop retains a partial report. Check hardware acknowledgements in Log. Follow the camera shutdown procedure for bias and cooling at the end of the test.

The HTML report opens in the system browser. Open HTML reopens it. The dark FAST data give the background, between-block standard deviation and net increments for signal-to-noise (S/N) 1, 3, 5 and 10 in counts/s. The 1 and 10 s windows are software averages. Each duration requires at least ten blocks to estimate thresholds. Optional light verification applies to the tested level. raw.csv records readings and commands against elapsed session time.

Contents

Meter changes the camera settings

Stop Grab and Scope, including paused acquisitions. Confirm that the entire sweep is permitted for the camera and that the comparator entry is the value intended for restoration. Meter repeatedly calibrates and acquires at nominal thresholds from 1 through 8 PE. The model assumes negative-going pulses, a 2.50 V baseline and 0.20 V per PE. The comparator targets run from 2.30 down to 0.90 V. These are software assumptions. Each calibration can change the detector bias.

Meter uses the selected integration and suspends periodic temperature polling during the sweep. A starting temperature in the report may come from an earlier reading if the initial read fails. Compare sample count, timeouts, mean, spread, CV and retention relative to 1 PE. The recommendation ranks measured thresholds. It gives no hardware safety rating. The program logs the path of the timestamped CSV report when one is written.

At the end Meter attempts to recalibrate at the comparator value that was displayed before the sweep, and restores the previous acquisition buffers. Check the restoration message and Vbr field before continuing. Restoration can fail. The recommended threshold is reported separately.

Contents

Read, process and export a plot

In QuickPlot select Raw or Corrected when available, then Both, FAST or AVG. Plot shows the series, Histogram shows its distribution and Spectrum displays its frequency content. Bins controls histogram grouping. FFT controls the transform size. Stats writes the selected plot’s statistics to Log.

Low Pass applies a centered moving average. BaseLine replaces the selected visible series with a running median estimate. Remove B. smooths the series and subtracts a slower median baseline. Log. applies a signed logarithmic transform. These commands edit the selected plot. Undo restores its previous edit. Save a curve before processing if you need the starting values later.

File → Save data writes a reloadable .qcurve. Load data opens one in a new plot. Export bitmap saves a picture. Export CSV writes numerical data for the selected display mode, source and channels. Check these selections before comparing an export to the raw acquisition.

Contents

Interpret Sentinel alerts

In Sentinel → Setup, choose Enable Sentinel and a live source. A corrected selection falls back to raw counts when corrected samples are unavailable. Check Source on the Monitor tab. The smoothing and baseline windows are in samples. Their time span changes with the integration interval. The alarm threshold is expressed in units of estimated noise (sigma).

Monitor shows signal, baseline, delta and score. Alerts records alarm events. Cooldown spaces notifications, Latch visual alarm retains the indication and Reset latch clears it. An alert concerns the selected count stream. Temperature, bias and hardware protection require their own checks. Silence during pause or loss of samples gives no assurance about the camera.

Contents

End a session or recover from an error

Save needed plots and stop acquisition. While the link is still available, follow the shutdown sequence prescribed for your camera and verify each required bias, cooling and warm-up step. Vbr Off and Cooler are separate commands. The program has no automatic Vbr Off step on disconnect or exit.

Disconnect and Exit attempt to stop an active acquisition and request Cooler OFF if its control is checked, then close the USB link even if OFF was unconfirmed. Once disconnected the program cannot monitor warm-up. A closed window, three dashes or a stale temperature display cannot establish the physical state. If a command times out or USB is lost, suspend the run and verify the instrument locally using its recovery procedure.

Contents

Glossary and report symbols

SPAD — single-photon avalanche diode. SiPM — silicon photomultiplier. Vbr — breakdown voltage notation. Here the field shows the bias returned by firmware calibration. Vbias — detector bias. Vthr — comparator threshold.

PE — photoelectron, used as a nominal threshold scale by Meter. FAST / AVG — fast and averaged count-rate channels supplied by the camera. cps — counts per second. CV — coefficient of variation, standard deviation divided by mean when defined. std, sigma (σ) — standard deviation or estimated spread.

RetF / RetA — FAST / AVG retention relative to reference. DropF — FAST loss relative to reference. PrevF — FAST ratio to preceding valid step. F/PE — FAST mean divided by nominal PE. CVf / CVa — FAST / AVG coefficients of variation. Samp — collected samples.

USB — Universal Serial Bus. CSV — comma-separated values. FFT — fast Fourier transform. MDI — multiple-document interface, the plot workspace. V, °C, K, s, ms — volt, degree Celsius, kelvin, second and millisecond.

Contents

Scope: continuous recording and telemetry (21.10 / firmware 9.3)

Open Tools → Scope recorder / Registrazione. Keep Record full Scope session checked, choose an output folder and describe the experiment (sample, optics, shielding and conditions). Press Scope on the toolbar and confirm N. N limits the displayed samples and, while recording, the live buffers; it does not limit CSV duration or row count. The panel shows the unique session path and saved row count. Starting Scope does not change temperature target, fan, cooler or bias. Folder and description are locked until stop.

Each session contains samples.csv (one row per received gate), events.csv (device events, commands and notes), and metadata.json (shared session ID, version, integration and description). CSV files use UTF-8, comma separators, decimal points and quoted fields; notes may span physical lines. Writes are incremental, with a flush requested approximately every 250 ms, on stop and after a note. Operating-system/disk buffering and power failure still limit durability. Write errors remain visible; do not treat a session with errors as complete. Select a writable folder with sufficient free space.

Pause stops count recording and the acquisition stopwatch, while temperature control, device event polling and notes continue. Resume discards queued and partial gates, leaving an explicit missing_before gap. Toggle Scope off to stop; complete pending gates are drained unless stopping while paused. Event recording ends on stop. Add timestamped note records a host-timed note, including while paused. UART/serial interventions appear as firmware state changes, not as the original command text.

Full telemetry requires protocol 103. Protocols 100–102 remain supported, with unavailable columns empty and a visible limitation. With 103, the BF518 attaches state to each gate before USB queuing. Temperatures are acquired sequentially, not simultaneously; each has its own channel-start, result-availability and age timestamps. The last available value is retained without interpolation. Cold temperature is the AD590 on the cold plate, not the SiPM junction. *_valid means a completed nonzero ADC reading; it does not certify calibration, thermal contact or sensor health.

time_s is the gate end since capture start; all *_device_s fields share the extended BF518 clock. host_receive_utc timestamps USB batch reception, not exposure. Notes and USB requests/replies use the host clock; communication latency prevents equating these directly with device times. live_ticks / clock_hz gives measured gate-open duration, and raw counts are retained. state_changed_in_gate flags any state publication within the gate, including ADC activity, not necessarily a temperature change. actuator_update_active marks an output update in progress. Use events.csv to reconstruct transitions.

Peltier drive, fan, cathode voltage, overvoltage and threshold are commands/settings, not electrical measurements. Percentage is not power in watts. The analog circuit's 2× gain is not converted to estimated power. A target is not an achieved temperature, and configured overvoltage is not measured instantaneous physical overvoltage. External light, actual voltage and current have no corresponding measurements in this firmware; annotate external interventions.

BF518 event codes include a complete state: 1 initial/general change; 2 thermal controller/target; 3 Peltier output write; 4 bias; 5 threshold; 6 fan; 10 temperature acquisition start; 11–13 cold/heatsink/ambient channel start; 14–16 corresponding result availability; 17 temperature acquisition end; 20 actuator-update start. These software timestamps include channel switching and processing; they are not measured analog trigger times. fifo_overflow_total counts gates lost to a full queue and event_overflow_total counts lost events. Each queue holds at most 63 entries; prolonged host/USB stalls can lose data. Gaps are retained rather than filled with invented samples.

Save curve writes .qcurve v4 with telemetry for the points in the plot. Load curve still reads versions 1–3, without inventing missing telemetry. Plot Export CSV exports the plotted points; use samples.csv for the full recording. Events remain in the separate session file.

Terms: ADC = analog-to-digital converter; DAC = digital-to-analog converter; SiPM = silicon photomultiplier; AD590 = analog temperature sensor; BF518 = camera processor; FIFO = first-in, first-out queue; SCLK = BF518 peripheral clock; USB = Universal Serial Bus; UTC = Coordinated Universal Time; CSV = comma-separated values; JSON = structured metadata format; FAST = single-gate count rate; AVG = weighted rate over up to ten contiguous gates. A count does not necessarily correspond to one incident photon.