Skip to content

Commit 12b2167

Browse files
committed
Update READMEs
1 parent 7f928d5 commit 12b2167

File tree

7 files changed

+239
-131
lines changed

7 files changed

+239
-131
lines changed

example_Linux/CSharp/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Prerequisites
44

55
* Python 3
6-
1. Install Python <u>3.6 or 3.8 or 3.10</u> which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), 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) to make sure your Python environment first.
6+
1. Install Python *3.6 or 3.8 or 3.10* which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), 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) to make sure your Python environment first.
77
* Example gives a default libraries for Python 3.8 ([python-3.8.0 64-bit download Link](https://www.python.org/downloads/release/python-380/))
88
2. Extract zip file under the [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release) then copy the whole `lib/` & `logging.conf` to TLKCoreExample/
99
![](../../images/CS_Lib_copy.png)
@@ -23,7 +23,7 @@
2323

2424
## C# sample execution steps
2525

26-
1. [BBoxOne/Lite] Copy your calibration & antenna tables into **files/** under the built folder likes <u>bin/Debug/<u>
26+
1. [BBoxOne/Lite] Copy your calibration & antenna tables into **files/** under the built folder likes *bin/Debug/*
2727
* BBox calibration tables -> **{SN}_{Freq}GHz.csv**
2828
* BBox antenna table -> **AAKIT_{AAKitName}.csv**
2929
2. Launch TLKCoreExample.exe

example_Linux/LabVIEW/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
1-
<style>
2-
th {text-align:start;}
3-
.blue{height:4px;background:#00FFFF}
4-
.navyblue{height:4px;background:#03b585}
5-
</style>
6-
71
# Getting Started with LabVIEW Sample Code
82

93
## Prerequisites
104

11-
1. Install Python <u>3.6 or 3.8 or 3.10</u> which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), TLKCore libraries only support 64bit currently.
5+
1. Install Python *3.6 or 3.8 or 3.10* which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), TLKCore libraries only support 64bit currently.
126
2. According to [Integrating Python Code in LabVIEW](https://www.ni.com/en/support/documentation/supplemental/18/installing-python-for-calling-python-code.html#section-1736000138) to download LabVIEW to maps your Python version. Please download 64bit version not 32bit.
13-
<table width="100%"><tbody><tr><th rowspan="2" width="16%">LabVIEW Version</th><th colspan="6">Python Version</th></tr><tr><th width="14%" class="blue">3.10</th><th width="14%">3.9</th><th width="14%" class="blue">3.8</th><th width="14%">3.7</th><th width="14%" class="blue">3.6</th><tr><th>2023 Q1</th><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>2022 Q3</th><td> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>2021 SP1</th><td> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>2021</th><td> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>2020 SP1</th><td> </td><td> </td><td> </td><td> </td><td class="navyblue"> </td></tr><tr><th>2020</th><td> </td><td> </td><td> </td><td> </td><td class="navyblue"> </td></tr><tr><th>2019 SP1</th><td> </td><td> </td><td> </td><td> </td><td class="navyblue"> </td></tr><tr><th>2019</th><td> </td><td> </td><td> </td><td> </td><td class="navyblue"> </td></tr><tr><th>2018 SP1</th><td> </td><td> </td><td> </td><td> </td><td class="navyblue"> </td></tr></tbody></table>
14-
<table width="100%"><tbody><td class="navyblue"> </td></tbody></table> Compatible
7+
![](../../images/table_labview.svg)
8+
159
3. Extract zip file under the [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release)
1610
4. Create the new directory named **files**
1711
![](../../images/TLKCore_release.png)
1812
5. [BBoxOne/Lite] Copy your calibration & antenna tables into **files/** under the [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release)
1913
* BBox calibration tables -> **{SN}_{Freq}GHz.csv**
2014
* BBox antenna table -> **AAKIT_{AAKitName}.csv**
2115

22-
P.S. The following example executes <u>LabVIEW 2021 64bit & Pyhton 3.8 64bit</u> on Windows 10
16+
P.S. The following example executes ==LabVIEW 2021 64bit & Pyhton 3.8 64bit== on Windows 10
2317

2418
## LabVIEW sample execution steps
2519

2620
1. Double-click BBox.vi or **TLKCore.lvproj** then BBox.vi.
2721
![](../../images/LabVIEW_BBoxOne_1.png)
28-
2. Please check fields under the description with <font color=#0000FF>BLUE</font> color
22+
23+
2. Please check fields under the description with ==BLUE== color
2924
1. Python version
3025
* Choose/edit the Python version you want to test.
3126
2. Module path
@@ -44,4 +39,5 @@ P.S. The following example executes <u>LabVIEW 2021 64bit & Pyhton 3.8 64bit</u>
4439
* Gain(dB): this example only provides the **MAX value of dynamic range** or you can modify to your setting via modifying Block Diagram of LabVIEW
4540
3. 'Run' it.
4641
4. Expected result shall be
47-
![](../../images/LabVIEW_BBoxOne_success.png)
42+
![](../../images/LabVIEW_BBoxOne_success.png)
43+

example_Linux/MATLAB/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
## Prerequisites
44

5-
1. Install Python <u>3.6 or 3.8 or 3.10</u> which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), 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) to make sure your Python environment first.
5+
1. Install Python *3.6 or 3.8 or 3.10* which mapping with [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release), 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) to make sure your Python environment first.
66
2. According to [Versions of Python Compatible with MATLAB Products by Release](https://www.mathworks.com/support/requirements/python-compatibility.html) to download MATLAB to maps your Python version.
7-
<table width="100%"><tbody><tr><th rowspan="2" width="16%">MATLAB Version</th><th colspan="6">Python Version</th></tr><tr><th width="14%" class="blue">3.10</th><th width="14%">3.9</th><th width="14%" class="blue">3.8</th><th width="14%">3.7</th><th width="14%" class="blue">3.6</th><tr><th>R2023b</th><td class="navyblue"> </td><td class="navyblue"> </td><td> </td><td> </td><td> </td></tr><tr><th>R2023a</th><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td></td><td></td></td></tr><tr><th>R2022b</th><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td><td> </td> </td></tr><tr><th>R2022a</th><td> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td> </td></tr><tr><th>R2021b</th><td> </td><td class="navyblue"> </td><td class="navyblue"> </td><td class="navyblue"> </td><td> </td></tr><tr><th>R2021a</th><td> </td><td> </td><td class="navyblue"> </td ><td class="navyblue"> </td><td> </td></tr><tr><th>R2020b</th><td> </td><td> <td class="navyblue"> </td></td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>R2020a</th><td> </td><td> </td><td> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr><tr><th>R2019b</th><td> </td><td> </td><td> </td><td class="navyblue"> </td><td class="navyblue"> </td></tr></tbody></table><table width="100%"><tbody><td class="navyblue"> </td></tbody></table> Compatible for MATLAB Interface/MATLAB Engine
7+
![](../../images/table_matlab.svg)
88
3. Extract zip file under the [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release)
99
4. Create the new directory: files
1010
![](../../images/TLKCore_release.png)
1111
5. [BBoxOne/Lite] Copy your calibration & antenna tables into **files/** under the [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release)
1212
* BBox calibration tables -> **{SN}_{Freq}GHz.csv**
1313
* BBox antenna table -> **AAKIT_{AAKitName}.csv**
1414

15-
P.S. The following example executes <u>MATLAB R2021b & Pyhton 3.8</u> on Windows 10
15+
P.S. The following example executes ==MATLAB R2021b & Pyhton 3.8 64bit== on Windows 10
1616

1717
## MATLAB sample execution steps
1818

1919
1. Copy **TLKCoreExample.m** to extracted/unzipped directory of [TLKCore_release](https://github.com/tmytek/bbox-api/tree/master/example_Linux/TLKCore_release)
2020
![](../../images/MATLAB_1.png)
21+
2122
2. Double-click TLKCoreExample.m to launch MATLAB process.
2223
3. Press **Run** to execute.

example_Linux/MATLAB/table.svg

Lines changed: 0 additions & 113 deletions
This file was deleted.

example_Linux/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The **.pyd** format release is for Windows shared library and **.so** format rel
1818

1919
#### Software
2020

21-
* **TLKCoreService** is <u>main entry</u> for developer, all of operations/functions must passed by TLKCoreService, e.g. scanDevices(), initDev().
21+
* **TLKCoreService** is ==main entry== for developer, all of operations/functions must passed by TLKCoreService, e.g. scanDevices(), initDev().
2222
* TMYCommService is maintaining physical communications for all devices, it usually not handled directly by developer.
2323
* TMYUtils defines all data structure for return data, let developer more easier to know current status of processed function.
2424
* **TMYPublic** is a open source code, it defines all data structure which developer might used, e.g. RFMode(TX/RX), RetCode(OK/ERROR/...), UDState...etc.

images/table_labview.svg

Lines changed: 112 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)