Diff: README.txt

Revision:

9:29db35656fcb

Parent:

2:7add4b4a96d7

Child:

10:186e097fb1e3

--- a/README.txt	Wed Oct 27 21:18:12 2021 +0000
+++ b/README.txt	Tue Nov 02 10:14:25 2021 +0000
@@ -1,26 +1,24 @@
 Evaluation Boards/Products Supported
 ------------------------------------ 
-EVAL-AD7124-8SZ
-EVAL-AD7124-4SZ
-Trial addition
+EVAL-ADMX2001
 
 Overview
 --------
 These code files provide the console application and device libraries to 
-interface with AD7124 EVAL board. This code was developed and tested on SDP-K1 
+interface with ADMX2001 board. This code was developed and tested on SDP-K1 
 controller board: https://os.mbed.com/platforms/SDP_K1/
 
-Product details: https://www.analog.com/en/products/ad7124-8.html
-Eval board details: https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD7124-8.html
-User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/ad7124_mbed_support
+Product details: 
+Eval board details: 
+User Guide for this code: 
 Communication Protocol: SPI
 
 
 Hardware Setup
 --------------
-Required: SDP-K1 (or alternative MBED enabled controller board), EVAL-AD7124-8SZ, 
+Required: SDP-K1 (or alternative MBED enabled controller board), ADMX2001, 
 USB cable.
-Plug in the EVAL-AD124 board on SDP-K1 board (or any other Mbed enabled 
+Plug in the ADMX2001 board on SDP-K1 board (or any other Mbed enabled 
 controller board) using the SDP connector and screws.
 Connect SDP-K1 board to the PC using the USB cable.
 
@@ -28,13 +26,22 @@
 How to Get Started
 ------------------
 Open Mbed online compiler. https://ide.mbed.com/compiler
-Import Code into compiler from here: https://os.mbed.com/teams/AnalogDevices/code/EVAL-AD7124/
+Import Code into compiler from here: https://os.mbed.com/teams/AnalogDevices/code/EVAL-ADMX2001/
 instructions on how to import code are here: https://os.mbed.com/docs/mbed-os/v5.12/tools/importing-code.html
-Compile code. Drag and drop binary into SDP-K1 controller board. Find detailed 
-instructions here: https://os.mbed.com/docs/mbed-os/v5.12/tools/getting-your-program-on-your-board.html
-Open Tera Term (or alternative), select 115200 baud rate, and the applicable COM 
-port to see the list of options.
+Compile code. Open Tera Term (or alternative), select serial communication with 115200 baud rate, and the applicable COM 
+port. Drag and drop binary into SDP-K1 controller board. Find detailed 
+instructions here: https://os.mbed.com/docs/mbed-os/v5.12/tools/getting-your-program-on-your-board.html. 
+Tera term will then display the print output of your complied code.  
 
+Details of Operation
+--------------------
+
+The ADMX2001 library, contain the code required to interface with the ADMX2001 module via the SPI interface. 
+The EVAL-ADMX2001 is a program that initialises the spi interface and uses the ADMX2001 library to communicate with the 
+ADMX2001 module. 
+This code performs a measurement and calibration. The set of SPI read/write operations needed for measurement and 
+calibration are present in measure.cpp and calibrate.cpp respectively. 
+The gpio_config file contains code to interface with the on board resistors and allow us to change the test load across the ADMX2001 terminals. 
 
 Notes
 -----
@@ -44,7 +51,7 @@
 
 License
 -------
-Copyright (c) 2019 Analog Devices, Inc.  All rights reserved.
+Copyright (c) 2021 Analog Devices, Inc.  All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
   - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
@@ -57,4 +64,4 @@
 
 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-2019-01-10-7CBSD SLA
\ No newline at end of file
+2021-01-10-7CBSD SLA
\ No newline at end of file