Analog Devices / Mbed OS EVAL-ADMX2001

Example program for EVAL-ADMX2001

Dependencies:   ADMX2001

measure.cpp@15:fca7551aaf0a, 2021-11-17 (annotated)

Committer:
nsheth
Date:
Wed Nov 17 18:15:37 2021 +0000
Revision:
15:fca7551aaf0a
Parent:
10:186e097fb1e3 
Updating default .lib file for eval platform

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nsheth 5:746e78113d7d 1 /* Copyright (c) 2021 Analog Devices, Inc. All rights reserved.
nsheth 5:746e78113d7d 2
nsheth 5:746e78113d7d 3 Redistribution and use in source and binary forms, with or without modification,
nsheth 5:746e78113d7d 4 are permitted provided that the following conditions are met:
nsheth 5:746e78113d7d 5 - Redistributions of source code must retain the above copyright notice,
nsheth 5:746e78113d7d 6 this list of conditions and the following disclaimer.
nsheth 5:746e78113d7d 7 - Redistributions in binary form must reproduce the above copyright notice,
nsheth 5:746e78113d7d 8 this list of conditions and the following disclaimer in the documentation
nsheth 5:746e78113d7d 9 and/or other materials provided with the distribution.
nsheth 5:746e78113d7d 10 - Modified versions of the software must be conspicuously marked as such.
nsheth 5:746e78113d7d 11 - This software is licensed solely and exclusively for use with processors/products
nsheth 5:746e78113d7d 12 manufactured by or for Analog Devices, Inc.
nsheth 5:746e78113d7d 13 - This software may not be combined or merged with other code in any manner
nsheth 5:746e78113d7d 14 that would cause the software to become subject to terms and conditions which
nsheth 5:746e78113d7d 15 differ from those listed here.
nsheth 5:746e78113d7d 16 - Neither the name of Analog Devices, Inc. nor the names of its contributors
nsheth 5:746e78113d7d 17 may be used to endorse or promote products derived from this software without
nsheth 5:746e78113d7d 18 specific prior written permission.
nsheth 5:746e78113d7d 19 - The use of this software may or may not infringe the patent rights of one or
nsheth 5:746e78113d7d 20 more patent holders. This license does not release you from the requirement
nsheth 5:746e78113d7d 21 that you obtain separate licenses from these patent holders to use this software.
nsheth 5:746e78113d7d 22
nsheth 5:746e78113d7d 23 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND
nsheth 5:746e78113d7d 24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
nsheth 5:746e78113d7d 25 TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
nsheth 5:746e78113d7d 26 NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
nsheth 5:746e78113d7d 27 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
nsheth 5:746e78113d7d 28 (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
nsheth 5:746e78113d7d 29 PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
nsheth 5:746e78113d7d 30 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nsheth 5:746e78113d7d 31 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
nsheth 5:746e78113d7d 32 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
nsheth 5:746e78113d7d 33 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nsheth 5:746e78113d7d 34
nsheth 5:746e78113d7d 35 2021-01-10-7CBSD SLA
nsheth 5:746e78113d7d 36 */
nsheth 5:746e78113d7d 37
nsheth 5:746e78113d7d 38 /*============= I N C L U D E S =============*/
nsheth 5:746e78113d7d 39 #include "ADMX2001.h"
nsheth 5:746e78113d7d 40 #include "ADMX2001_commands.h"
nsheth 5:746e78113d7d 41 #include "message.h"
nsheth 5:746e78113d7d 42 #include "measure.h"
nsheth 5:746e78113d7d 43 #include <stdint.h>
nsheth 5:746e78113d7d 44 #include <stdio.h>
nsheth 5:746e78113d7d 45 #include <stdlib.h>
nsheth 5:746e78113d7d 46
nsheth 9:29db35656fcb 47 /*============= D A T A T Y P E S =============*/
nsheth 9:29db35656fcb 48
nsheth 5:746e78113d7d 49 /** maximum length for buffer for string operation */
nsheth 8:bd0b93e35392 50 #define MAX_DISPLAY_LENGTH 256
nsheth 5:746e78113d7d 51 /** maximum length for buffer for storing measurement values */
nsheth 5:746e78113d7d 52 #define MAX_MEASUREMENT_BUFFER 512
nsheth 9:29db35656fcb 53
nsheth 9:29db35656fcb 54 /*============= D A T A =============*/
nsheth 9:29db35656fcb 55
nsheth 5:746e78113d7d 56 /** buffer for string operation */
nsheth 5:746e78113d7d 57 char displayString[MAX_DISPLAY_LENGTH];
nsheth 5:746e78113d7d 58 /** Array to store measurement values*/
nsheth 5:746e78113d7d 59 double measurementBuffer[MAX_MEASUREMENT_BUFFER];
nsheth 5:746e78113d7d 60 /** Array to store sweep points*/
nsheth 5:746e78113d7d 61 double sweepPoints[MAX_MEASUREMENT_BUFFER];
nsheth 5:746e78113d7d 62
nsheth 5:746e78113d7d 63 extern Admx200xDev admx200xDev;
nsheth 5:746e78113d7d 64
nsheth 8:bd0b93e35392 65 static int32_t ReadAndDisplay();
nsheth 5:746e78113d7d 66
nsheth 5:746e78113d7d 67 static void DisplayMeasuredValue(double displayVal1, double displayVal2,
nsheth 5:746e78113d7d 68 double sweepVar);
nsheth 5:746e78113d7d 69
nsheth 10:186e097fb1e3 70 /*============= C O D E =============*/
nsheth 10:186e097fb1e3 71
nsheth 5:746e78113d7d 72 /**
nsheth 5:746e78113d7d 73 * @brief Dsiplays the output value
nsheth 10:186e097fb1e3 74 * @param [in] displayVal1 - display value 1
nsheth 10:186e097fb1e3 75 * @param [in] displayVal2 - display value 2
nsheth 10:186e097fb1e3 76 * @param [in] sweepVar - sweep variable
nsheth 5:746e78113d7d 77 */
nsheth 5:746e78113d7d 78 void DisplayMeasuredValue(double displayVal1, double displayVal2,
nsheth 5:746e78113d7d 79 double sweepVar)
nsheth 5:746e78113d7d 80 {
nsheth 10:186e097fb1e3 81 // Format the measured value and sweep variable
nsheth 5:746e78113d7d 82 snprintf(&displayString[0], MAX_DISPLAY_LENGTH,
nsheth 8:bd0b93e35392 83 "Count = %d, Value = (%0.6e) + (%0.6e) j\n\r",
nsheth 8:bd0b93e35392 84 (int32_t)sweepVar, displayVal1, displayVal2);
nsheth 10:186e097fb1e3 85 // Print the formated string
nsheth 5:746e78113d7d 86 printf("%s", &displayString[0]);
nsheth 5:746e78113d7d 87 }
nsheth 5:746e78113d7d 88
nsheth 5:746e78113d7d 89 /**
nsheth 5:746e78113d7d 90 * @brief Function to read and display measured values
nsheth 10:186e097fb1e3 91 * @return Returns 0 for success or error code.
nsheth 5:746e78113d7d 92 */
nsheth 8:bd0b93e35392 93 int32_t ReadAndDisplay()
nsheth 5:746e78113d7d 94 {
nsheth 5:746e78113d7d 95 int32_t i;
nsheth 5:746e78113d7d 96 int32_t status = ADMX_STATUS_SUCCESS;
nsheth 5:746e78113d7d 97
nsheth 5:746e78113d7d 98 Admx200xDev *pAdmx200x = &admx200xDev;
nsheth 5:746e78113d7d 99 uint8_t cmdId = 0;
nsheth 5:746e78113d7d 100 uint16_t addr = 0;
nsheth 5:746e78113d7d 101 uint32_t statReg;
nsheth 5:746e78113d7d 102
nsheth 5:746e78113d7d 103 int32_t numValues =
nsheth 5:746e78113d7d 104 sizeof(measurementBuffer) / sizeof(measurementBuffer[0]);
nsheth 10:186e097fb1e3 105 // Read measurement values into the measurement buffer
nsheth 5:746e78113d7d 106 if (status == 0)
nsheth 5:746e78113d7d 107 {
nsheth 5:746e78113d7d 108 status = Admx200xReadFifo(pAdmx200x, &measurementBuffer[0], &numValues);
nsheth 5:746e78113d7d 109 }
nsheth 10:186e097fb1e3 110 // Populate the fifo with sweep points
nsheth 5:746e78113d7d 111 if (status == 0)
nsheth 5:746e78113d7d 112 {
nsheth 5:746e78113d7d 113 cmdId = CMD_READ_SWEEP_POINTS;
nsheth 5:746e78113d7d 114 numValues /= 2;
nsheth 5:746e78113d7d 115 status = Admx200xSendCmd(pAdmx200x, &cmdId, &addr,
nsheth 5:746e78113d7d 116 (uint32_t *)&numValues, &statReg);
nsheth 5:746e78113d7d 117 }
nsheth 10:186e097fb1e3 118 // Read sweep points into the sweep points buffer
nsheth 5:746e78113d7d 119 if (status == 0)
nsheth 5:746e78113d7d 120 {
nsheth 5:746e78113d7d 121 status = Admx200xReadFifo(pAdmx200x, &sweepPoints[0], &numValues);
nsheth 5:746e78113d7d 122 }
nsheth 5:746e78113d7d 123
nsheth 5:746e78113d7d 124 if (status == 0)
nsheth 5:746e78113d7d 125 {
nsheth 5:746e78113d7d 126 for (i = 0; i < numValues; i++)
nsheth 5:746e78113d7d 127 {
nsheth 5:746e78113d7d 128 DisplayMeasuredValue(measurementBuffer[2 * i],
nsheth 5:746e78113d7d 129 measurementBuffer[2 * i + 1], sweepPoints[i]);
nsheth 5:746e78113d7d 130 }
nsheth 5:746e78113d7d 131 }
nsheth 5:746e78113d7d 132
nsheth 5:746e78113d7d 133 return status;
nsheth 5:746e78113d7d 134 }
nsheth 5:746e78113d7d 135
nsheth 8:bd0b93e35392 136
nsheth 8:bd0b93e35392 137 /**
nsheth 8:bd0b93e35392 138 * Sets up, measures and displays Impedance
nsheth 10:186e097fb1e3 139 * @return Returns 0 for success or error code.
nsheth 8:bd0b93e35392 140 */
nsheth 8:bd0b93e35392 141 int32_t MeasureAndDisplay()
nsheth 5:746e78113d7d 142 {
nsheth 5:746e78113d7d 143 int32_t status = 0;
nsheth 5:746e78113d7d 144 uint8_t cmdId;
nsheth 5:746e78113d7d 145 uint16_t addr;
nsheth 5:746e78113d7d 146 uint32_t data;
nsheth 5:746e78113d7d 147 uint32_t statReg;
nsheth 5:746e78113d7d 148 Admx200xDev *pAdmx200x = &admx200xDev;
nsheth 5:746e78113d7d 149 uint32_t measureStatus;
nsheth 5:746e78113d7d 150 addr = 0;
nsheth 5:746e78113d7d 151 data = 0;
nsheth 8:bd0b93e35392 152
nsheth 10:186e097fb1e3 153 // Initiate measurement
nsheth 8:bd0b93e35392 154 cmdId = CMD_Z;
nsheth 8:bd0b93e35392 155 status =
nsheth 8:bd0b93e35392 156 Admx200xSendCmd(pAdmx200x, &cmdId, &addr, &data, &statReg);
nsheth 8:bd0b93e35392 157 if (status == ADMX_STATUS_INVALID_CURRENT_GAIN ||
nsheth 8:bd0b93e35392 158 status == ADMX_STATUS_INVALID_DISPLAY_MODE ||
nsheth 8:bd0b93e35392 159 status == ADMX_STATUS_UNCOMMITED_CAL ||
nsheth 8:bd0b93e35392 160 status == ADMX_STATUS_SUCCESS)
nsheth 5:746e78113d7d 161 {
nsheth 10:186e097fb1e3 162 // Wait for measurement to complete successfully
nsheth 8:bd0b93e35392 163 status = Admx200xWaitForStatus(
nsheth 8:bd0b93e35392 164 pAdmx200x, SPI_TIMEOUT, ADMX200X_STATUS_MEASURE_DONE_BITM,
nsheth 8:bd0b93e35392 165 &measureStatus);
nsheth 5:746e78113d7d 166 }
nsheth 5:746e78113d7d 167 else
nsheth 5:746e78113d7d 168 {
nsheth 8:bd0b93e35392 169 status = ADMX_STATUS_FAILED;
nsheth 8:bd0b93e35392 170 }
nsheth 8:bd0b93e35392 171
nsheth 8:bd0b93e35392 172 if (status == ADMX_STATUS_INVALID_CURRENT_GAIN ||
nsheth 8:bd0b93e35392 173 status == ADMX_STATUS_INVALID_DISPLAY_MODE ||
nsheth 8:bd0b93e35392 174 status == ADMX_STATUS_UNCOMMITED_CAL ||
nsheth 8:bd0b93e35392 175 status == ADMX_STATUS_SUCCESS)
nsheth 8:bd0b93e35392 176 {
nsheth 8:bd0b93e35392 177 status = ReadAndDisplay();
nsheth 8:bd0b93e35392 178 }
nsheth 8:bd0b93e35392 179 else
nsheth 8:bd0b93e35392 180 {
nsheth 8:bd0b93e35392 181 status = ADMX_STATUS_FAILED;
nsheth 8:bd0b93e35392 182 }
nsheth 8:bd0b93e35392 183
nsheth 8:bd0b93e35392 184 if (status != ADMX_STATUS_SUCCESS)
nsheth 8:bd0b93e35392 185 {
nsheth 8:bd0b93e35392 186 status = ADMX_STATUS_FAILED;
nsheth 8:bd0b93e35392 187 ERROR_MSG("Measurement failed");
nsheth 5:746e78113d7d 188 // Clear the error
nsheth 5:746e78113d7d 189 Admx200xClearSPI(pAdmx200x);
nsheth 5:746e78113d7d 190 // Send abort command to bring state machine to IDLE if it got stuck
nsheth 5:746e78113d7d 191 cmdId = CMD_ABORT;
nsheth 5:746e78113d7d 192 Admx200xSendCmd(pAdmx200x, &cmdId, &addr, &data, &statReg);
nsheth 5:746e78113d7d 193 }
nsheth 5:746e78113d7d 194
nsheth 5:746e78113d7d 195 return status;
nsheth 5:746e78113d7d 196 }
nsheth 5:746e78113d7d 197
nsheth 5:746e78113d7d 198
nsheth 5:746e78113d7d 199
nsheth 8:bd0b93e35392 200