diff options
author | Lars Amsel <lars.amsel@ni.com> | 2020-05-27 11:36:24 +0200 |
---|---|---|
committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2020-05-27 13:51:54 -0500 |
commit | 60f80f34cb46e40d8dbde5d01d87103660427109 (patch) | |
tree | 712e6bb9d8c729e4cf4ad90187358ddc5b99f1af /host/docs/calibration.dox | |
parent | dc7e173120b4d40eb051e6932f979179c6093a6f (diff) | |
download | uhd-60f80f34cb46e40d8dbde5d01d87103660427109.tar.gz uhd-60f80f34cb46e40d8dbde5d01d87103660427109.tar.bz2 uhd-60f80f34cb46e40d8dbde5d01d87103660427109.zip |
fixup! cal: Add doxygen section to explain conversion from and to JSON
Diffstat (limited to 'host/docs/calibration.dox')
-rw-r--r-- | host/docs/calibration.dox | 10 |
1 files changed, 5 insertions, 5 deletions
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 `<install-path>/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 <install dir>/share/uhd/cal/<flatbuffer>.fbs -- <data>.cal + flatc --strict-json -t <install dir>/share/uhd/cal/<foo>_cal.fbs -- <data>.cal -where `<flatbuffer>.fbs` is the scheme file used for the data, +where `<foo>_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 `<data>.json` in the same directory. The JSON data can be converted back to binary using - flatc -b <install dir>/include/uhd/cal/<flatbuffer>.fbs <data>.json + flatc -b <install dir>/include/uhd/cal/<foo>_cal.fbs <data>.json This generates a `<data>.bin` that can be read by the calibration routines of UHD. To make UHD reading these files you need to rename it to `<data>.cal`. |