Question 1

Produce and Edit Python Sample Code

Accepted Answer

Python sample code can be generated from the ADRV9001 TES GUI. All settings from TES are preserved in the sample code. 
 Requirements: 
 
 Python 3.11 
 Pythonnet 3.0.1 package 
 ADRV9001 evaluation platform 
 ADRV9001 TES GUI Note: At the install of TES make sure to enable the Python SDK option in order for Python wrappers to be included in the package 
 
 1. Generate the sample code 
 To generate Python Sample code, select the Sample Code prompt at the top of the TES GUI, once selected scroll to Python and select, you will be prompted to save the file in a location, preferably we would like to save the file within the production folder. 
 
 To save properly access the location where TES was installed, select adrv9001-sdk, then pkg, then production. When in the production folder you will want to create a folder for the python code to be generated in. Once created select folder and let generate in the folder. Python code should now be generated within the folder you created make sure main file is included in generation. 
 2. Run the Python application 
 To run the Python code select the main file and open in an IDE of your choice. Create a new Python project in your IDE. After the project is created, enter the main.py file and run the file. 
 There should be no errors seen. T o know that the code runs properly in the terminal it will prompt you to select the enter key to start transmitting if transmission occurs code is running properly.

Troubleshooting 
 
 Pythonnet not installed: 
 Error: "ModuleNotFoundError: No module named 'pythonnet'" Ensure that pythonnet version 3.0.1 is installed correctly. Pip can be used to install this package: 'python -m pip install "pythonnet==3.0.1"' 
 
 adrv9001 python wrappers not installed: 
 Error: "ModuleNotFoundError: No module named 'adrv9001_python_wrappers'" 
 Python wrappers for ADRV9001 are installed during TES GUI installation. If 'optional python package' wasn't selected, the wrappers won't be installed. 
 Re-install TES GUI and ensure 'optional python package' checkbox is selected 
 Ensure that Python 3.11 is used. This can be checked in cmd with command 'python --version'. Check the system and user environment variable to put the correct version of python on the PATH.* 
 * If the python version in cmd is not 3.11.X, search "environment variables" in Windows search. 
 
 Open the control panel application that shows up called "Edit the system environment variables". 
 Click button labelled "Environment Variables..." near the bottom of the window. 
 In System variables, select the "Path" variable, and click Edit. 
 A specific version of Python should be there, change the directory of Python to wherever you have Python 3.11 installed. 
 Click "OK" and restart your computer. 
 When typing python --version in cmd, it should now be Python 3.11. 
 Please try installing the Optional Python SDK again through the TES installer.

Question 2

Produce and Edit MATLAB Sample Code

Accepted Answer

MATLAB sample code can be generated from the ADRV9001 TES GUI. All settings from TES are preserved in the sample code. 
 Requirements: 
 
 MATLAB v2022b or higher 
 ADRV9001 evaluation platform 
 ADRV9001 TES GUI

1. Generate the sample code 
 Open TES GUI and successfully connect and program the device. Then, in the sample code menu, choose MATLAB and save the files to your desired folder. 
 
 2. File structure 
 All required files will be saved from TES. The main operations of the device are split into convenient files. main.m is the main program file which will call the other files. Open main.m. 
 
 There is some setup code for the FPGA at the beginning of the file and then each of the other functions are called in turn: 
 
 3. Run the code 
 From the main.m file, press the run button. A connection will be established and then the device will start to be configured. There will be several user inputs for the program to run. 
 When the program finishes successfully, you will see an output of the ADRV9001Device object 
 
 4. MATLAB Documentation 
 For existing users of the MATLAB sample code, they will notice in the format of the code from SDK 24 onwards. A 'MATLAB wrapper' was created to add functionality and improve user experience for the MATLAB sample code. 
 The main added feature was the addition of built-in documentation. In MATLAB, to access the 'help' functionality, it is required to target the object itself instead of an instance of the object. In this case, see below. analog_devices_eval_client_adrv9001_device is the object to target. 
 
 To access the help menu, simply call "help analog_devices_eval_client_adrv9001_device". Documentation is available for all the supported APIs. Follow the links in the help menu to find the needed API. 
 
 5. Editing the Code 
 As an example, suppose we would like to change the Tx attenuation. The Tx attenuation is set in the "beginTransmitting.m" file: 
 
 From the API call itself, it's not necessarily clear what is needed to change the attenuation. We will use the documentation to help. 
 From the help menu, click on 'Tx'. Another menu will appear: 
 
 Click on the bottom link to access the documentation. Another window will appear: 
 
 This window contains all the APIs related to 'Tx'. In this case, click on 'attenuation_set'. 
 
 Now, all the documentation for this API is listed. Towards the bottom, the parameters of the function are described. In this case, we can see the last parameter is 'attenuation_md_b' which is what we are interested in changing. 
 Using this information, we can now edit the function to have 12dB attenuation as such: 
 
 Run the code again to ensure it works correctly.

Question 3

Produce and Compile Sample C99 Code

Accepted Answer

This guide will detail the process for generating sample C99 code to perform a set of user defined tasks and then how to compile this code on the ZC706 FPGA platform. Successfully completing this step is crucial part in the process of designing and implementing your own custom platform for the ADRV9001. 
 Step 1: Configure and Program the Device 
 For this task any setup will work. Everything you do in TES saves the relevant API calls to a log file in the order you called them, so it&rsquo;s advisable to rehearse your setup a few times before producing C99 code just to make sure you don&rsquo;t include API calls that were mistakes. For this example, we&rsquo;ll use an LTE setup in FDD mode. 
 
 Quite literally any configuration that programs and functions in your tests with TES will work for this. Set the Carries tab as your application requires, here we&rsquo;ll simulate a high-frequency application using the 2A Evaluation Board (the 3GHz &ndash; 6GHz version): 
 
 And similarly, setup every other tab as your application requires. As long as you can press the &ldquo;Program&rdquo; button and have the part operate as expected when transmitting / receiving producing sample code will work. Once you&rsquo;re ready, press &ldquo;Program&rdquo;. 
 
 Step 2: Go through your application 
 This step is rather unspecific, whatever it is your application requires the part do, do that. Every task you perform from here is recorded, so having rehearsed this part in detail will help avoid unnecessary API&rsquo;s from being called. Go through your application, turn on and off the Tx / Rx, set and adjust the Tx Attenuation and the Rx Gain, step through a frequency hopping table, everything will be recorded. For this example, we&rsquo;ll turn on the Tx, then the Rx, before switching off the Tx and then the Rx.

If you&rsquo;re so inclined you can verify your Tx output and Rx config using a spectrum analyser and a signal generator respectively, however this verification should have been completed well in advance of starting this guide. 
 Once finished, be certain the stop any RF activity (Tx or Rx). For best results when generating code, it&rsquo;s recommended to be in the Primed state. If you&rsquo;re in any doubt about what state you&rsquo;re in, press View -> Radio State

These radio buttons re interactable, so if anything is in a state which is not Primed, simply press the Primed button for that channel. Bear in mind again, anything you do here will be saved to the log file and, thus, to the generated C99 code. 
 Step 3: Generate Code 
 Simply press Sample Code -> {Language of Choice}. You can of course choose whichever language you plan to develop your application in, for this example we&rsquo;ll use C99.

Feel free to inspect the code here. Most of it will make sense just from reading, certain files (like initialize.c) are a bit more obscure. For the time being however do not edit these files . When you&rsquo;re developing your own HAL and pushing to your own custom platform these files will need editing, but for now they should remain exactly as they are. 
 Step 4: Copy Source Code to FPGA 
 Press the Disconnect button in TES, being certain to leave the FPGA powered on with the ethernet cable connected. Navigate to the folder where the Analog Devices SDK is installed. If all defaults were selected during installation it should be in: C:\Program Files (x86)\Analog Devices\adrv9001-sdk. From there go into \pkg\production. From this folder we can upload generated C code to the FPGA platform, and to our own custom platform further down the line. 
 
 * Note : The &ldquo;test1&rdquo; folder shown here will not be in your directory by default. Add it now. Copy the code from your Sample Code folder and paste it into test1. This folder can be named anything you want, but &ldquo;test1&rdquo; is the name expected by our software tool. 
 The python file &ldquo;compile_on_platform.py&rdquo; is what we&rsquo;ll use to copy our source code to the FPGA. We&rsquo;ll need a Python 2.7 interpreter and the paramiko module installed. Be certain to read the &ldquo;README.md&rdquo; file in this folder to understand the requirements for running this python file. Run this file however you find best, here we&rsquo;ll use a Windows terminal to call the Python interpreter. 
 * Note: If you have compiled any code to the FPGA before you must remove it before compiling new code, as not doing so will cause versioning errors at compile time. Use PuTTY to log in to the FPGA via SSH (shown in more detail in Step 5 ) and do the following before proceeding:

For the FPGA platform all default values will be acceptable. For your own custom platform, you will need to adjust the connection info. 
 Step 5: Compile and Run your Code 
 Login via PuTTY as specified in the User Guide: (username: root, password: analog)

Navigate the folder structure as shown:

Now simply call &ldquo;make&rdquo; and let it compile. If any bugs appear, you will have to track down the cause of the issue and correct it manually. 
 Once compiling has completed successfully the test1 folder will have some new files in it, most notably is an executable called &ldquo;example&rdquo;: 
 
 This executable will perform exactly the same tasks you outlined in TES at the beginning of this guide, only quicker. Simply type &ldquo;./example&rdquo; and allow it to run. Monitor your Tx output (if you programmed one into this body of code) to verify that it has run as expected: 
 
 At this point we have successfully generated C99 code to handle a specific use-case and compiled it onto our host ZC706 platform.

Electronic Design Services - PartnerZone

Produce Sample Code