From dc7e173120b4d40eb051e6932f979179c6093a6f Mon Sep 17 00:00:00 2001 From: Lars Amsel Date: Fri, 22 May 2020 13:57:56 +0200 Subject: cal: Add doxygen section to explain conversion from and to JSON --- host/docs/calibration.dox | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'host/docs') diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox index 4807515a6..b5f747bd3 100644 --- a/host/docs/calibration.dox +++ b/host/docs/calibration.dox @@ -75,6 +75,31 @@ Calibration files can easily be moved from one machine to another by copying the will replace the existing calibration file. The old calibration file will be renamed so it may be recovered by the user. +\subsection modify_cal_data Modify Calibration Data + +There might be reasons to analyse or modify the calibration data outside UHDs +calibration process. Because the data is stored using FlatBuffers this can be +done without relying on UHD. UHD provides all FlatBuffer schema files in +`/share/uhd/cal`. + +First, install FlatBuffers. The package can be obtained from +https://google.github.io/flatbuffers/. +Once installed, `.cal` files can be converted to JSON using + + flatc --strict-json -t /share/uhd/cal/.fbs -- .cal + +where `.fbs` is the scheme file used for the data, +e.g. `pwr_cal.fbs` for power calibration. `data.cal` is a calibration file in +your working directory. This will generate a `.json` in the same +directory. + +The JSON data can be converted back to binary using + + flatc -b /include/uhd/cal/.fbs .json + +This generates a `.bin` that can be read by the calibration routines +of UHD. To make UHD reading these files you need to rename it to `.cal`. + \subsection calibration_data_csv Converting UHD 3.x calibration data to UHD 4 Older versions of UHD used a CSV-based format for storing calbration data for -- cgit v1.2.3