This version (27 Dec 2022 07:46) was approved by Mahesh Phalke.The Previously approved version (27 Dec 2022 07:20) is available.
Table of Contents
AD7606 IIO Application
Introduction
This page gives an overview of using the ARM platforms supported (default is Mbed) firmware application with Analog Devices AD7606 Evaluation board(s) and SDP-K1 controller board. This example code leverages the ADI developed IIO (Industrial Input Output) ecosystem to evaluate the AD7606 family devices by providing a device debug and data capture support.
IIO oscilloscope is used as client application running on Windows-os, which is ADI developed GUI for ADC data visualization and device debug. The interface used for communicating client application with firmware application (IIO device) is UART (Note: SDP-K1 can also support high speed VirtualCOM port @1Mbps or higher speed for faster data transmission). The firmware application communicates with IIO device using ADI No-OS drivers and platform drivers low level software layers. SDP-K1 is used as controller board, on which IIO firmware application runs and using above software libraries, the IIO firmware communicates with IIO device.
Useful links
Hardware Connections
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-AD7606B-FMCZ:
- Make below jumper settings on the board. Refer EVAL-AD7606B-FMCZ User Manual for more details.
Arduino Connections:
The AD7606 device is configured in “Serial Software” mode in the firmware. AD7606 uses SPI communication for device register access and data capture.
For data transmission to IIO client, VirtualCOM Or UART serial communication is used. SDP-K1 by default uses the VCOM serial interface for higher speed data transmission.
SDP-K1 is powered through USB connections 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.
*Note: Actual COM port number for your device may not be the same as shown above. Therefore, always check your SDP-K1 serial COM port number before connecting to IIO client.
Software Downloads
MBED Firmware
This section briefs on the usage of MBED firmware. This also explains the steps to compile and build the application using mbed and make based build.
Source code is hosted here:
Build Guide for Precision Converters MBED firmware (Use below link):
Libiio: IIO Library
This library provides an abstracted library interface to communicate IIO device and IIO client application (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 (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 AD7606 Using IIO Ecosystem
Ensure that hardware connection has been made properly in between Controller Board (SDP-K1) and ADC 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 the 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 AD7606 device should pop-up in IIO devices list. Click 'Connect' and select the AD7606 device from the drop down menu list of 'Device Selection'.
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 e.g. oversampling rate, operating mode
- Channel Attributes (Specific to channels): Access/Configure channel specific device parameters e.g. channel range, offset, calibration, open circuit detection, etc.
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, write a attribute value in the 'value field' and press 'Write' button. The value to be written corresponds to expected bit-field for that parameter, specified in the datasheet. For example, below figure shows how to write a “Oversampling” value.
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, it is not encouraged to use Data Capture or Debug tab as this could impact data capturing.
Data Capture from IIO Device
To capture the data from AD7606 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.
More info here: https://wiki.analog.com/resources/tools-software/product-support-software/data-capture-using-iio-app
The continuous time domain data capture can work correctly at ODR/Sampling Rate defined in the firmware code (32KSPS) and also at 0 Oversampling Rate. For plotting frequency domain response max 4096 samples can be selected due to limited buffer size in the firmware. These limitations are due to the firmware architecture and design choices and does not limit the actual device specifications provided in device datasheet
Time Domain:
Frequency Domain:
Calibrating AD7606B/C Devices
ADC Gain Calibration:
ADC gain calibration can be done in 3 easy steps as mentioned below. The gain calibration needs to be done for selected gain filter register as specified in the datasheet (refer 'System Gain Calibration' section from the AD7606B/C datasheet). The gain calibration can be done for each channel depending upon the filter resistor placed in series with each channel analog input.
Reference: File: iio_ad7606.c, Function: get_chn_calibrate_adc_gain()
ADC Offset Calibration:
ADC offset calibration should only be done when ADC input is 0V. The purpose is to reduce any offset error from the input when analog input is at 0V level. The ADC offset calibration can be done for each input channel.
To perform ADC offset calibration, select the 'calibrate_adc_offset' attribute. It should automatically perform the calibration. Also, if 'Read' button is pressed, the calibration should happen one more time.
Reference: File: iio_ad7606.c, Function: get_chn_calibrate_adc_offset()
Open Circuit Detection on AD7606B Device
AD7606B device provides an open circuit detection feature for detecting the open circuit on each analog input channel of ADC.
There are 2 modes to detect open circuit on analog inputs (Refer AD7606B datasheet for more details):
- Manual Mode
- Auto Mode
Manual Mode Open Circuit Detect:
The manual open circuit detection needs 'Rpd' to be placed at analog input as shown in figure below. The firmware is written to perform the open circuit detection @50Kohm of Rpd value. The common mode change threshold has been defined as 15 ADC count in the firmware at above specified configurations (as specified in the datasheet).
Reference: File: iio_ad7606.c, Function: get_chn_open_circuit_detect_manual()
Auto Mode Open Circuit Detect:
The auto open circuit detection on each individual ADC channel can be done by performing 3 easy steps mentioned in below screenshot.
Reference: File: iio_ad7606.c, Function: get_chn_open_circuit_detect_auto()
Diagnostic Multiplexer on AD7606B/C Devices
Using diagnostic multiplexer on AD7606B/C devices, the internal analog inputs can be sampled to provide a diagnostic voltages and parameters on IIO client application such as reference voltage (vref), DLO voltage (ALDO/DLDO), temperature and drive voltage (vdrive).
*Note: The diagnostic mux control must operate when input range is +/-10V
Python Environment and Scripts
Data capture 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
- Please install python into your local machine. The python scripts are developed and executed using python 3.9.0 version, so recommend using version 3.9.0 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 the “pyadi-iio” python package by executing command “python -m pip install pyadi-iio”. Detailed guide on installing it is available in Python Interfaces for ADI Hardware
*Make sure to install additional support packages by running requirements.txt file using command “python -m pip install -r requirements.txt from “scripts/” directory”
Modifying/running Python Scripts
- All python scripts specific to the 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). Default COM port is set to COM16 in all scripts.
Output Obtained from the Python Script
While executing the adxxxx_data_capture.py, the command prompt requests for the number of samples to be entered by the user.
On Entering the number of samples n, on successful completion of capturing n samples, the data points are stored in a csv as adc_data_capture.csv in the folder where the script is present.
Modifying Firmware
The below block diagram shows the AD7606 IIO firmware layer.
app_config.h
This file can be used to:
- Select the 'Active Device' to evaluate by changing '#define DEV_AD7606B' macro. Default active device is AD7606B.
- Configure the pin mapping of AD7606 w.r.t Arduino Header on Controller Board.
ad7606_user_config.c
This file defines the user configurations for the AD7606, such as SPI parameters (frequency, mode, etc) and other init parameters used by No-OS drivers to initialize AD7606 device (e.g. required GPIOs, software/hardware mode, etc). These are the parameters loaded into device when device is powered-up or power-cycled.
iio_ad7606.c
This file defines getter/setter functions for all the device and channel specific attributes (related to AD7606 devices) to read/write the device parameters. The majority of device specific functionality is present in this module.
iio_ad7606_data_capture.c
This file defines the data capture implementation of AD7606 for visualizing adc raw data on IIO oscilloscope.
No-OS Drivers for AD7606
The no-os drivers provide the high level abstracted layer for digital interface of AD7606 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:
- ad7606.c
- ad7606.h
It is hoped that the most common functions of the AD7606 family are coded, but it's likely that some special functionality is not implemented. Feel free to consult Analog Devices Engineer-Zone for feature requests, feedback, bug-reports etc.
resources/tools-software/product-support-software/ad7606_mbed_iio_application.txt · Last modified: 27 Dec 2022 07:45 by Mahesh Phalke