Wiki

This version (24 Jan 2021 17:53) was approved by Dragos Bogdan.The Previously approved version (24 Jan 2021 17:45) is available.Diff

AD5933 - No-OS Driver for Renesas Microcontroller Platforms

Supported Devices

Evaluation Boards

Overview

The AD5933 is a high precision impedance converter system solution that combines an on-board frequency generator with a 12-bit, 1 MSPS, analog-to-digital converter (ADC). The frequency generator allows an external complex impedance to be excited with a known frequency. The response signal from the impedance is sampled by the on-board ADC and a discrete Fourier transform (DFT) is processed by an on-board DSP engine. The DFT algorithm returns a real (R) and imaginary (I) data-word at each output frequency.

Once calibrated, the magnitude of the impedance and relative phase of the impedance at each frequency point along the sweep is easily calculated. This is done off chip using the real and imaginary register contents, which can be read from the serial I2C interface.

A similar device, also available from Analog Devices, Inc., is the AD5934, a 2.7 V to 5.5 V, 250 kSPS, 12-bit impedance converter, with an internal temperature sensor and is packaged in a 16-lead SSOP.

Applications

  • Electrochemical analysis
  • Bioelectrical impedance analysis
  • Impedance spectroscopy
  • Complex impedance measurement
  • Corrosion monitoring and protection equipment
  • Biomedical and automotive sensors
  • Proximity sensing
  • Nondestructive testing
  • Material property analysis
  • Fuel/battery cell condition monitoring

01 Oct 2012 11:43 · Dragos Bogdan

The goal of this project (Microcontroller No-OS) is to be able to provide reference projects for lower end processors, which can't run Linux, or aren't running a specific operating system, to help those customers using microcontrollers with ADI parts. Here you can find a generic driver which can be used as a base for any microcontroller platform and also specific drivers for different microcontroller platforms.

Driver Description

The driver contains two parts:

  • The driver for the AD5933 part, which may be used, without modifications, with any microcontroller.
  • The Communication Driver, where the specific communication functions for the desired type of processor and communication protocol have to be implemented. This driver implements the communication with the device and hides the actual details of the communication protocol to the ADI driver.

The Communication Driver has a standard interface, so the AD5933 driver can be used exactly as it is provided.

There are three functions which are called by the AD5933 driver:

  • I2C_Init() – initializes the communication peripheral.
  • I2C_Write() – writes data to the device.
  • I2C_Read() – reads data from the device.

I2C driver architecture

The following functions are implemented in this version of AD5933 driver:

Function Description
char AD5933_Init(void) Initializes the communication peripheral.
void AD5933_SetRegisterValue(unsigned char registerAddress, unsigned long registerValue, unsigned char bytesNumber) Writes data into a register.
unsigned long AD5933_GetRegisterValue(unsigned char registerAddress, unsigned char bytesNumber) Reads the value of a register.
void AD5933_Reset(void) Resets the device.
void AD5933_SetSystemClk(char clkSource, unsigned long extClkFreq) Selects the source of the system clock.
void AD5933_SetRangeAndGain(char range, char gain) Selects the range and gain of the device.
float AD5933_GetTemperature(void) Reads the temperature from the part and returns the data in degrees Celsius.
void AD5933_ConfigSweep(unsigned long startFreq, unsigned long incFreq, unsigned short incNum) Configures the sweep parameters: Start frequency, Frequency increment and Number of increments.
void AD5933_StartSweep(void) Starts the sweep operation.
double AD5933_CalculateGainFactor(unsigned long calibrationImpedance, unsigned char freqFunction) Reads the real and the imaginary data and calculates the Gain Factor.
double AD5933_CalculateImpedance(double gainFactor, unsigned char freqFunction) Reads the real and the imaginary data and calculates the Impedance.
01 Oct 2012 15:20 · Dragos Bogdan

Downloads

Renesas RL78G13 Quick Start Guide

This section contains a description of the steps required to run the AD5933 demonstration project on a Renesas RL78G13 platform.

Required Hardware

Required Software

Hardware Setup

A PmodIA has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G13:

  PmodIA J1 connector Pin SCL → YRDKRL78G13 J9 connector Pin 1
  PmodIA J1 connector Pin SDA → YRDKRL78G13 J9 connector Pin 3
  PmodIA J1 connector Pin GND → YRDKRL78G13 J6 connector Pin 4
  PmodIA J1 connector Pin VCC → YRDKRL78G13 J6 connector Pin 3

Reference Project Overview

The reference project:

  • reads the temperature from AD5933 part;
  • initializes and start a sweep operation;
  • calculates the gain factor for an impedance of 47k;
  • calculates the impedance between the VOUT and VIN pins;
  • displays the temperature and the impedance on the LCD.

Software Project Tutorial

This section presents the steps for developing a software application that will run on the Renesas Demo Kit for RL78G13 for controlling and monitoring the operation of the ADI part.

  • Run the IAR Embedded Workbench for Renesas RL78 integrated development environment.
  • Choose to create a new project (Project – Create New Project).
  • Select the RL78 tool chain, the Empty project template and click OK.

  • Select a location and a name for the project (ADIEvalBoard for example) and click Save.

  • Open the project’s options window (Project – Options).
  • From the Target tab of the General Options category select the RL78 – R5F100LE device.

  • From the Setup tab of the Debugger category select the TK driver and click OK.

  • Extract the files from the lab .zip archive and copy them into the project’s folder.

  • The new source files have to be included into the project. Open the Add Files… window (Project – Add Files…), select all the copied files and click open.

  • At this moment, all the files are included into the project.
  • The project is ready to be compiled and downloaded on the board. Press the F7 key to compile it. Press CTRL + D to download and debug the project.
  • A window will appear asking to configure the emulator. Keep the default settings and press OK.

  • To run the project press F5.

03 Sep 2012 13:02 · Dragos Bogdan

Renesas RL78G14 Quick Start Guide

This section contains a description of the steps required to run the AD5933 demonstration project on a Renesas RL78G14 platform using the PmodIA.

Required Hardware

Required Software

The AD5933 demonstration project for the Renesas RL78G14 platform consists of three parts: the AD5933 Driver, the PmodIA Demo for RL78G14 and the RL78G14 Common Drivers.

All three parts have to be downloaded.

Hardware Setup

A PmodIA has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G14:

  PmodIOXP J1 connector pin SCL → RDKRL78G14 J8  connector Pin 1
  PmodIOXP J1 connector pin SDA → RDKRL78G14 J8  connector Pin 3
  PmodIOXP J1 connector pin GND → RDKRL78G14 J11 connector Pin 5
  PmodIOXP J1 connector pin VCC → RDKRL78G14 J11 connector Pin 6


  • The default value for the calibration resistor is 47 Kohms. If another resistor is used for calibration, please modify the calibrationImpedance parameter in 'AD5933_CalculateGainFactor()' function from PmodIA.c.


Reference Project Overview

The reference project:

  • reads the temperature from AD5933 part;
  • initializes and start a sweep operation;
  • calculates the gain factor for an impedance of 47k;
  • calculates the impedance between the VOUT and VIN pins;
  • displays the temperature and the impedance on the LCD.

Software Project Tutorial

This section presents the steps for developing a software application that will run on the Renesas Demo Kit for RL78G14 for controlling and monitoring the operation of the ADI part.

  • Run the IAR Embedded Workbench for Renesas RL78 integrated development environment.
  • Choose to create a new project (Project – Create New Project).
  • Select the RL78 tool chain, the Empty project template and click OK.

  • Select a location and a name for the project (ADIEvalBoard for example) and click Save.

  • Open the project’s options window (Project – Options).
  • From the Target tab of the General Options category select the RL78 – R5F104PJ device.

  • From the Setup tab of the Debugger category select the TK driver and click OK.

  • Copy the downloaded files into the project's folder.

  • The new source files have to be included into the project. Open the Add Files… window (Project – Add Files…), select all the copied files and click open.

  • At this moment, all the files are included into the project.
  • The project is ready to be compiled and downloaded on the board. Press the F7 key to compile it. Press CTRL + D to download and debug the project.
  • A window will appear asking to configure the emulator. Keep the default settings and press OK.

  • To run the project press F5.

09 May 2013 17:10 · Dragos Bogdan

Renesas RX62N Quick Start Guide

This section contains a description of the steps required to run the AD5933 demonstration project on a Renesas RX62N platform.

Required Hardware

Required Software

Hardware Setup

A PmodIA has to be interfaced with the Renesas Demonstration Kit (RDK) for RX62N:

  PmodIA J1 connector 1 (SCL) → YRDKRX62N J2  connector Pin 1
  PmodIA J1 connector 3 (SDA) → YRDKRX62N J2  connector Pin 3
  PmodIA J1 connector 5 (GND) → YRDKRX62N J8  connector Pin 4
  PmodIA J1 connector 7 (VCC) → YRDKRX62N J8  connector Pin 3

Reference Project Overview

The reference project reads the temperature from AD5933 part, initializes and start a sweep operation, calculates the gain factor for an impedance of 47k and calculates the impedance between the VOUT and VIN pins.

The temperature and the impedance are displayed on the LCD.

Software Project Setup

This section presents the steps for developing a software application that will run on the Renesas Demo Kit for RX62N for controlling and monitoring the operation of the ADI part.

  • Run the High-performance Embedded Workshop integrated development environment.
  • A window will appear asking to create or open project workspace. Choose “Create a new project workspace” option and press OK.
  • From “Project Types” option select “Application”, name the Workspace and the Project “ADIEvalBoard”, select the “RX” CPU family and “Renesas RX Standard” tool chain. Press OK.

  • A few windows will appear asking to configure the project:
    • In the “Select Target CPU” window, select “RX600” CPU series, “RX62N” CPU Type and press Next.
    • In the “Option Setting” windows keep default settings and press Next.
    • In the “Setting the Content of Files to be generated” window select “None” for the “Generate main() Function” option and press Next.
    • In the “Setting the Standard Library” window press “Disable all” and then Next.
    • In the “Setting the Stack Area” window check the “Use User Stack” option and press Next.
    • In the “Setting the Vector” window keep default settings and press Next.
    • In the “Setting the Target System for Debugging” window choose “RX600 Segger J-Link” target and press Next.
    • In the “Setting the Debugger Options” and “Changing the Files Name to be created” windows keep default settings, press Next and Finish.
  • The workspace is created.

  • The RPDL (Renesas Peripheral Driver Library) has to integrated in the project. Unzip the RPDL files (double-click on the file “RPDL_RX62N.exe”). Navigate to where the RPDL files were unpacked and double-click on the “Copy_RPDL_RX62N.bat” to start the copy process. Choose the LQFP package, type the full path where the project was created and after the files were copied, press any key to close the window.
  • The new source files have to be included in the project. Use the key sequence Alt, P, A to open the “Add files to project ‘ADIEvalBoard’” window. Double click on the RPDL folder. From the “Files of type” drop-down list, select “C source file (*.C)”. Select all of the files and press Add.

  • To avoid conflicts with standard project files remove the files “intprg.c” and “vecttbl.c” which are included in the project. Use the key sequence Alt, P, R to open the “Remove Project Files” window. Select the files, click on Remove and press OK.

  • Next the new directory has to be included in the project. Use the key sequence Alt, B, R to open the “RX Standard Toolchain” window. Select the C/C++ tab, select “Show entries for: Include file directories” and press Add. Select “Relative to: Project directory”, type “RPDL” as sub-directory and press OK.

  • The library file path has to be added in the project. Select the Link/Library tab, select “Show entries for: Library files” and press Add. Select “Relative to: Project directory”, type “RPDL\RX62N_library” as file path and press OK.

  • Because the “intprg.c” file was removed the “PIntPrg” specified in option “start” has to be removed. Change “Category” to “Section”. Press “Edit”, select “PIntPRG” and press “Remove”. From this window the address of each section can be also modified. After all the changes are made press OK two times.

  • At this point the files extracted from the zip file located in the “Software Tools” section have to be added into the project. Copy all the files from the archive into the project folder.

  • Now, the files have to be included in the project. Use the key sequence Alt, P, A to open the “Add files to project ‘ADIEvalBoard’” window. Navigate into ADI folder. From the “Files of type” drop-down list, select “Project Files”. Select all the copied files and press Add.

  • Now, the project is ready to be built. Press F7. The message after the Build Process is finished has to be “0 Errors, 0 Warnings”. To run the program on the board, you have to download the firmware into the microprocessor’s memory.
03 Feb 2012 15:32 · Dragos Bogdan

More information

01 Jun 2012 12:17
resources/tools-software/uc-drivers/renesas/ad5933.txt · Last modified: 24 Jan 2021 17:53 by Dragos Bogdan