Analog Devices / Mbed OS EVAL-ADMX2001

Example program for EVAL-ADMX2001

Dependencies:   ADMX2001

README.txt@9:29db35656fcb, 2021-11-02 (annotated)

Committer:
nsheth
Date:
Tue Nov 02 10:14:25 2021 +0000
Revision:
9:29db35656fcb
Parent:
2:7add4b4a96d7
Child:
10:186e097fb1e3
Added platform drivers, documentation updated, short calibration completed

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kjansen45 0:a74ad5b8dc7b 1 Evaluation Boards/Products Supported
Kjansen45 0:a74ad5b8dc7b 2 ------------------------------------
nsheth 9:29db35656fcb 3 EVAL-ADMX2001
Kjansen45 0:a74ad5b8dc7b 4
Kjansen45 0:a74ad5b8dc7b 5 Overview
Kjansen45 0:a74ad5b8dc7b 6 --------
Kjansen45 0:a74ad5b8dc7b 7 These code files provide the console application and device libraries to
nsheth 9:29db35656fcb 8 interface with ADMX2001 board. This code was developed and tested on SDP-K1
Kjansen45 0:a74ad5b8dc7b 9 controller board: https://os.mbed.com/platforms/SDP_K1/
Kjansen45 0:a74ad5b8dc7b 10
nsheth 9:29db35656fcb 11 Product details:
nsheth 9:29db35656fcb 12 Eval board details:
nsheth 9:29db35656fcb 13 User Guide for this code:
Kjansen45 0:a74ad5b8dc7b 14 Communication Protocol: SPI
Kjansen45 0:a74ad5b8dc7b 15
Kjansen45 0:a74ad5b8dc7b 16
Kjansen45 0:a74ad5b8dc7b 17 Hardware Setup
Kjansen45 0:a74ad5b8dc7b 18 --------------
nsheth 9:29db35656fcb 19 Required: SDP-K1 (or alternative MBED enabled controller board), ADMX2001,
Kjansen45 0:a74ad5b8dc7b 20 USB cable.
nsheth 9:29db35656fcb 21 Plug in the ADMX2001 board on SDP-K1 board (or any other Mbed enabled
Kjansen45 0:a74ad5b8dc7b 22 controller board) using the SDP connector and screws.
Kjansen45 0:a74ad5b8dc7b 23 Connect SDP-K1 board to the PC using the USB cable.
Kjansen45 0:a74ad5b8dc7b 24
Kjansen45 0:a74ad5b8dc7b 25
Kjansen45 0:a74ad5b8dc7b 26 How to Get Started
Kjansen45 0:a74ad5b8dc7b 27 ------------------
Kjansen45 0:a74ad5b8dc7b 28 Open Mbed online compiler. https://ide.mbed.com/compiler
nsheth 9:29db35656fcb 29 Import Code into compiler from here: https://os.mbed.com/teams/AnalogDevices/code/EVAL-ADMX2001/
Kjansen45 0:a74ad5b8dc7b 30 instructions on how to import code are here: https://os.mbed.com/docs/mbed-os/v5.12/tools/importing-code.html
nsheth 9:29db35656fcb 31 Compile code. Open Tera Term (or alternative), select serial communication with 115200 baud rate, and the applicable COM
nsheth 9:29db35656fcb 32 port. Drag and drop binary into SDP-K1 controller board. Find detailed
nsheth 9:29db35656fcb 33 instructions here: https://os.mbed.com/docs/mbed-os/v5.12/tools/getting-your-program-on-your-board.html.
nsheth 9:29db35656fcb 34 Tera term will then display the print output of your complied code.
Kjansen45 0:a74ad5b8dc7b 35
nsheth 9:29db35656fcb 36 Details of Operation
nsheth 9:29db35656fcb 37 --------------------
nsheth 9:29db35656fcb 38
nsheth 9:29db35656fcb 39 The ADMX2001 library, contain the code required to interface with the ADMX2001 module via the SPI interface.
nsheth 9:29db35656fcb 40 The EVAL-ADMX2001 is a program that initialises the spi interface and uses the ADMX2001 library to communicate with the
nsheth 9:29db35656fcb 41 ADMX2001 module.
nsheth 9:29db35656fcb 42 This code performs a measurement and calibration. The set of SPI read/write operations needed for measurement and
nsheth 9:29db35656fcb 43 calibration are present in measure.cpp and calibrate.cpp respectively.
nsheth 9:29db35656fcb 44 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.
Kjansen45 0:a74ad5b8dc7b 45
Kjansen45 0:a74ad5b8dc7b 46 Notes
Kjansen45 0:a74ad5b8dc7b 47 -----
Kjansen45 0:a74ad5b8dc7b 48 If using Win 7, install serial drivers for Mbed. https://os.mbed.com/docs/mbed-os/v5.12/tutorials/windows-serial-driver.html
Kjansen45 0:a74ad5b8dc7b 49 A detailed user guide on SDP-K1 controller board is available here https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/SDP-K1.html.
Kjansen45 0:a74ad5b8dc7b 50
Kjansen45 0:a74ad5b8dc7b 51
Kjansen45 0:a74ad5b8dc7b 52 License
Kjansen45 0:a74ad5b8dc7b 53 -------
nsheth 9:29db35656fcb 54 Copyright (c) 2021 Analog Devices, Inc. All rights reserved.
Kjansen45 0:a74ad5b8dc7b 55
Kjansen45 0:a74ad5b8dc7b 56 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Kjansen45 0:a74ad5b8dc7b 57 - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Kjansen45 0:a74ad5b8dc7b 58 - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Kjansen45 0:a74ad5b8dc7b 59 - Modified versions of the software must be conspicuously marked as such.
Kjansen45 0:a74ad5b8dc7b 60 - This software is licensed solely and exclusively for use with processors/products manufactured by or for Analog Devices, Inc.
Kjansen45 0:a74ad5b8dc7b 61 - This software may not be combined or merged with other code in any manner that would cause the software to become subject to terms and conditions which differ from those listed here.
Kjansen45 0:a74ad5b8dc7b 62 - Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Kjansen45 0:a74ad5b8dc7b 63 - The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
Kjansen45 0:a74ad5b8dc7b 64
Kjansen45 0:a74ad5b8dc7b 65 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.
Kjansen45 0:a74ad5b8dc7b 66
nsheth 9:29db35656fcb 67 2021-01-10-7CBSD SLA