This version is outdated by a newer approved version.
This version (15 Jul 2022 11:32) was approved by Mahesh Phalke.The Previously approved version (14 Jul 2022 14:27) is available.
This version (15 Jul 2022 11:32) was approved by Mahesh Phalke.The Previously approved version (14 Jul 2022 14:27) is available.This is an old revision of the document!
Table of Contents
AD7689 Mbed IIO Application
This page gives an overview of using the ARM Mbed platform supported firmware example with Analog Devices AD7689 Evaluation board(s) and SDP-K1 controller board. This example code leverages the ADI developed IIO (Industrial Input Output) ecosystem to evaluate the AD7689 family devices (AD7689, AD7682, AD7699 and AD7949 -one at a time) by providing a device debug and data capture support. The overview of an entire system is shown below:
IIO oscilloscope is used as a client application running on windows-os, which is ADI developed GUI for ADC data visualization and device debug. The physical interface used for communicating client application with firmware application (IIO device) is UART/VirtualCOM (*For now only SDP-K1 supports high speed VirtualCOM port @1Mbps or higher speed for faster data transmission). The firmware application communicates with IIO device (AD7689) using ADI No-OS drivers and platform drivers middle-ware software libraries. SDP-K1 is used as controller board, on which IIO firmware application runs and using above software libraries, the IIO firmware communicates with target device. The AD7689 eval board is used for development and testing of this application.
Useful links
Hardware Connections
Jumper Settings
- SDP-K1:
Connect the VIO_ADJUST jumper on the SDP-K1 board to 3.3V position to drive SDP-K1 GPIOs at 3.3V - EVAL-AD7689:
Use default
AD7689 uses SPI communication for device parameter access and data capture. SDP-K1 is powered through USB connection from the computer. SDP-K1 acts as a Serial device when connected to PC, which creates a COM Port to connect to IIO Oscilloscope GUI running on windows-os. The COM port assigned to a device can be seen through the device manager for windows-based OS.
SDP-K1 can support high speed VirtualCOM port USB interface, so by default VCOM is configured as default interface in the firmware. The interface can be set to UART by defining macro “USE_PHY_COM_PORT” in the app_config.h file.
Software Downloads
Latest firmware (Use below link):
- TBA
Quick Start to Use Mbed IIO Firmware
If you have some familiarity with the Mbed platform, the following is a basic list of steps required to start running the code, see below for more detail:
- Connect the AD7689 EVAL-board to the SDP-K1 controller board as specified in hardware connections section.
- Connect the SDP-K1 controller board to your computer over USB provided along with SDP-K1 board.
- Import the code into Keil Studio from above firmware download link by using “File→Import Project…” option. Specify the web link of code in URL.
- Right click on the project name and select ‘Set Active Project’ option.
- Fix library import issues by selecting ‘Mbed Libraries’ tab at the bottom side of IDE and then clicking on the ‘Fix all problems’ option. Allow some time to checkout all library dependency.
- Compile the code as shown below:
- After a successful build, a binary will be generated and available for download - store this onto your local drive.
- Drag and drop this binary to the USB drive hosted by your controller board (e.g. SDP-K1) to program the microcontroller.
Libiio: IIO Library
This library provides an abstracted library interface to communicate IIO device and IIO client application (e.g. IIO Oscilloscope) without worrying about the low level hardware details. Download and install below libiio windows installer in your computer.
Libiio installer for Windows (Use below link):
IIO Oscilloscope (Client)
This is a GUI (Graphical User Interface) based IIO client application for data visualization and device configuration/debugging. The data from IIO devices (e.g. ADCs/DACs) is transmitted over Serial/Ethernet/USB link to IIO Oscilloscope client through the abstracted layer of “libiio”.
Download and install below IIO Oscilloscope windows installer in your computer. IIO Oscilloscope installer for Windows (Use below link):
Evaluating AD7689 Using IIO Ecosystem
Ensure that hardware connection has been made properly in between Controller Board (SDP-K1) and AD7689 Eval board. Also ensure all software's (IIO firmware, Libiio windows installer and IIO Oscilloscope windows installer) are downloaded and installed in your computer before trying to communicate with AD7689 device..
Running IIO Oscilloscope (Client)
Open the IIO Oscilloscope application from start menu and configure the serial (UART) settings as shown below. Click on refresh button and AD7689 device should pop-up in IIO devices list.
Click 'Connect' and it should by default open the data ‘Capture’ window. You can drag aside or close this window to see the main ‘Debug and DMM’ tab window.
Configure/Access Device Attributes (Parameters)
The IIO Oscilloscope allows user to access and configure different device parameters, called as 'Device Attributes“. There are 2 types of attributes:
- Device Attributes (Global): Access/Configure common device parameters.
- Channel Attributes (Specific to channels): Access/Configure channel specific device parameters.
How to read and write attribute:
- To 'Read' an attribute, simply select the attribute from a list or press 'Read' button on left side.
- To 'Write' an attribute, select attribute value in the 'value field' and press 'Write' button.
Using DMM Tab to Read DC Voltage on Input Channels
DMM tab can be used read the instantaneous voltage applied on analog input channels. Simply select the device and channels to read and press start button.
*Note: The voltage is just instantaneous, so it is not possible to get RMS AC voltage or averaged DC voltage. Also, when using DMM tab, do not access/use the Data Capture or Debug tab as this could impact data capturing. Both DMM scan and data capture uses different methods of conversion. The DMM data is read using single conversion, while data capture uses continuous conversion mode of operation.
Data Capture from IIO Device
To capture the data from AD7689 IIO device, simply select the device and channels to read/capture data. The data is plotted as “ADC Raw Value” Vs “Number of Samples” and is just used for Visualization. The data is read as is from device without any processing. If user wants to process the data, it must be done externally by capturing data from the Serial link on controller board.
*Note: The DMM or Debug tab should not be accessed when capturing data as this would impact data capturing. Both DMM scan and data capture uses different methods of conversion. The DMM data is read using single conversion, while data capture uses continuous conversion mode of operation.
More info here: Data Capture using IIO App
Time Domain Plot
Frequency Domain Plot
*Note: Max 4096 samples can be selected for plotting frequency domain response due to limited buffer size in the firmware.
Python Environment and Scripts
Data capture, sensor measurement, device calibration, etc. can be achieved with python based IIO clients, using 'pyadi-iio' library. A possible option using ADI's pyadi-iio library in python has been demonstrated in the forthcoming sections. The python scripts are provided along with firmware package.
Setting-up Python Environment
- Install python (64-bit windows) into your local machine. The python scripts are developed and executed using python 3.10.5 version, so recommend using version 3.10.5 or beyond. Download Python
- Once python is installed, make sure the environment path (on windows machine) is set properly. You can verify if python is installed properly by typing “python --version” command on command line tool such as gitbash, command prompt, power shell, etc.
- Install all required support packages by running requirements.txt file using command “python -m pip install -r requirements.txt” from the '/scripts' folder.
Modifying/Running Python Scripts
- All python scripts specific to ad7689 IIO firmware are stored into “scripts” folder present in the project directory. So, any script must be executed from this folder.
- Update the ‘uri’ interface in script according to COM port assigned to your device (sdp-k1).
- Executing the python script by using command “python script_name.py”
AD7689 Firmware Structure
app_config.h
This file can be used to:
- Select the active platform using macro “ACTIVE_PLATFORM_MBED” (Only Mbed is supported)
- Select active device using one of the “DEV_AD7689” Or “DEV_AD7682” Or “DEV_AD7699” Or
- “DEV_AD7949” macro (one at a time).
- Select UART baud rate (for physical UART port) using “IIO_UART_BAUD_RATE” macro. Default is 230400.
- Pin mapping of controller board (SDP-K1) w.r.t. target evaluation board (AD7689).
app_config_mbed.h
This file can be used to:
- Select Mbed compatible board pin mapping w.r.t. Arduino connector (e.g. SDP-K1).
- Enabling VirtualCOM port (for SDP-K1) using macros “USE_VIRTUAL_COM_PORT” and “VIRTUAL_COM_PORT_ID”.
- Define the possible sampling rate (ODR). Should never exceed than default ODR selected using macro
- “SAMPLING_RATE” as this could impact data capture with device.
ad7689_user_config.c/.h
These files define the user configurations for the AD7689, such as SPI parameters (frequency, mode, etc) and other init parameters used by No-OS drivers to initialize AD7689 device (active device, input channel type, reference source, etc) These are the parameters loaded into device when device is powered-up or power-cycled.
ad7689_data_capture.c
This file implements the data capturing logic for the AD7689 device. The adc_data_capture.c module present in platform drivers acts as an abstracted layer for common IIO application data capturing
ad7689_iio.c
This file defines getter/setter functions for all the device and channel specific attributes (related to AD7689 devices) to read/write the device parameters. The majority of device specific functionality is present in this module.
No-OS Drivers for AD7689
The no-os drivers provide the high level abstracted layer for digital interface of AD7689 devices. The complete digital interface (to access memory map and perform data read) is done in integration with platform drivers. The functionality related with no-os drivers is covered in below 2 files:
- ad7689.c
- ad7689.h
resources/tools-software/product-support-software/ad7689_mbed_iio_support.1657877520.txt.gz · Last modified: 15 Jul 2022 11:32 by Mahesh Phalke