From 60f80f34cb46e40d8dbde5d01d87103660427109 Mon Sep 17 00:00:00 2001 From: Lars Amsel Date: Wed, 27 May 2020 11:36:24 +0200 Subject: fixup! cal: Add doxygen section to explain conversion from and to JSON --- host/docs/calibration.dox | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'host/docs') diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox index b5f747bd3..162bd8825 100644 --- a/host/docs/calibration.dox +++ b/host/docs/calibration.dox @@ -77,25 +77,25 @@ 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 +There might be reasons to analyse or modify the calibration data outside UHD's calibration process. Because the data is stored using FlatBuffers this can be -done without relying on UHD. UHD provides all FlatBuffer schema files in +done without relying on UHD. UHD provides all FlatBuffers 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 + flatc --strict-json -t /share/uhd/cal/_cal.fbs -- .cal -where `.fbs` is the scheme file used for the data, +where `_cal.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 + flatc -b /include/uhd/cal/_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`. -- cgit v1.2.3