This version is outdated by a newer approved version.
This version (06 Jul 2022 10:09) is a draft.
Approvals: 0/1The Previously approved version (24 Jun 2022 16:10) is available.
This version (06 Jul 2022 10:09) is a draft.Approvals: 0/1The Previously approved version (24 Jun 2022 16:10) is available.
This is an old revision of the document!
Table of Contents
AD4130 Mbed IIO Application
Introduction
This page gives an overview of using the ARM Mbed platform supported firmware example with Analog Devices AD4130 Evaluation board and SDP-K1 controller board. This example code leverages the ADI developed IIO (Industrial Input Output) ecosystem to evaluate the AD4130 device 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 (AD4130) 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 AD4130 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-AD4130:
ad4130_evb_jumper_settings.xlsx
AD4130 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.
Software Downloads
Latest firmware (Use below link):
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 AD4130 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.
- Unzip the ‘ad4130_iio-application.zip’ file provided by Analog Devices onto your local folder.
- Import the code into Keil Studio Cloud IDE (web compiler) by drag and drop of this unzipped folder into web IDE. This shall create a new project with same name as folder name onto web IDE.
- Right click on the project name and select ‘Set Active Project’ option.
- Unordered List ItemFix 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 (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 AD4130 Using IIO Ecosystem
Ensure that hardware connection has been made properly in between Controller Board (SDP-K1) and AD4130 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 AD4130 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 AD4130 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 AD717x 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
Data capturing utilizes two modes:
- Normal sequencer: In this mode, the channel for which data to be captured are enabled and automatically added into a sequencer. The sequencer operates in the continuous conversion mode. After each conversion, an interrupt signal attached to configured INT source is triggered and conversion result is read into a internal acquisition buffer.
- FIFO mode: This mode uses the internal FIFO of device to store the ADC samples. The conversion happens in continuous conversion mode and an interrupt signal attached to configured INT source is triggered when internal FIFO becomes full (reached to watermark limit). The data from FIFO is read periodically when FIFO is made available by device. The FIFO is operated in ‘Oldest Save’ mode as there must be enough time provided to read the FIFO after it becomes full. If FIFO is operated into streaming mode, the previous data could get overwritten before it is being acquired by the firmware.
Time Domain Plot
*Note: Due to low sampling rate (50SPS) for temperature sensor measurement, select 50 or less samples during data capturing for sensor demo mode channels.
Frequency Domain Plot
*Note: Max 4096 samples can be selected for plotting frequency domain response due to limited buffer size in the firmware.
Access Register map of IIO Device
Sensor Demo Modes
AD4130 IIO firmware provides support for interfacing different sensors to analog inputs and perform the measurement on them. Below sensor demo modes are supported in the firmware.
- User Default Config (All channels test)
- 2-wire/3-wire/4-wire RTD (Default is PT100)
- Thermistor (Default is 10K NTC)
- Thermocouple (Default is T type TC and PT1000 RTD as CJC)
- Load Cell (4-wire bridge)
- Noise Test (AIN0-AIN1 shorted)
- ECG
- Power Test (ADC internal channels voltage/current measurement)
*Note: The selection of default sensor types can be changed from ‘ad4130_temperature_sensor.cpp’ file to large extent and from respective user config header files to some extent.
Demo Mode Selection
The sensor mode selection is done from “app_config.h” file using “ACTIVE_DEMO_MODE_CONFIG” macro. The selection is done at compilation time, that means only one sensor demo mode is active at a time. Whenever demo mode is changed from app_config.h file, the code must be compiled again to generate a new binary file for that.
Demo Mode User Configuration:
Firmware maintains the unique user configuration file for each sensor demo mode as per below table. The configurations can be updated by using .c and .h user config files.
Sensor Measurement
Sensor measurement for RTD, Thermistor, Thermocouple, Noise Test, ECG, Power Test and User Default Config can be done using the IIO oscilloscope GUI client application or by executing python scripts from the ‘scripts’ folder. Temperature result for RTD, TC and Thermistor would be in degree Celsius. The result for other configs would in voltage/current.
Sensor measurement for Load Cell can be done by executing the python script available in the project “scripts” folder. IIO oscilloscope can only support measurement for voltage, current and temperature quantities and hence python code is developed to support measurement for other sensor types.
The python script can be executed from ‘Visual Studio Code’ or any other preferred IDE/console prompt application using “python script_name.py” command as shown below. The demo config is fetched from the firmware by establishing serial (UART/VCOM) connection between host and MCU (sdp-k1). Refer next section to install necessary python tools and updating/executing the python scripts.
Sensor Channels Calibration
It is possible to calibrate the device channels which are connected to external sensors. The sensors calibration (gain and offset) is done by executing the python script “ad4130_calibration.py”.
Python Environment and Scripts
Setting-up Python Environment
- Please install python into your local machine. The python scripts are developed and executed using python 3.8.0 version, so recommend using version 3.8.0 or beyond.
Download Python | Python.org
- 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 here: analogdevicesinc/pyadi-iio: Python interfaces for ADI hardware with IIO drivers (aka peyote) (github.com).
*Make sure to install additional support packages by running requirements.txt file using command “python -m pip install -r requirements.txt”
Modifying/Running Python Scripts
- All python scripts specific to ad4130 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”
AD4130 Firmware Structure
app_config.h
- Select the AD4130 device package (either LFCSP or WLCSP). Default is LFCSP. The corresponding hardware board must be used with software selected package type.
- Select demo config mode (e.g. Thermistor, 2-wire RTD, etc).
- Select data capture mode (Continuous, Burst, FIFO).
- Select UART/VCOM (only for SDP-K1).
ad4130_user_config.c
This file defines the user configurations for the AD4130, such as SPI parameters (frequency, mode, etc) and other init parameters used by No-OS drivers to initialize AD4130 device (e.g. required GPIOs, software/hardware mode, etc). These are the parameters loaded into device when device is powered-up or power-cycled.
ad4130_data_capture.c
This file implements the data capturing logic for the AD4130 device. The data capturing can be done using normal ‘Sequencer’ Or using internal ‘FIFO’. Enable the macro ‘FIFO_ENABLED’ for enabling FIFO mode.
ad4130_iio.c
This file defines getter/setter functions for all the device and channel specific attributes (related to AD4130 devices) to read/write the device parameters. The majority of device specific functionality is present in this module.
No-OS Drivers for AD4130
The no-os drivers provide the high level abstracted layer for digital interface of AD4130 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:
- ad413x.c
- ad413x.h
resources/eval/user-guides/ad4130/mbed_iio_app.1657094959.txt.gz · Last modified: 06 Jul 2022 10:09 by Mahesh Phalke