Merge pull request #28 from tmytek/Update-TLKCore

Update README for TLKCore
tmytek · Jul 28, 2023 · b36ff95 · b36ff95
2 parents edddfce + 9b2ac37
commit b36ff95
Show file tree

Hide file tree

Showing 56 changed files with 117 additions and 24 deletions.
diff --git a/example_Linux/C_C++/README.md b/example_Linux/C_C++/README.md
@@ -0,0 +1,16 @@
+# Getting Started with C/C++ Sample Code
+
+## Introduction
+
+* Here is a C/C++ fast beam switch example to control BBoxOne 5G via TLKCore, also control USRP to raise SPI signal via UHD driver to BBox.
+* lib_tlkcore_cpp/ includes a tiny C++ wrappper example, it grnerates to libtlkcore_lib.so
+* lib_usrp_spi/ includes UHD application/library and it invoke pre-installed UHD driver to raise SPI transmissions for BBox 5G series, it grnerates to libusrp_fbs.so as default.
+* examples/ is a sample application which using libtlkcore_lib.so and libusrp_fbs.so to achieve BBox fast beam switching.
+
+  ![](../../images/TLKCore_UHD_usage.png)
+
+## Prerequisites
+
+1. Install Python 3.6 or 3.8 or 3.10, and follow reference user guide of [Getting Started with Python Sample Code](https://github.com/tmytek/bbox-api/tree/master/example_Linux/Python/README.md)
+2. For C/C++ supporting, please install related Python packages from lib_tlkcore_cpp/requirements.txt
+    `pip install -r lib_tlkcore_cpp/requirements.txt`
diff --git a/example_Linux/examples/CMakeLists.txt → example_Linux/C_C++/examples/CMakeLists.txt b/example_Linux/examples/CMakeLists.txt → example_Linux/C_C++/examples/CMakeLists.txt
diff --git a/example_Linux/examples/LICENSE.md → example_Linux/C_C++/examples/LICENSE.md b/example_Linux/examples/LICENSE.md → example_Linux/C_C++/examples/LICENSE.md
diff --git a/example_Linux/examples/README.md → example_Linux/C_C++/examples/README.md b/example_Linux/examples/README.md → example_Linux/C_C++/examples/README.md
@@ -9,7 +9,7 @@ This example directory contains two sub directories, please configure to your ow
    * device.conf, it mentions the device infomations for Beamform & UD.
       * Beamform devices with SN as key then includes AAKIT name and the path to beam configruation.
       * UD devices only include SN as key then includes STATE with json format.
-   *. Beam configruation files, i.g. CustomBatchBeams_D2230E013-28.csv.
+         *. Beam configruation files, i.g. CustomBatchBeams_D2230E013-28.csv.
       * You can edit/pre-config it via Office or any text editor, no matter what it is config to one of below options:
         * A whole beam (BeamType=0)
            * beam_db: gain with float type, please DO NOT exceed the DR (dynamic range).