Diagnostics Logs

Diagnostics Logs can be downloaded using the new DownloadFile method. This method is introduced in CameraSDK 3.1. It provides a better way to get camera diagnostics used by Phase One Support to diagnose issues. This feature does not require any new firmware version to be present on the camera.

Before the previous CameraSDK 3.0, these logs could only be obtained by letting the camera write them to the local storage card. This meant the feature had to be enabled beforehand.

With this API, you can always download the latest diagnostics logs from the camera. Nothing has to be enabled beforehand.

Getting a log

Beginning with iXM firmware version 5.10, we introduced a new System Diagnostic feature that collects more extensive diagnostic logs, even across power cycles. This means your issue could have happened yesterday, and you can still (today) extract the system diagnostics logs containing the problem.

To download and save the diagnostics log to a file from an iXM running 5.10 or later:

bool success = camera.DownloadFile(DownloadFileId::SystemDiagnosticLog, "/path/to/log/file");

camera.DownloadFile(DownloadFileId.SystemDiagnosticLog, "/path/to/log/file");

For all other cameras (IQ4, P5, etc.), or for iXMs running firmware earlier than 5.10, the API call is slightly different.

bool success = camera.DownloadFile(DownloadFileId::DiagnosticLog, "/path/to/log/file");

camera.DownloadFile(DownloadFileId.DiagnosticLog, "/path/to/log/file");

Note that the legacy (non-System) diagnostics are not persisted across power cycles. You must reproduce the issue during the same power cycle in which you call the diagnostics API.

Caution

Even though FileTransfer* notifications exist, the DownloadFile API does not support them.

When downloading files, you will not receive any progress notifications. In contrast, the UploadFile API will provide these progress notifications!

This will create and write a file at /path/to/log/file and return true on success. This file can then be sent to Phase One Support.

The DownloadFile method uses an enum to define the file you wish to download. This approach allows us to add new files to the download API in future feature additions.

Note

Diagnostics Log files are not human readable text files. Their purpose is to be parsed by the Phase One Support Team.