Vybhav Kadaba / Mbed OS EV-PRO-MW1001_Development_updateFW

Bumped Mbed FW version to 01.20.0080

inc/admw1001/admw1001_config.h@33:df7a00f1b8e1, 2019-11-14 (annotated)

Committer:
Vkadaba
Date:
Thu Nov 14 05:35:08 2019 +0000
Revision:
33:df7a00f1b8e1
Parent:
18:cbf514cce921
Child:
34:b60ee1e0af2b
Added support for the following:; 1.Rsense; 2.Excitation current state; 3.Buffer bypass ; ; the aobve support is only for analog sensors.; Tested and the system is working fine

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vkadaba 5:0728bde67bdb 1 /*
Vkadaba 6:9d393a9677f4 2 Copyright 2019 (c) Analog Devices, Inc.
Vkadaba 5:0728bde67bdb 3
Vkadaba 5:0728bde67bdb 4 All rights reserved.
Vkadaba 5:0728bde67bdb 5
Vkadaba 5:0728bde67bdb 6 Redistribution and use in source and binary forms, with or without
Vkadaba 5:0728bde67bdb 7 modification, are permitted provided that the following conditions are met:
Vkadaba 5:0728bde67bdb 8 - Redistributions of source code must retain the above copyright
Vkadaba 5:0728bde67bdb 9 notice, this list of conditions and the following disclaimer.
Vkadaba 5:0728bde67bdb 10 - Redistributions in binary form must reproduce the above copyright
Vkadaba 5:0728bde67bdb 11 notice, this list of conditions and the following disclaimer in
Vkadaba 5:0728bde67bdb 12 the documentation and/or other materials provided with the
Vkadaba 5:0728bde67bdb 13 distribution.
Vkadaba 5:0728bde67bdb 14 - Neither the name of Analog Devices, Inc. nor the names of its
Vkadaba 5:0728bde67bdb 15 contributors may be used to endorse or promote products derived
Vkadaba 5:0728bde67bdb 16 from this software without specific prior written permission.
Vkadaba 5:0728bde67bdb 17 - The use of this software may or may not infringe the patent rights
Vkadaba 5:0728bde67bdb 18 of one or more patent holders. This license does not release you
Vkadaba 5:0728bde67bdb 19 from the requirement that you obtain separate licenses from these
Vkadaba 5:0728bde67bdb 20 patent holders to use this software.
Vkadaba 5:0728bde67bdb 21 - Use of the software either in source or binary form, must be run
Vkadaba 5:0728bde67bdb 22 on or directly connected to an Analog Devices Inc. component.
Vkadaba 5:0728bde67bdb 23
Vkadaba 5:0728bde67bdb 24 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
Vkadaba 5:0728bde67bdb 25 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
Vkadaba 5:0728bde67bdb 26 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Vkadaba 5:0728bde67bdb 27 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
Vkadaba 5:0728bde67bdb 28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Vkadaba 5:0728bde67bdb 29 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
Vkadaba 5:0728bde67bdb 30 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Vkadaba 5:0728bde67bdb 31 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Vkadaba 5:0728bde67bdb 32 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Vkadaba 5:0728bde67bdb 33 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Vkadaba 5:0728bde67bdb 34 */
Vkadaba 5:0728bde67bdb 35
Vkadaba 5:0728bde67bdb 36 /*!
Vkadaba 5:0728bde67bdb 37 ******************************************************************************
Vkadaba 5:0728bde67bdb 38 * @file: admw1001_config.h
Vkadaba 5:0728bde67bdb 39 * @brief: Configuration type definitions for ADMW1001.
Vkadaba 5:0728bde67bdb 40 *-----------------------------------------------------------------------------
Vkadaba 5:0728bde67bdb 41 */
Vkadaba 5:0728bde67bdb 42
Vkadaba 5:0728bde67bdb 43 #ifndef __ADMW1001_CONFIG_H__
Vkadaba 5:0728bde67bdb 44 #define __ADMW1001_CONFIG_H__
Vkadaba 5:0728bde67bdb 45
Vkadaba 5:0728bde67bdb 46 #include "admw_platform.h"
Vkadaba 5:0728bde67bdb 47 #include "admw1001_sensor_types.h"
Vkadaba 5:0728bde67bdb 48
Vkadaba 5:0728bde67bdb 49 /*! @addtogroup ADMW1001_Api
Vkadaba 5:0728bde67bdb 50 * @{
Vkadaba 5:0728bde67bdb 51 */
Vkadaba 5:0728bde67bdb 52
Vkadaba 5:0728bde67bdb 53 #ifdef __cplusplus
Vkadaba 5:0728bde67bdb 54 extern "C" {
Vkadaba 5:0728bde67bdb 55 #endif
Vkadaba 5:0728bde67bdb 56
Vkadaba 5:0728bde67bdb 57 /*! Maximum length allowed for a digital sensor command */
Vkadaba 5:0728bde67bdb 58 #define ADMW1001_SENSOR_COMMAND_MAX_LENGTH 7
Vkadaba 5:0728bde67bdb 59
Vkadaba 5:0728bde67bdb 60 /*! ADMW1001 channel priority options */
Vkadaba 8:2f2775c34640 61 typedef enum
Vkadaba 8:2f2775c34640 62 {
Vkadaba 5:0728bde67bdb 63 ADMW1001_CHANNEL_PRIORITY_0 = 0,
Vkadaba 5:0728bde67bdb 64 ADMW1001_CHANNEL_PRIORITY_1,
Vkadaba 5:0728bde67bdb 65 ADMW1001_CHANNEL_PRIORITY_2,
Vkadaba 5:0728bde67bdb 66 ADMW1001_CHANNEL_PRIORITY_3,
Vkadaba 5:0728bde67bdb 67 ADMW1001_CHANNEL_PRIORITY_4,
Vkadaba 5:0728bde67bdb 68 ADMW1001_CHANNEL_PRIORITY_5,
Vkadaba 5:0728bde67bdb 69 ADMW1001_CHANNEL_PRIORITY_6,
Vkadaba 5:0728bde67bdb 70 ADMW1001_CHANNEL_PRIORITY_7,
Vkadaba 5:0728bde67bdb 71 ADMW1001_CHANNEL_PRIORITY_8,
Vkadaba 5:0728bde67bdb 72 ADMW1001_CHANNEL_PRIORITY_9,
Vkadaba 5:0728bde67bdb 73 ADMW1001_CHANNEL_PRIORITY_10,
Vkadaba 5:0728bde67bdb 74 ADMW1001_CHANNEL_PRIORITY_11,
Vkadaba 5:0728bde67bdb 75 ADMW1001_CHANNEL_PRIORITY_12,
Vkadaba 5:0728bde67bdb 76
Vkadaba 5:0728bde67bdb 77 ADMW1001_CHANNEL_PRIORITY_HIGHEST = ADMW1001_CHANNEL_PRIORITY_0,
Vkadaba 8:2f2775c34640 78 ADMW1001_CHANNEL_PRIORITY_LOWEST = ADMW1001_CHANNEL_PRIORITY_12,
Vkadaba 8:2f2775c34640 79
Vkadaba 8:2f2775c34640 80 } ADMW1001_CHANNEL_PRIORITY;
Vkadaba 5:0728bde67bdb 81
Vkadaba 5:0728bde67bdb 82 /*! ADMW1001 operating mode options */
Vkadaba 8:2f2775c34640 83 typedef enum
Vkadaba 8:2f2775c34640 84 {
Vkadaba 5:0728bde67bdb 85 ADMW1001_OPERATING_MODE_SINGLECYCLE = 0,
Vkadaba 5:0728bde67bdb 86 /*!< Executes a single measurement cycle and stops */
Vkadaba 5:0728bde67bdb 87 ADMW1001_OPERATING_MODE_CONTINUOUS,
Vkadaba 5:0728bde67bdb 88 /*!< Continuously executes measurement cycles */
Vkadaba 5:0728bde67bdb 89 ADMW1001_OPERATING_MODE_MULTICYCLE,
Vkadaba 5:0728bde67bdb 90 /*!< Executes a burst of measurement cycles, repeated at defined intervals */
Vkadaba 8:2f2775c34640 91
Vkadaba 8:2f2775c34640 92 } ADMW1001_OPERATING_MODE;
Vkadaba 5:0728bde67bdb 93
Vkadaba 5:0728bde67bdb 94 /*! ADMW1001 data ready mode options */
Vkadaba 8:2f2775c34640 95 typedef enum
Vkadaba 8:2f2775c34640 96 {
Vkadaba 5:0728bde67bdb 97 ADMW1001_DATAREADY_PER_CONVERSION = 0,
Vkadaba 5:0728bde67bdb 98 /*!< The DATAREADY signal is asserted after completion of each conversion
Vkadaba 5:0728bde67bdb 99 * - a single data sample only from the latest completed conversion is
Vkadaba 5:0728bde67bdb 100 * stored in this mode
Vkadaba 5:0728bde67bdb 101 */
Vkadaba 5:0728bde67bdb 102 ADMW1001_DATAREADY_PER_CYCLE,
Vkadaba 5:0728bde67bdb 103 /*!< The DATAREADY signal is asserted after completion of each measurement
Vkadaba 5:0728bde67bdb 104 * cycle
Vkadaba 5:0728bde67bdb 105 * - data samples only from the lastest completed measurement cycle are
Vkadaba 5:0728bde67bdb 106 * stored in this mode
Vkadaba 5:0728bde67bdb 107 */
Vkadaba 8:2f2775c34640 108 ADMW1001_DATAREADY_PER_FIFO_FILL,
Vkadaba 8:2f2775c34640 109 /*!< The DATAREADY signal is asserted after each fill of the data FIFO
Vkadaba 8:2f2775c34640 110 * - applicable only when @ref ADMW1001_OPERATING_MODE_CONTINUOUS or
Vkadaba 8:2f2775c34640 111 * @ref ADMW1001_OPERATING_MODE_MULTICYCLE is also selected
Vkadaba 5:0728bde67bdb 112 */
Vkadaba 8:2f2775c34640 113
Vkadaba 8:2f2775c34640 114 } ADMW1001_DATAREADY_MODE;
Vkadaba 5:0728bde67bdb 115
Vkadaba 5:0728bde67bdb 116 /*! ADMW1001 power mode options */
Vkadaba 8:2f2775c34640 117 typedef enum
Vkadaba 8:2f2775c34640 118 {
Vkadaba 6:9d393a9677f4 119 ADMW1001_POWER_MODE_HIBERNATION = 0,
Vkadaba 6:9d393a9677f4 120 /*!< module has entede hibernation mode. All analog circuitry is disabled. All peripherals disabled apart from the Wake-up pin functionality. */
Vkadaba 6:9d393a9677f4 121 ADMW1001_POWER_MODE_ACTIVE,
Vkadaba 6:9d393a9677f4 122 /*!< Part is fully powered up and either cycling through a sequence or awaiting a configuration */
Vkadaba 5:0728bde67bdb 123
Vkadaba 8:2f2775c34640 124 } ADMW1001_POWER_MODE;
Vkadaba 8:2f2775c34640 125
Vkadaba 5:0728bde67bdb 126 /*! ADMW1001 measurement analog filter settling options */
Vkadaba 5:0728bde67bdb 127 typedef enum
Vkadaba 5:0728bde67bdb 128 {
Vkadaba 5:0728bde67bdb 129 ADMW1001_FILTER_SETTLING_ALWAYS = 0,
Vkadaba 5:0728bde67bdb 130 /*!< Allow full settling time to elapse between every measurement from an analog sensor */
Vkadaba 6:9d393a9677f4 131 ADMW1001_FILTER_SETTLING_FAST,
Vkadaba 5:0728bde67bdb 132 /*!< Skip settling time between consecutive measurements from an analog sensor */
Vkadaba 8:2f2775c34640 133
Vkadaba 8:2f2775c34640 134 } ADMW1001_FILTER_SETTLING;
Vkadaba 5:0728bde67bdb 135
Vkadaba 5:0728bde67bdb 136 /*! ADMW1001 measurement unit options
Vkadaba 5:0728bde67bdb 137 *
Vkadaba 5:0728bde67bdb 138 * Optionally select a measurement unit for final conversion results.
Vkadaba 5:0728bde67bdb 139 * Currently applicable only to specific temperature sensor types.
Vkadaba 5:0728bde67bdb 140 */
Vkadaba 8:2f2775c34640 141 typedef enum
Vkadaba 8:2f2775c34640 142 {
Vkadaba 5:0728bde67bdb 143 ADMW1001_MEASUREMENT_UNIT_UNSPECIFIED = 0,
Vkadaba 5:0728bde67bdb 144 /*!< No measurement unit specified */
Vkadaba 5:0728bde67bdb 145 ADMW1001_MEASUREMENT_UNIT_CELSIUS,
Vkadaba 5:0728bde67bdb 146 /*!< Celsius temperature unit - applicable to temperature sensors only */
Vkadaba 5:0728bde67bdb 147 ADMW1001_MEASUREMENT_UNIT_FAHRENHEIT,
Vkadaba 5:0728bde67bdb 148 /*!< Fahrenheit temperature unit - applicable to temperature sensors only */
Vkadaba 8:2f2775c34640 149
Vkadaba 8:2f2775c34640 150 } ADMW1001_MEASUREMENT_UNIT;
Vkadaba 5:0728bde67bdb 151
Vkadaba 5:0728bde67bdb 152 /*! ADMW1001 Open-Sensor Diagnostics frequency
Vkadaba 5:0728bde67bdb 153 *
Vkadaba 5:0728bde67bdb 154 * Select the per-cycle frequency at which open-sensor diagnostic
Vkadaba 5:0728bde67bdb 155 * checks should be performed. Open-sensor diagnostic checks typically require
Vkadaba 5:0728bde67bdb 156 * specific or time-consuming processing which cannot be executed while a
Vkadaba 5:0728bde67bdb 157 * measurement cycle is running.
Vkadaba 5:0728bde67bdb 158 *
Vkadaba 5:0728bde67bdb 159 * @note Open-sensor diagnostic checks, when performed, will add a delay to the
Vkadaba 5:0728bde67bdb 160 * start of the next measurement cycle.
Vkadaba 5:0728bde67bdb 161 */
Vkadaba 8:2f2775c34640 162 typedef enum
Vkadaba 8:2f2775c34640 163 {
Vkadaba 5:0728bde67bdb 164 ADMW1001_OPEN_SENSOR_DIAGNOSTICS_DISABLED = 0,
Vkadaba 5:0728bde67bdb 165 /*!< No Open-Sensor Detection is performed */
Vkadaba 5:0728bde67bdb 166 ADMW1001_OPEN_SENSOR_DIAGNOSTICS_PER_CYCLE,
Vkadaba 5:0728bde67bdb 167 /*!< No Open-Sensor Detection is performed prior to each cycle */
Vkadaba 5:0728bde67bdb 168 ADMW1001_OPEN_SENSOR_DIAGNOSTICS_PER_100_CYCLES,
Vkadaba 5:0728bde67bdb 169 /*!< No Open-Sensor Detection is performed at intervals of 100 cycles */
Vkadaba 5:0728bde67bdb 170 ADMW1001_OPEN_SENSOR_DIAGNOSTICS_PER_1000_CYCLES,
Vkadaba 6:9d393a9677f4 171 /*!< No Open-Sensor Detection is performed at intervals of 1001 cycles */
Vkadaba 8:2f2775c34640 172
Vkadaba 8:2f2775c34640 173 } ADMW1001_OPEN_SENSOR_DIAGNOSTICS;
Vkadaba 5:0728bde67bdb 174
Vkadaba 33:df7a00f1b8e1 175
Vkadaba 33:df7a00f1b8e1 176 typedef enum
Vkadaba 33:df7a00f1b8e1 177 {
Vkadaba 33:df7a00f1b8e1 178 ADMW1001_BUFFER_BYPASSS_DISABLED = 0,
Vkadaba 33:df7a00f1b8e1 179 /*!< Buffer Bypass Disabled */
Vkadaba 33:df7a00f1b8e1 180 ADMW1001_BUFFER_BYPASSS_ENABLED,
Vkadaba 33:df7a00f1b8e1 181 /*!< Buffer Bypass Enabled */
Vkadaba 33:df7a00f1b8e1 182
Vkadaba 33:df7a00f1b8e1 183 } ADMW1001_BUFFER_BYPASSS;
Vkadaba 33:df7a00f1b8e1 184
Vkadaba 5:0728bde67bdb 185 /*! ADMW1001 analog input signal amplification gain options
Vkadaba 5:0728bde67bdb 186 *
Vkadaba 5:0728bde67bdb 187 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 188 */
Vkadaba 8:2f2775c34640 189 typedef enum
Vkadaba 8:2f2775c34640 190 {
Vkadaba 6:9d393a9677f4 191 ADMW1001_ADC_RTD_CURVE_EUROPEAN = 0,
Vkadaba 6:9d393a9677f4 192 /*!< EUROPEAN RTD curve used. */
Vkadaba 6:9d393a9677f4 193 ADMW1001_ADC_RTD_CURVE_AMERICAN,
Vkadaba 6:9d393a9677f4 194 /*!< AMERICAN RTD curve used. */
Vkadaba 6:9d393a9677f4 195 ADMW1001_ADC_RTD_CURVE_JAPANESE,
Vkadaba 6:9d393a9677f4 196 /*!< JAPANESE RTD curve used. */
Vkadaba 6:9d393a9677f4 197 ADMW1001_ADC_RTD_CURVE_ITS90,
Vkadaba 6:9d393a9677f4 198 /*!< ITS90 RTD curve used. */
Vkadaba 8:2f2775c34640 199
Vkadaba 8:2f2775c34640 200 } ADMW1001_ADC_RTD_CURVE;
Vkadaba 6:9d393a9677f4 201 /*! ADMW1001 analog input signal amplification gain options
Vkadaba 6:9d393a9677f4 202 *
Vkadaba 6:9d393a9677f4 203 * @note applicable only to ADC analog sensor channels
Vkadaba 6:9d393a9677f4 204 */
Vkadaba 8:2f2775c34640 205 typedef enum
Vkadaba 8:2f2775c34640 206 {
Vkadaba 5:0728bde67bdb 207 ADMW1001_ADC_GAIN_1X = 0,
Vkadaba 5:0728bde67bdb 208 /*!< no amplification gain */
Vkadaba 5:0728bde67bdb 209 ADMW1001_ADC_GAIN_2X,
Vkadaba 5:0728bde67bdb 210 /*!< x2 amplification gain */
Vkadaba 5:0728bde67bdb 211 ADMW1001_ADC_GAIN_4X,
Vkadaba 5:0728bde67bdb 212 /*!< x4 amplification gain */
Vkadaba 5:0728bde67bdb 213 ADMW1001_ADC_GAIN_8X,
Vkadaba 5:0728bde67bdb 214 /*!< x8 amplification gain */
Vkadaba 5:0728bde67bdb 215 ADMW1001_ADC_GAIN_16X,
Vkadaba 5:0728bde67bdb 216 /*!< x16 amplification gain */
Vkadaba 5:0728bde67bdb 217 ADMW1001_ADC_GAIN_32X,
Vkadaba 5:0728bde67bdb 218 /*!< x32 amplification gain */
Vkadaba 5:0728bde67bdb 219 ADMW1001_ADC_GAIN_64X,
Vkadaba 5:0728bde67bdb 220 /*!< x64 amplification gain */
Vkadaba 5:0728bde67bdb 221 ADMW1001_ADC_GAIN_128X,
Vkadaba 5:0728bde67bdb 222 /*!< x128 amplification gain */
Vkadaba 8:2f2775c34640 223
Vkadaba 8:2f2775c34640 224 } ADMW1001_ADC_GAIN;
Vkadaba 5:0728bde67bdb 225
Vkadaba 6:9d393a9677f4 226 /*! ADMW1001 analog sensor excitation state options
Vkadaba 6:9d393a9677f4 227 *
Vkadaba 6:9d393a9677f4 228 * @note applicable only to ADC analog sensor channels, and
Vkadaba 6:9d393a9677f4 229 * specific sensor types
Vkadaba 6:9d393a9677f4 230 */
Vkadaba 8:2f2775c34640 231 typedef enum
Vkadaba 8:2f2775c34640 232 {
Vkadaba 33:df7a00f1b8e1 233 ADMW1001_ADC_EXC_STATE_CYCLE_POWER=0,
Vkadaba 33:df7a00f1b8e1 234 /*!< Excitation for measurement is active only during measurement */
Vkadaba 6:9d393a9677f4 235 ADMW1001_ADC_EXC_STATE_ALWAYS_ON,
Vkadaba 6:9d393a9677f4 236 /*!< Excitation for measurement is always on */
Vkadaba 8:2f2775c34640 237 } ADMW1001_ADC_EXC_STATE;
Vkadaba 6:9d393a9677f4 238
Vkadaba 5:0728bde67bdb 239 /*! ADMW1001 analog sensor excitation current output level options
Vkadaba 5:0728bde67bdb 240 *
Vkadaba 5:0728bde67bdb 241 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 242 * specific sensor types
Vkadaba 5:0728bde67bdb 243 */
Vkadaba 8:2f2775c34640 244 typedef enum
Vkadaba 8:2f2775c34640 245 {
Vkadaba 18:cbf514cce921 246 ADMW1001_ADC_NO_EXTERNAL_EXC_CURRENT = -1,
Vkadaba 18:cbf514cce921 247 /*!< NO External excitation is provided */
Vkadaba 6:9d393a9677f4 248 ADMW1001_ADC_EXC_CURRENT_EXTERNAL = 0,
Vkadaba 6:9d393a9677f4 249 /*!< External excitation is provided */
Vkadaba 5:0728bde67bdb 250 ADMW1001_ADC_EXC_CURRENT_50uA,
Vkadaba 5:0728bde67bdb 251 /*!< 50uA excitation current enabled */
Vkadaba 5:0728bde67bdb 252 ADMW1001_ADC_EXC_CURRENT_100uA,
Vkadaba 5:0728bde67bdb 253 /*!< 100uA excitation current */
Vkadaba 5:0728bde67bdb 254 ADMW1001_ADC_EXC_CURRENT_250uA,
Vkadaba 5:0728bde67bdb 255 /*!< 250uA excitation current enabled */
Vkadaba 5:0728bde67bdb 256 ADMW1001_ADC_EXC_CURRENT_500uA,
Vkadaba 5:0728bde67bdb 257 /*!< 500uA excitation current enabled */
Vkadaba 5:0728bde67bdb 258 ADMW1001_ADC_EXC_CURRENT_1000uA,
Vkadaba 5:0728bde67bdb 259 /*!< 1mA excitation current enabled */
Vkadaba 8:2f2775c34640 260
Vkadaba 8:2f2775c34640 261 } ADMW1001_ADC_EXC_CURRENT;
Vkadaba 5:0728bde67bdb 262
Vkadaba 5:0728bde67bdb 263 /*! ADMW1001 analog sensor excitation current ratios used for diode sensor
Vkadaba 5:0728bde67bdb 264 *
Vkadaba 5:0728bde67bdb 265 * @note applicable only to a diode sensor
Vkadaba 5:0728bde67bdb 266 */
Vkadaba 8:2f2775c34640 267 typedef enum
Vkadaba 8:2f2775c34640 268 {
Vkadaba 6:9d393a9677f4 269 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_100UA = 0,
Vkadaba 6:9d393a9677f4 270 /**< 2 Current measurement 10uA 100uA */
Vkadaba 6:9d393a9677f4 271 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_160UA,
Vkadaba 6:9d393a9677f4 272 /**< 2 Current measurement 20uA 160uA */
Vkadaba 6:9d393a9677f4 273 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_300UA,
Vkadaba 6:9d393a9677f4 274 /**< 2 Current measurement 50uA 300uA */
Vkadaba 6:9d393a9677f4 275 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_600UA,
Vkadaba 6:9d393a9677f4 276 /**< 2 Current measurement 100uA 600uA */
Vkadaba 6:9d393a9677f4 277 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_50UA_100UA,
Vkadaba 6:9d393a9677f4 278 /**< 3 current measuremetn 10uA 50uA 100uA */
Vkadaba 6:9d393a9677f4 279 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_100UA_160UA,
Vkadaba 6:9d393a9677f4 280 /**< 3 current measuremetn 20uA 100uA 160uA */
Vkadaba 6:9d393a9677f4 281 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_150UA_300UA,
Vkadaba 6:9d393a9677f4 282 /**< 3 current measuremetn 50uA 150uA 300uA */
Vkadaba 6:9d393a9677f4 283 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_300UA_600UA,
Vkadaba 6:9d393a9677f4 284 /**< 3 current measuremetn 100uA 300uA 600uA */
Vkadaba 8:2f2775c34640 285
Vkadaba 8:2f2775c34640 286 } ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO;
Vkadaba 5:0728bde67bdb 287
Vkadaba 5:0728bde67bdb 288 /*! ADMW1001 analog reference selection options
Vkadaba 5:0728bde67bdb 289 *
Vkadaba 5:0728bde67bdb 290 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 291 * specific sensor types
Vkadaba 5:0728bde67bdb 292 */
Vkadaba 8:2f2775c34640 293 typedef enum
Vkadaba 8:2f2775c34640 294 {
Vkadaba 8:2f2775c34640 295 ADMW1001_ADC_REFERENCE_VOLTAGE_INTERNAL = 0,
Vkadaba 8:2f2775c34640 296 /*!< Internal VRef - 1.2V */
Vkadaba 8:2f2775c34640 297 ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_1,
Vkadaba 8:2f2775c34640 298 /*!< External reference voltage #1 */
Vkadaba 8:2f2775c34640 299 ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_2,
Vkadaba 8:2f2775c34640 300 /*!< External reference voltage #2 */
Vkadaba 5:0728bde67bdb 301 ADMW1001_ADC_REFERENCE_VOLTAGE_AVDD,
Vkadaba 5:0728bde67bdb 302 /*!< Analag Supply Voltage AVDD reference (typically 3.3V) is selected */
Vkadaba 5:0728bde67bdb 303
Vkadaba 8:2f2775c34640 304 } ADMW1001_ADC_REFERENCE_TYPE;
Vkadaba 5:0728bde67bdb 305
Vkadaba 6:9d393a9677f4 306 /*! ADMW1001 ADC Reference configuration
Vkadaba 6:9d393a9677f4 307 *
Vkadaba 6:9d393a9677f4 308 * @note applicable only to ADC analog sensor channels
Vkadaba 6:9d393a9677f4 309 */
Vkadaba 8:2f2775c34640 310 typedef enum
Vkadaba 8:2f2775c34640 311 {
Vkadaba 6:9d393a9677f4 312 ADMW1001_ADC_GND_SW_OPEN = 0,
Vkadaba 6:9d393a9677f4 313 /*!< Ground switch not enabled for measurement. */
Vkadaba 6:9d393a9677f4 314 ADMW1001_ADC_GND_SW_CLOSED,
Vkadaba 8:2f2775c34640 315 /*!< Ground switch enabled for measurement. */
Vkadaba 8:2f2775c34640 316
Vkadaba 8:2f2775c34640 317 } ADMW1001_ADC_GND_SW;
Vkadaba 8:2f2775c34640 318
Vkadaba 8:2f2775c34640 319 /*! ADMW1001 analog filter chop mode
Vkadaba 8:2f2775c34640 320 *
Vkadaba 8:2f2775c34640 321 * @note applicable only to ADC analog sensor channels
Vkadaba 8:2f2775c34640 322 */
Vkadaba 8:2f2775c34640 323 typedef enum
Vkadaba 8:2f2775c34640 324 {
Vkadaba 8:2f2775c34640 325 ADMW1001_CHOP_MD_NONE = 0,
Vkadaba 8:2f2775c34640 326 /*!< No chop performed. */
Vkadaba 8:2f2775c34640 327 ADMW1001_CHOP_MD_HW,
Vkadaba 8:2f2775c34640 328 /*!< Hardware only chop performed. */
Vkadaba 8:2f2775c34640 329 ADMW1001_CHOP_MD_SW,
Vkadaba 8:2f2775c34640 330 /*!< Software only chop performed. */
Vkadaba 8:2f2775c34640 331 ADMW1001_CHOP_MD_HWSW,
Vkadaba 8:2f2775c34640 332 /*!< Hardware and software chop performed. */
Vkadaba 8:2f2775c34640 333
Vkadaba 8:2f2775c34640 334 } ADMW1001_CHOP_MD;
Vkadaba 6:9d393a9677f4 335
Vkadaba 5:0728bde67bdb 336 /*! ADMW1001 analog filter selection options
Vkadaba 5:0728bde67bdb 337 *
Vkadaba 5:0728bde67bdb 338 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 339 */
Vkadaba 8:2f2775c34640 340 typedef enum
Vkadaba 8:2f2775c34640 341 {
Vkadaba 6:9d393a9677f4 342 ADMW1001_ADC_FILTER_SINC4 = 0,
Vkadaba 8:2f2775c34640 343 /*!< SINC4 - 4th order sinc response filter */
Vkadaba 6:9d393a9677f4 344 ADMW1001_ADC_FILTER_SINC3,
Vkadaba 8:2f2775c34640 345 /*!< SINC3 - 3rd order sinc response filter */
Vkadaba 8:2f2775c34640 346
Vkadaba 8:2f2775c34640 347 } ADMW1001_ADC_FILTER_TYPE;
Vkadaba 8:2f2775c34640 348
Vkadaba 8:2f2775c34640 349 /*! ADMW1001 Sinc Filter range (SF)
Vkadaba 8:2f2775c34640 350 *
Vkadaba 8:2f2775c34640 351 * @note applicable only to ADC analog sensor channels
Vkadaba 8:2f2775c34640 352 * @note SF must be set in conjunction with chop mode
Vkadaba 8:2f2775c34640 353 * and sinc filter type to achieve the desired sampling rate.
Vkadaba 8:2f2775c34640 354 */
Vkadaba 8:2f2775c34640 355 typedef enum
Vkadaba 8:2f2775c34640 356 {
Vkadaba 8:2f2775c34640 357 ADMW1001_SF_976HZ = 0,
Vkadaba 8:2f2775c34640 358 /*!< SF setting for 976Hz sample rate. */
Vkadaba 8:2f2775c34640 359 ADMW1001_SF_488HZ = 1,
Vkadaba 8:2f2775c34640 360 /*!< SF setting for 488Hz sample rate. */
Vkadaba 8:2f2775c34640 361 ADMW1001_SF_244HZ = 3,
Vkadaba 8:2f2775c34640 362 /*!< SF setting for 244Hz sample rate. */
Vkadaba 8:2f2775c34640 363 ADMW1001_SF_122HZ = 7,
Vkadaba 8:2f2775c34640 364 /*!< SF setting for 122Hz sample rate. */
Vkadaba 8:2f2775c34640 365 ADMW1001_SF_61HZ = 31,
Vkadaba 8:2f2775c34640 366 /*!< SF setting for 61Hz sample rate. */
Vkadaba 8:2f2775c34640 367 ADMW1001_SF_30P5HZ = 51,
Vkadaba 8:2f2775c34640 368 /*!< SF setting for 61Hz sample rate. */
Vkadaba 8:2f2775c34640 369 ADMW1001_SF_10HZ = 124,
Vkadaba 8:2f2775c34640 370 /*!< SF setting for 10Hz sample rate. */
Vkadaba 8:2f2775c34640 371 ADMW1001_SF_8P24HZ = 125,
Vkadaba 8:2f2775c34640 372 /*!< SF setting for 8.24Hz sample rate. */
Vkadaba 8:2f2775c34640 373 ADMW1001_SF_5HZ = 127,
Vkadaba 8:2f2775c34640 374 /*!< SF setting for 5Hz sample rate. */
Vkadaba 8:2f2775c34640 375
Vkadaba 8:2f2775c34640 376 } ADMW1001_SINC_FILTER_RANGE;
Vkadaba 5:0728bde67bdb 377
Vkadaba 5:0728bde67bdb 378 /*! ADMW1001 I2C clock speed options
Vkadaba 5:0728bde67bdb 379 *
Vkadaba 5:0728bde67bdb 380 * @note applicable only for I2C sensors
Vkadaba 5:0728bde67bdb 381 */
Vkadaba 5:0728bde67bdb 382 typedef enum
Vkadaba 5:0728bde67bdb 383 {
Vkadaba 8:2f2775c34640 384 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_100K = 0,
Vkadaba 5:0728bde67bdb 385 /*!< 100kHz I2C clock speed */
Vkadaba 8:2f2775c34640 386 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_400K,
Vkadaba 5:0728bde67bdb 387 /*!< 400kHz I2C clock speed */
Vkadaba 8:2f2775c34640 388
Vkadaba 8:2f2775c34640 389 } ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED;
Vkadaba 5:0728bde67bdb 390
Vkadaba 5:0728bde67bdb 391 /*! ADMW1001 SPI mode options
Vkadaba 5:0728bde67bdb 392 *
Vkadaba 5:0728bde67bdb 393 * @note applicable only for SPI sensors
Vkadaba 5:0728bde67bdb 394 */
Vkadaba 5:0728bde67bdb 395 typedef enum
Vkadaba 5:0728bde67bdb 396 {
Vkadaba 8:2f2775c34640 397 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_0 = 0,
Vkadaba 5:0728bde67bdb 398 /*!< SPI mode 0 Clock Polarity = 0 Clock Phase = 0 */
Vkadaba 8:2f2775c34640 399 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_1,
Vkadaba 5:0728bde67bdb 400 /*!< SPI mode 0 Clock Polarity = 0 Clock Phase = 1 */
Vkadaba 8:2f2775c34640 401 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_2,
Vkadaba 5:0728bde67bdb 402 /*!< SPI mode 0 Clock Polarity = 1 Clock Phase = 0 */
Vkadaba 8:2f2775c34640 403 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_3,
Vkadaba 5:0728bde67bdb 404 /*!< SPI mode 0 Clock Polarity = 1 Clock Phase = 1 */
Vkadaba 8:2f2775c34640 405
Vkadaba 8:2f2775c34640 406 } ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE;
Vkadaba 5:0728bde67bdb 407
Vkadaba 5:0728bde67bdb 408 /*! ADMW1001 SPI clock speed options
Vkadaba 5:0728bde67bdb 409 *
Vkadaba 5:0728bde67bdb 410 * @note applicable only for SPI sensors
Vkadaba 5:0728bde67bdb 411 */
Vkadaba 5:0728bde67bdb 412 typedef enum
Vkadaba 5:0728bde67bdb 413 {
Vkadaba 8:2f2775c34640 414 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_8MHZ = 0,
Vkadaba 8:2f2775c34640 415 /*!< SPI Clock Speed configured to 8MHz */
Vkadaba 8:2f2775c34640 416 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_4MHZ,
Vkadaba 8:2f2775c34640 417 /*!< SPI Clock Speed configured to 4MHz */
Vkadaba 8:2f2775c34640 418 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_2MHZ,
Vkadaba 8:2f2775c34640 419 /*!< SPI Clock Speed configured to 2MHz */
Vkadaba 8:2f2775c34640 420 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_1MHZ,
Vkadaba 8:2f2775c34640 421 /*!< SPI Clock Speed configured to 1MHz */
Vkadaba 8:2f2775c34640 422 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_500KHZ,
Vkadaba 8:2f2775c34640 423 /*!< SPI Clock Speed configured to 500kHz */
Vkadaba 8:2f2775c34640 424 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_250KHZ,
Vkadaba 8:2f2775c34640 425 /*!< SPI Clock Speed configured to 250kHz */
Vkadaba 8:2f2775c34640 426 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_125KHZ,
Vkadaba 8:2f2775c34640 427 /*!< SPI Clock Speed configured to 125kHz */
Vkadaba 8:2f2775c34640 428 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_62P5KHZ,
Vkadaba 8:2f2775c34640 429 /*!< SPI Clock Speed configured to 62.5kHz */
Vkadaba 8:2f2775c34640 430 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_31P3KHZ,
Vkadaba 8:2f2775c34640 431 /*!< SPI Clock Speed configured to 31.3kHz */
Vkadaba 8:2f2775c34640 432 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_15P6KHZ,
Vkadaba 8:2f2775c34640 433 /*!< SPI Clock Speed configured to 15.6kHz */
Vkadaba 8:2f2775c34640 434 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_7P8KHZ,
Vkadaba 8:2f2775c34640 435 /*!< SPI Clock Speed configured to 7.8kHz */
Vkadaba 8:2f2775c34640 436 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_3P9KHZ,
Vkadaba 8:2f2775c34640 437 /*!< SPI Clock Speed configured to 3.9kHz */
Vkadaba 8:2f2775c34640 438 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_1P9KHZ,
Vkadaba 8:2f2775c34640 439 /*!< SPI Clock Speed configured to 1.9kHz */
Vkadaba 8:2f2775c34640 440 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_977HZ,
Vkadaba 8:2f2775c34640 441 /*!< SPI Clock Speed configured to 977Hz */
Vkadaba 8:2f2775c34640 442 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_488HZ,
Vkadaba 8:2f2775c34640 443 /*!< SPI Clock Speed configured to 488Hz */
Vkadaba 8:2f2775c34640 444 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_244HZ,
Vkadaba 8:2f2775c34640 445 /*!< SPI Clock Speed configured to 244Hz */
Vkadaba 8:2f2775c34640 446
Vkadaba 8:2f2775c34640 447 } ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK;
Vkadaba 5:0728bde67bdb 448
Vkadaba 5:0728bde67bdb 449 /*! ADMW1001 Power Configuration options */
Vkadaba 8:2f2775c34640 450 typedef struct
Vkadaba 8:2f2775c34640 451 {
Vkadaba 5:0728bde67bdb 452 ADMW1001_POWER_MODE powerMode;
Vkadaba 5:0728bde67bdb 453 /*!< Power mode selection */
Vkadaba 8:2f2775c34640 454
Vkadaba 8:2f2775c34640 455 } ADMW1001_POWER_CONFIG;
Vkadaba 5:0728bde67bdb 456
Vkadaba 5:0728bde67bdb 457 /*! ADMW1001 Multi-Cycle Configuration options
Vkadaba 5:0728bde67bdb 458 *
Vkadaba 5:0728bde67bdb 459 * @note required only when ADMW1001_OPERATING_MODE_MULTICYCLE is selected
Vkadaba 5:0728bde67bdb 460 * as the operatingMode (@ref ADMW1001_MEASUREMENT_CONFIG)
Vkadaba 5:0728bde67bdb 461 */
Vkadaba 8:2f2775c34640 462 typedef struct
Vkadaba 8:2f2775c34640 463 {
Vkadaba 8:2f2775c34640 464 uint32_t cyclesPerBurst;
Vkadaba 5:0728bde67bdb 465 /*!< Number of cycles to complete for a single burst */
Vkadaba 8:2f2775c34640 466 uint32_t burstInterval;
Vkadaba 5:0728bde67bdb 467 /*!< Interval, in seconds, between each successive burst of cycles */
Vkadaba 8:2f2775c34640 468
Vkadaba 8:2f2775c34640 469 } ADMW1001_MULTICYCLE_CONFIG;
Vkadaba 5:0728bde67bdb 470
Vkadaba 5:0728bde67bdb 471 /*! ADMW1001 Measurement Configuration options */
Vkadaba 8:2f2775c34640 472 typedef struct
Vkadaba 8:2f2775c34640 473 {
Vkadaba 5:0728bde67bdb 474 ADMW1001_OPERATING_MODE operatingMode;
Vkadaba 5:0728bde67bdb 475 /*!< Operating mode - specifies how measurement cycles are scheduled */
Vkadaba 5:0728bde67bdb 476 ADMW1001_DATAREADY_MODE dataReadyMode;
Vkadaba 5:0728bde67bdb 477 /*!< Data read mode - specifies how output samples are stored for reading */
Vkadaba 5:0728bde67bdb 478 ADMW1001_MULTICYCLE_CONFIG multiCycleConfig;
Vkadaba 5:0728bde67bdb 479 /*!< Multi-Cycle configuration - specifies how bursts of measurement cycles
Vkadaba 5:0728bde67bdb 480 * are scheduled. Applicable only when operatingMode is
Vkadaba 5:0728bde67bdb 481 * ADMW1001_OPERATING_MODE_MULTICYCLE
Vkadaba 5:0728bde67bdb 482 */
Vkadaba 5:0728bde67bdb 483 ADMW1001_FILTER_SETTLING filterSettling;
Vkadaba 5:0728bde67bdb 484 /*!< Analog filter settling - specifies the policy for settling time
Vkadaba 5:0728bde67bdb 485 * between consecutive measurements from an analog channel in a multi-
Vkadaba 5:0728bde67bdb 486 * channel configuration. Note that, in single analog channel
Vkadaba 5:0728bde67bdb 487 * configurations, settling time is always skipped between consecutive
Vkadaba 5:0728bde67bdb 488 * measurements in a measurement cycle.
Vkadaba 5:0728bde67bdb 489 */
Vkadaba 8:2f2775c34640 490 uint8_t reserved0[3];
Vkadaba 8:2f2775c34640 491 /*!< Reserved for future use and ensure word alignment.
Vkadaba 8:2f2775c34640 492 */
Vkadaba 8:2f2775c34640 493 uint32_t cycleInterval;
Vkadaba 8:2f2775c34640 494 /*!< Cycle interval - specifies the time interval between the start of each
Vkadaba 8:2f2775c34640 495 * successive measurement cycle. Applicable only when operatingMode is
Vkadaba 8:2f2775c34640 496 * not ADMW1001_OPERATING_MODE_SINGLECYCLE
Vkadaba 8:2f2775c34640 497 */
Vkadaba 8:2f2775c34640 498 bool vBiasEnable;
Vkadaba 8:2f2775c34640 499 /*!< Enable voltage Bias output of ADC
Vkadaba 8:2f2775c34640 500 */
Vkadaba 8:2f2775c34640 501 float32_t externalRef1Value;
Vkadaba 8:2f2775c34640 502 /*!< Voltage value connected to external reference input #1.
Vkadaba 5:0728bde67bdb 503 * Applicable only if the selected reference type is
Vkadaba 8:2f2775c34640 504 * voltage.
Vkadaba 5:0728bde67bdb 505 * (see @ref ADMW1001_ADC_REFERENCE_TYPE)
Vkadaba 33:df7a00f1b8e1 506 */
Vkadaba 33:df7a00f1b8e1 507 float32_t RSenseValue;
Vkadaba 33:df7a00f1b8e1 508 /*!< Sense resistor value in Ohms. */
Vkadaba 33:df7a00f1b8e1 509 uint32_t reserved1[3];
Vkadaba 8:2f2775c34640 510 /*!< Reserved for future use and ensure word alignment.
Vkadaba 8:2f2775c34640 511 */
Vkadaba 8:2f2775c34640 512
Vkadaba 8:2f2775c34640 513 } ADMW1001_MEASUREMENT_CONFIG;
Vkadaba 5:0728bde67bdb 514
Vkadaba 5:0728bde67bdb 515 /*! ADMW1001 ADC Excitation Current output configuration
Vkadaba 5:0728bde67bdb 516 *
Vkadaba 5:0728bde67bdb 517 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 518 * specific sensor types
Vkadaba 5:0728bde67bdb 519 */
Vkadaba 8:2f2775c34640 520 typedef struct
Vkadaba 8:2f2775c34640 521 {
Vkadaba 6:9d393a9677f4 522 ADMW1001_ADC_EXC_STATE excitationState;
Vkadaba 6:9d393a9677f4 523 /*!< Excitation current state */
Vkadaba 5:0728bde67bdb 524 ADMW1001_ADC_EXC_CURRENT outputLevel;
Vkadaba 5:0728bde67bdb 525 /*!< Excitation current output level */
Vkadaba 5:0728bde67bdb 526 ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO diodeRatio;
Vkadaba 5:0728bde67bdb 527 /*!< Excitation current output diode ratio */
Vkadaba 8:2f2775c34640 528
Vkadaba 8:2f2775c34640 529 } ADMW1001_ADC_EXC_CURRENT_CONFIG;
Vkadaba 5:0728bde67bdb 530
Vkadaba 5:0728bde67bdb 531 /*! ADMW1001 ADC Filter configuration
Vkadaba 5:0728bde67bdb 532 *
Vkadaba 5:0728bde67bdb 533 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 534 */
Vkadaba 8:2f2775c34640 535 typedef struct
Vkadaba 8:2f2775c34640 536 {
Vkadaba 8:2f2775c34640 537 ADMW1001_ADC_FILTER_TYPE type;
Vkadaba 5:0728bde67bdb 538 /*!< Filter type selection */
Vkadaba 8:2f2775c34640 539 ADMW1001_SINC_FILTER_RANGE sf;
Vkadaba 8:2f2775c34640 540 /*!< SF value used along with filter type and chop mode to determine speed */
Vkadaba 17:2f0028880874 541 ADMW1001_CHOP_MD chopMode;
Vkadaba 6:9d393a9677f4 542 /*!< Enable filter chop */
Vkadaba 8:2f2775c34640 543 bool notch1p2;
Vkadaba 6:9d393a9677f4 544 /*!< Enable Notch 2 Filter Mode */
Vkadaba 8:2f2775c34640 545 ADMW1001_ADC_GND_SW groundSwitch;
Vkadaba 6:9d393a9677f4 546 /*!< Option to open or close sensor ground switch */
Vkadaba 5:0728bde67bdb 547
Vkadaba 8:2f2775c34640 548 } ADMW1001_ADC_FILTER_CONFIG;
Vkadaba 5:0728bde67bdb 549
Vkadaba 5:0728bde67bdb 550 /*! ADMW1001 ADC analog channel configuration details
Vkadaba 5:0728bde67bdb 551 *
Vkadaba 5:0728bde67bdb 552 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 553 */
Vkadaba 8:2f2775c34640 554 typedef struct
Vkadaba 8:2f2775c34640 555 {
Vkadaba 5:0728bde67bdb 556 ADMW1001_ADC_SENSOR_TYPE sensor;
Vkadaba 5:0728bde67bdb 557 /*!< Sensor type selection */
Vkadaba 6:9d393a9677f4 558 ADMW1001_ADC_RTD_CURVE rtdCurve;
Vkadaba 6:9d393a9677f4 559 /*!< Rtd curve selection */
Vkadaba 5:0728bde67bdb 560 ADMW1001_ADC_GAIN gain;
Vkadaba 5:0728bde67bdb 561 /*!< ADC Gain selection */
Vkadaba 5:0728bde67bdb 562 ADMW1001_ADC_EXC_CURRENT_CONFIG current;
Vkadaba 5:0728bde67bdb 563 /*!< ADC Excitation Current configuration */
Vkadaba 5:0728bde67bdb 564 ADMW1001_ADC_FILTER_CONFIG filter;
Vkadaba 5:0728bde67bdb 565 /*!< ADC Filter configuration */
Vkadaba 8:2f2775c34640 566 ADMW1001_ADC_REFERENCE_TYPE reference;
Vkadaba 11:8e6023d2e584 567 bool vBiasEnable;
Vkadaba 5:0728bde67bdb 568 /*!< ADC Reference configuration */
Vkadaba 33:df7a00f1b8e1 569 uint8_t bufferBypass;
Vkadaba 33:df7a00f1b8e1 570 /*!< Buffer Bypass configuration */
Vkadaba 33:df7a00f1b8e1 571 uint8_t reserved0[2];
Vkadaba 8:2f2775c34640 572 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 573 uint32_t reserved1[6];
Vkadaba 8:2f2775c34640 574 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 575
Vkadaba 8:2f2775c34640 576 } ADMW1001_ADC_CHANNEL_CONFIG;
Vkadaba 8:2f2775c34640 577
Vkadaba 8:2f2775c34640 578 /*! ADMW1001 look-up table selection
Vkadaba 8:2f2775c34640 579 * Select table used to linearise the measurement.
Vkadaba 8:2f2775c34640 580 */
Vkadaba 8:2f2775c34640 581 typedef enum
Vkadaba 8:2f2775c34640 582 {
Vkadaba 8:2f2775c34640 583 ADMW1001_LUT_DEFAULT = 0,
Vkadaba 8:2f2775c34640 584 /*!< Default LUT */
Vkadaba 8:2f2775c34640 585 ADMW1001_LUT_UNITY = 1,
Vkadaba 8:2f2775c34640 586 /*!< Unity LUT */
Vkadaba 8:2f2775c34640 587 ADMW1001_LUT_CUSTOM = 2,
Vkadaba 8:2f2775c34640 588 /*!< User defined custom LUT */
Vkadaba 8:2f2775c34640 589 ADMW1001_LUT_RESERVED = 3,
Vkadaba 8:2f2775c34640 590 /*!< Reserved for future use */
Vkadaba 8:2f2775c34640 591
Vkadaba 8:2f2775c34640 592 } ADMW1001_LUT_SELECT;
Vkadaba 5:0728bde67bdb 593
Vkadaba 5:0728bde67bdb 594 /*! ADMW1001 digital sensor data encoding
Vkadaba 5:0728bde67bdb 595 *
Vkadaba 5:0728bde67bdb 596 * @note applicable only to SPI and I2C digital sensor channels
Vkadaba 5:0728bde67bdb 597 */
Vkadaba 5:0728bde67bdb 598 typedef enum
Vkadaba 5:0728bde67bdb 599 {
Vkadaba 8:2f2775c34640 600 ADMW1001_DIGITAL_SENSOR_DATA_CODING_NONE = 0,
Vkadaba 5:0728bde67bdb 601 /**< None/Invalid - data format is ignored if coding is set to this value */
Vkadaba 5:0728bde67bdb 602 ADMW1001_DIGITAL_SENSOR_DATA_CODING_UNIPOLAR,
Vkadaba 5:0728bde67bdb 603 /**< Unipolar - unsigned integer values */
Vkadaba 5:0728bde67bdb 604 ADMW1001_DIGITAL_SENSOR_DATA_CODING_TWOS_COMPLEMENT,
Vkadaba 5:0728bde67bdb 605 /**< Twos-complement - signed integer values */
Vkadaba 5:0728bde67bdb 606 ADMW1001_DIGITAL_SENSOR_DATA_CODING_OFFSET_BINARY,
Vkadaba 5:0728bde67bdb 607 /**< Offset Binary - used to represent signed values with unsigned integers,
Vkadaba 5:0728bde67bdb 608 * with the mid-range value representing 0 */
Vkadaba 8:2f2775c34640 609
Vkadaba 8:2f2775c34640 610 } ADMW1001_DIGITAL_SENSOR_DATA_CODING;
Vkadaba 5:0728bde67bdb 611
Vkadaba 5:0728bde67bdb 612 /*! ADMW1001 digital sensor data format configuration
Vkadaba 5:0728bde67bdb 613 *
Vkadaba 5:0728bde67bdb 614 * @note applicable only to SPI and I2C digital sensor channels
Vkadaba 5:0728bde67bdb 615 */
Vkadaba 8:2f2775c34640 616 typedef struct
Vkadaba 8:2f2775c34640 617 {
Vkadaba 5:0728bde67bdb 618 ADMW1001_DIGITAL_SENSOR_DATA_CODING coding;
Vkadaba 5:0728bde67bdb 619 /**< Data Encoding of Sensor Result */
Vkadaba 5:0728bde67bdb 620 bool littleEndian;
Vkadaba 5:0728bde67bdb 621 /**< Set as true if data format is little-endian, false otherwise */
Vkadaba 5:0728bde67bdb 622 bool leftJustified;
Vkadaba 5:0728bde67bdb 623 /**< Set as true if data is left-justified in the data frame, false otherwise */
Vkadaba 5:0728bde67bdb 624 uint8_t frameLength;
Vkadaba 5:0728bde67bdb 625 /**< Data frame length (number of bytes to read from the sensor) */
Vkadaba 5:0728bde67bdb 626 uint8_t numDataBits;
Vkadaba 5:0728bde67bdb 627 /**< Number of relevant data bits to extract from the data frame */
Vkadaba 5:0728bde67bdb 628 uint8_t bitOffset;
Vkadaba 5:0728bde67bdb 629 /**< Data bit offset, relative to data alignment within the data frame */
Vkadaba 8:2f2775c34640 630 uint8_t reserved[2];
Vkadaba 8:2f2775c34640 631 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 632
Vkadaba 8:2f2775c34640 633 } ADMW1001_DIGITAL_SENSOR_DATA_FORMAT;
Vkadaba 5:0728bde67bdb 634
Vkadaba 5:0728bde67bdb 635 /*! ADMW1001 digital sensor command
Vkadaba 5:0728bde67bdb 636 *
Vkadaba 5:0728bde67bdb 637 * @note applicable only to SPI and I2C digital sensor channels
Vkadaba 5:0728bde67bdb 638 */
Vkadaba 8:2f2775c34640 639 typedef struct
Vkadaba 8:2f2775c34640 640 {
Vkadaba 5:0728bde67bdb 641 uint8_t command[ADMW1001_SENSOR_COMMAND_MAX_LENGTH];
Vkadaba 5:0728bde67bdb 642 /*!< Optional command bytes to send to the device */
Vkadaba 5:0728bde67bdb 643 uint8_t commandLength;
Vkadaba 5:0728bde67bdb 644 /*!< Number of valid command bytes. Set to 0 if unused */
Vkadaba 8:2f2775c34640 645
Vkadaba 8:2f2775c34640 646 } ADMW1001_DIGITAL_SENSOR_COMMAND;
Vkadaba 5:0728bde67bdb 647
Vkadaba 5:0728bde67bdb 648 /*! ADMW1001 digital sensor calibration param
Vkadaba 5:0728bde67bdb 649 *
Vkadaba 5:0728bde67bdb 650 * @note applicable only to digital sensor channels
Vkadaba 5:0728bde67bdb 651 */
Vkadaba 8:2f2775c34640 652 typedef struct
Vkadaba 8:2f2775c34640 653 {
Vkadaba 5:0728bde67bdb 654 uint32_t calibrationParam;
Vkadaba 5:0728bde67bdb 655 /*!< Independently established environmental variable used during calibration
Vkadaba 5:0728bde67bdb 656 * of a digital sensor. Used only if the sensor supports calibration
Vkadaba 5:0728bde67bdb 657 * and expects an environmental parameter
Vkadaba 5:0728bde67bdb 658 */
Vkadaba 5:0728bde67bdb 659 bool enableCalibrationParam;
Vkadaba 5:0728bde67bdb 660 /*!< Allow Calibration_Parameter to be used during calibration of any digital sensor */
Vkadaba 8:2f2775c34640 661 uint8_t reserved[3];
Vkadaba 8:2f2775c34640 662 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 663
Vkadaba 8:2f2775c34640 664 } ADMW1001_DIGITAL_CALIBRATION_COMMAND;
Vkadaba 5:0728bde67bdb 665
Vkadaba 5:0728bde67bdb 666 /*! ADMW1001 digital sensor communication config
Vkadaba 5:0728bde67bdb 667 *
Vkadaba 5:0728bde67bdb 668 * @note applicable only to digital sensor channels
Vkadaba 5:0728bde67bdb 669 */
Vkadaba 8:2f2775c34640 670 typedef struct
Vkadaba 8:2f2775c34640 671 {
Vkadaba 8:2f2775c34640 672 bool useCustomCommsConfig;
Vkadaba 5:0728bde67bdb 673 /*!< Optional parameter to enable user digital communication settings */
Vkadaba 8:2f2775c34640 674 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED i2cClockSpeed;
Vkadaba 5:0728bde67bdb 675 /*!< Optional parameter to configure specific i2c speed for i2c sensor */
Vkadaba 8:2f2775c34640 676 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE spiMode;
Vkadaba 5:0728bde67bdb 677 /*!< Optional parameter to configure specific spi mode for spi sensor */
Vkadaba 8:2f2775c34640 678 ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK spiClock;
Vkadaba 5:0728bde67bdb 679 /*!< Optional parameter to configure specific spi clock for spi sensor */
Vkadaba 8:2f2775c34640 680
Vkadaba 8:2f2775c34640 681 } ADMW1001_DIGITAL_SENSOR_COMMS;
Vkadaba 5:0728bde67bdb 682
Vkadaba 5:0728bde67bdb 683 /*! ADMW1001 I2C digital channel configuration details
Vkadaba 5:0728bde67bdb 684 *
Vkadaba 5:0728bde67bdb 685 * @note applicable only to I2C digital sensor channels
Vkadaba 5:0728bde67bdb 686 */
Vkadaba 8:2f2775c34640 687 typedef struct
Vkadaba 8:2f2775c34640 688 {
Vkadaba 8:2f2775c34640 689 ADMW1001_I2C_SENSOR_TYPE sensor;
Vkadaba 5:0728bde67bdb 690 /*!< Sensor type selection */
Vkadaba 8:2f2775c34640 691 uint8_t deviceAddress;
Vkadaba 5:0728bde67bdb 692 /*!< I2C device address (7-bit) */
Vkadaba 8:2f2775c34640 693 uint8_t reserved;
Vkadaba 8:2f2775c34640 694 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 695 ADMW1001_DIGITAL_SENSOR_COMMAND configurationCommand;
Vkadaba 5:0728bde67bdb 696 /*!< Optional configuration command to send to the device at start-up.
Vkadaba 5:0728bde67bdb 697 * A default configuration command will be used if this is not specified.
Vkadaba 5:0728bde67bdb 698 * Applicable only to specific I2C sensor types.
Vkadaba 5:0728bde67bdb 699 */
Vkadaba 8:2f2775c34640 700 ADMW1001_DIGITAL_SENSOR_COMMAND dataRequestCommand;
Vkadaba 5:0728bde67bdb 701 /*!< Optional data request command to send to the device for each sample.
Vkadaba 5:0728bde67bdb 702 * A default data request command will be used if this is not specified.
Vkadaba 5:0728bde67bdb 703 * Applicable only to specific I2C sensor types.
Vkadaba 5:0728bde67bdb 704 */
Vkadaba 8:2f2775c34640 705 ADMW1001_DIGITAL_SENSOR_DATA_FORMAT dataFormat;
Vkadaba 5:0728bde67bdb 706 /*!< Optional data format configuration to parse/extract data from the device.
Vkadaba 5:0728bde67bdb 707 * A default data format will be used if this is not specified.
Vkadaba 5:0728bde67bdb 708 * Applicable only to specific I2C sensor types
Vkadaba 5:0728bde67bdb 709 */
Vkadaba 8:2f2775c34640 710 ADMW1001_DIGITAL_CALIBRATION_COMMAND digitalCalibrationParam;
Vkadaba 5:0728bde67bdb 711 /*!< This is used to supply an independently established environmental variable
Vkadaba 5:0728bde67bdb 712 * that must be used during calibration of a [digital] sensor which a)
Vkadaba 5:0728bde67bdb 713 * supports calibration and b) expects an environmental parameter.
Vkadaba 5:0728bde67bdb 714 * An example is a CO2 sensor, which may require the CO2 concentration level
Vkadaba 5:0728bde67bdb 715 * when performing a calibration
Vkadaba 5:0728bde67bdb 716 */
Vkadaba 8:2f2775c34640 717 ADMW1001_DIGITAL_SENSOR_COMMS configureComms;
Vkadaba 5:0728bde67bdb 718 /*!< Optional configuration to setup a user communication config.
Vkadaba 5:0728bde67bdb 719 * A default configuration will be used if this is not specified.
Vkadaba 5:0728bde67bdb 720 * Applicable only to specific I2C sensor types.
Vkadaba 5:0728bde67bdb 721 */
Vkadaba 8:2f2775c34640 722
Vkadaba 8:2f2775c34640 723 } ADMW1001_I2C_CHANNEL_CONFIG;
Vkadaba 5:0728bde67bdb 724
Vkadaba 5:0728bde67bdb 725 /*! ADMW1001 SPI digital channel configuration details
Vkadaba 5:0728bde67bdb 726 *
Vkadaba 5:0728bde67bdb 727 * @note applicable only to SPI digital sensor channels
Vkadaba 5:0728bde67bdb 728 */
Vkadaba 8:2f2775c34640 729 typedef struct
Vkadaba 8:2f2775c34640 730 {
Vkadaba 5:0728bde67bdb 731 ADMW1001_SPI_SENSOR_TYPE sensor;
Vkadaba 5:0728bde67bdb 732 /*!< Sensor type selection */
Vkadaba 8:2f2775c34640 733 uint8_t reserved[2];
Vkadaba 8:2f2775c34640 734 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 5:0728bde67bdb 735 ADMW1001_DIGITAL_SENSOR_COMMAND configurationCommand;
Vkadaba 5:0728bde67bdb 736 /*!< Optional configuration command to send to the device at start-up.
Vkadaba 5:0728bde67bdb 737 * A default configuration command will be used if this is not specified.
Vkadaba 5:0728bde67bdb 738 * Applicable only to specific SPI sensor types.
Vkadaba 5:0728bde67bdb 739 */
Vkadaba 5:0728bde67bdb 740 ADMW1001_DIGITAL_SENSOR_COMMAND dataRequestCommand;
Vkadaba 5:0728bde67bdb 741 /*!< Optional data request command to send to the device for each sample.
Vkadaba 5:0728bde67bdb 742 * A default data request command will be used if this is not specified.
Vkadaba 5:0728bde67bdb 743 * Applicable only to specific SPI sensor types.
Vkadaba 5:0728bde67bdb 744 */
Vkadaba 5:0728bde67bdb 745 ADMW1001_DIGITAL_SENSOR_DATA_FORMAT dataFormat;
Vkadaba 5:0728bde67bdb 746 /*!< Optional data format configuration to parse/extract data from the device.
Vkadaba 5:0728bde67bdb 747 * A default data format will be used if this is not specified.
Vkadaba 5:0728bde67bdb 748 * Applicable only to specific SPI sensor types
Vkadaba 5:0728bde67bdb 749 */
Vkadaba 5:0728bde67bdb 750 ADMW1001_DIGITAL_CALIBRATION_COMMAND digitalCalibrationParam;
Vkadaba 5:0728bde67bdb 751 /*!< This is used to supply an independently established environmental variable
Vkadaba 5:0728bde67bdb 752 * that must be used during calibration of a [digital] sensor which a)
Vkadaba 5:0728bde67bdb 753 * supports calibration and b) expects an environmental parameter.
Vkadaba 5:0728bde67bdb 754 * An example is a CO2 sensor, which may require the CO2 concentration level
Vkadaba 5:0728bde67bdb 755 * when performing a calibration
Vkadaba 5:0728bde67bdb 756 */
Vkadaba 8:2f2775c34640 757 ADMW1001_DIGITAL_SENSOR_COMMS configureComms;
Vkadaba 5:0728bde67bdb 758 /*!< Optional configuration to setup a user communication config.
Vkadaba 5:0728bde67bdb 759 * A default configuration will be used if this is not specified.
Vkadaba 5:0728bde67bdb 760 * Applicable only to specific SPI sensor types.
Vkadaba 5:0728bde67bdb 761 */
Vkadaba 5:0728bde67bdb 762
Vkadaba 8:2f2775c34640 763 } ADMW1001_SPI_CHANNEL_CONFIG;
Vkadaba 5:0728bde67bdb 764
Vkadaba 5:0728bde67bdb 765 /*! ADMW1001 Measurement Channel configuration details */
Vkadaba 8:2f2775c34640 766 typedef struct
Vkadaba 8:2f2775c34640 767 {
Vkadaba 8:2f2775c34640 768 bool enableChannel;
Vkadaba 5:0728bde67bdb 769 /*!< Option to include this channel in normal measurement cycles */
Vkadaba 8:2f2775c34640 770 bool disablePublishing;
Vkadaba 5:0728bde67bdb 771 /*!< Option to disable publishing of data samples from this channel. The
Vkadaba 5:0728bde67bdb 772 * channel may still be included in measurement cycles, but data samples
Vkadaba 5:0728bde67bdb 773 * obtained from this channel will not be published. This is typically
Vkadaba 5:0728bde67bdb 774 * used for channels which are required only as a compensation reference
Vkadaba 5:0728bde67bdb 775 * for another channel (e.g. Cold-Junction Compensation channels).
Vkadaba 5:0728bde67bdb 776 */
Vkadaba 8:2f2775c34640 777 ADMW1001_CH_ID compensationChannel;
Vkadaba 8:2f2775c34640 778 /*!< Optional compensation channel. Set to ADMW1001_CH_ID_NONE if not
Vkadaba 5:0728bde67bdb 779 * required. Typically used for thermocouple sensors that require a
Vkadaba 5:0728bde67bdb 780 * separate measurement of the "cold-junction" temperature, which can be
Vkadaba 5:0728bde67bdb 781 * be provided by an RTD temperature sensor connected on a separate
Vkadaba 5:0728bde67bdb 782 * "compensation channel" */
Vkadaba 8:2f2775c34640 783 ADMW1001_LUT_SELECT lutSelect;
Vkadaba 8:2f2775c34640 784 /*!<Select Look Up Table LUT for calculations, this implies that the
Vkadaba 5:0728bde67bdb 785 * fundamental measurement for the sensor (typically mV or Ohms)
Vkadaba 8:2f2775c34640 786 * 0 = default, 1= unity, 2 = custom
Vkadaba 5:0728bde67bdb 787 */
Vkadaba 8:2f2775c34640 788 ADMW1001_MEASUREMENT_UNIT measurementUnit;
Vkadaba 5:0728bde67bdb 789 /*!< Optional measurement unit selection for conversion results. Applicable
Vkadaba 5:0728bde67bdb 790 * only for certain sensor types. Set to
Vkadaba 5:0728bde67bdb 791 * ADMW1001_MEASUREMENT_UNIT_DEFAULT if not applicable.
Vkadaba 5:0728bde67bdb 792 */
Vkadaba 8:2f2775c34640 793 float32_t lowThreshold;
Vkadaba 5:0728bde67bdb 794 /*!< Optional minimum threshold value for each processed sample, to be
Vkadaba 5:0728bde67bdb 795 * checked prior to publishing. A channel ALERT condition is raised
Vkadaba 5:0728bde67bdb 796 * if the processed value is lower than this threshold. Set to NaN
Vkadaba 5:0728bde67bdb 797 * if not required.
Vkadaba 5:0728bde67bdb 798 */
Vkadaba 8:2f2775c34640 799 float32_t highThreshold;
Vkadaba 5:0728bde67bdb 800 /*!< Optional maximum threshold value for each processed sample, to be
Vkadaba 5:0728bde67bdb 801 * checked prior to publishing. A channel ALERT condition is raised
Vkadaba 5:0728bde67bdb 802 * if the processed value is higher than this threshold. Set to NaN
Vkadaba 5:0728bde67bdb 803 * if not required.
Vkadaba 5:0728bde67bdb 804 */
Vkadaba 8:2f2775c34640 805 float32_t offsetAdjustment;
Vkadaba 5:0728bde67bdb 806 /*!< Optional offset adjustment value applied to each processed sample.
Vkadaba 5:0728bde67bdb 807 * Set to NaN or 0.0 if not required.
Vkadaba 5:0728bde67bdb 808 */
Vkadaba 8:2f2775c34640 809 float32_t gainAdjustment;
Vkadaba 5:0728bde67bdb 810 /*!< Optional gain adjustment value applied to each processed sample.
Vkadaba 5:0728bde67bdb 811 * Set to NaN or 1.0 if not required.
Vkadaba 5:0728bde67bdb 812 */
Vkadaba 8:2f2775c34640 813 float32_t sensorParameter;
Vkadaba 5:0728bde67bdb 814 /*!< Optional sensor parameter adjustment.
Vkadaba 5:0728bde67bdb 815 * Set to NaN or 0 if not required.
Vkadaba 5:0728bde67bdb 816 */
Vkadaba 8:2f2775c34640 817 uint32_t measurementsPerCycle;
Vkadaba 5:0728bde67bdb 818 /*!< The number of measurements to obtain from this channel within each
Vkadaba 5:0728bde67bdb 819 * cycle. Each enabled channel is measured in turn, until the number of
Vkadaba 5:0728bde67bdb 820 * measurements requested for the channel has been reached. A different
Vkadaba 5:0728bde67bdb 821 * number of measurements-per-cycle may be specified for each channel.
Vkadaba 5:0728bde67bdb 822 */
Vkadaba 8:2f2775c34640 823 uint32_t cycleSkipCount;
Vkadaba 5:0728bde67bdb 824 /*!< Optional number of cycles to skip, such that this channel is included
Vkadaba 5:0728bde67bdb 825 * in the sequence in only one of every (cycleSkipCount + 1) cycles that
Vkadaba 5:0728bde67bdb 826 * occur. If set to 0 (default), this channel is included in every cycle;
Vkadaba 5:0728bde67bdb 827 * if set to 1, this channel is included in every 2nd cycle; if set to 2,
Vkadaba 5:0728bde67bdb 828 * this channel is included in every 3rd cycle, and so on.
Vkadaba 5:0728bde67bdb 829 */
Vkadaba 8:2f2775c34640 830 uint32_t extraSettlingTime;
Vkadaba 5:0728bde67bdb 831 /*!< A minimum settling time is applied internally for each channel, based
Vkadaba 5:0728bde67bdb 832 * on the sensor type. However, additional settling time (microseconds)
Vkadaba 5:0728bde67bdb 833 * can optionally be specified. Set to 0 if not required.
Vkadaba 5:0728bde67bdb 834 */
Vkadaba 8:2f2775c34640 835 ADMW1001_CHANNEL_PRIORITY priority;
Vkadaba 5:0728bde67bdb 836 /*!< By default, channels are arranged in the measurement sequence based on
Vkadaba 5:0728bde67bdb 837 * ascending order of channel ID. However, a priority-level may be
Vkadaba 5:0728bde67bdb 838 * specified per channel to force a different ordering of the channels,
Vkadaba 5:0728bde67bdb 839 * with higher-priority channels appearing before lower-priority channels.
Vkadaba 5:0728bde67bdb 840 * Channels with equal priority are ordered by ascending order of channel
Vkadaba 5:0728bde67bdb 841 * ID. Lower numbers indicate higher priority, with 0 being the highest.
Vkadaba 5:0728bde67bdb 842 * Set to 0 if not required.
Vkadaba 5:0728bde67bdb 843 */
Vkadaba 8:2f2775c34640 844 union
Vkadaba 8:2f2775c34640 845 {
Vkadaba 8:2f2775c34640 846 ADMW1001_ADC_CHANNEL_CONFIG adcChannelConfig;
Vkadaba 5:0728bde67bdb 847 /*!< ADC channel configuration - applicable only to ADC channels */
Vkadaba 8:2f2775c34640 848 ADMW1001_I2C_CHANNEL_CONFIG i2cChannelConfig;
Vkadaba 5:0728bde67bdb 849 /*!< I2C channel configuration - applicable only to I2C channels */
Vkadaba 8:2f2775c34640 850 ADMW1001_SPI_CHANNEL_CONFIG spiChannelConfig;
Vkadaba 5:0728bde67bdb 851 /*!< SPI channel configuration - applicable only to SPI channels */
Vkadaba 5:0728bde67bdb 852 };
Vkadaba 6:9d393a9677f4 853 /*!< Only one of adcChannelConfig, i2cChannelConfig, spiChannelConfig
Vkadaba 6:9d393a9677f4 854 * is required, depending on the channel designation
Vkadaba 6:9d393a9677f4 855 * (analog, I2C, SPI)
Vkadaba 5:0728bde67bdb 856 */
Vkadaba 8:2f2775c34640 857
Vkadaba 8:2f2775c34640 858 } ADMW1001_CHANNEL_CONFIG;
Vkadaba 5:0728bde67bdb 859
Vkadaba 5:0728bde67bdb 860 /*! ADMW1001 Diagnostics configuration details */
Vkadaba 8:2f2775c34640 861 typedef struct
Vkadaba 8:2f2775c34640 862 {
Vkadaba 8:2f2775c34640 863 bool disableGlobalDiag;
Vkadaba 5:0728bde67bdb 864 /*!< Option to disable the following diagnostic checks on the ADC:
Vkadaba 5:0728bde67bdb 865 * - Reference Detection errors
Vkadaba 5:0728bde67bdb 866 * - Input under-/over-voltage errors
Vkadaba 5:0728bde67bdb 867 * - Calibration, Conversion and Saturation errors
Vkadaba 5:0728bde67bdb 868 */
Vkadaba 8:2f2775c34640 869 bool disableMeasurementDiag;
Vkadaba 5:0728bde67bdb 870 /*!< Option to disable additional checks per measurement channel:
Vkadaba 5:0728bde67bdb 871 * - High/low threshold limit violation
Vkadaba 5:0728bde67bdb 872 */
Vkadaba 8:2f2775c34640 873
Vkadaba 8:2f2775c34640 874 bool disableCriticalTempAbort;
Vkadaba 5:0728bde67bdb 875 /*!< Option to disable abort of measurement cycle if the operating
Vkadaba 5:0728bde67bdb 876 * temperature of the ADMW1001 has exceeded critical limits
Vkadaba 5:0728bde67bdb 877 */
Vkadaba 8:2f2775c34640 878
Vkadaba 8:2f2775c34640 879 ADMW1001_OPEN_SENSOR_DIAGNOSTICS osdFrequency;
Vkadaba 5:0728bde67bdb 880 /*!< Option to enable Open-Circuit Detection at a selected cycle interval */
Vkadaba 5:0728bde67bdb 881
Vkadaba 8:2f2775c34640 882 } ADMW1001_DIAGNOSTICS_CONFIG;
Vkadaba 8:2f2775c34640 883
Vkadaba 5:0728bde67bdb 884 typedef uint16_t ADMW1001_ADVANCED_ACCESS_KEY;
Vkadaba 5:0728bde67bdb 885
Vkadaba 5:0728bde67bdb 886 /*! ADMW1001 Device configuration details */
Vkadaba 8:2f2775c34640 887 typedef struct
Vkadaba 8:2f2775c34640 888 {
Vkadaba 5:0728bde67bdb 889 ADMW1001_POWER_CONFIG power;
Vkadaba 5:0728bde67bdb 890 /*!< Power configuration details */
Vkadaba 5:0728bde67bdb 891 ADMW1001_MEASUREMENT_CONFIG measurement;
Vkadaba 5:0728bde67bdb 892 /*!< Measurement configuration details */
Vkadaba 5:0728bde67bdb 893 ADMW1001_DIAGNOSTICS_CONFIG diagnostics;
Vkadaba 5:0728bde67bdb 894 /*!< FFT configuration details */
Vkadaba 5:0728bde67bdb 895 ADMW1001_CHANNEL_CONFIG channels[ADMW1001_MAX_CHANNELS];
Vkadaba 5:0728bde67bdb 896 /*!< Channel-specific configuration details */
Vkadaba 5:0728bde67bdb 897 ADMW1001_ADVANCED_ACCESS_KEY advancedAccessKey;
Vkadaba 5:0728bde67bdb 898 /*!< Key to enable access to advanced sensor configuration options */
Vkadaba 8:2f2775c34640 899
Vkadaba 8:2f2775c34640 900 } ADMW1001_CONFIG;
Vkadaba 5:0728bde67bdb 901
Vkadaba 5:0728bde67bdb 902 #ifdef __cplusplus
Vkadaba 5:0728bde67bdb 903 }
Vkadaba 5:0728bde67bdb 904 #endif
Vkadaba 5:0728bde67bdb 905
Vkadaba 5:0728bde67bdb 906 /*!
Vkadaba 5:0728bde67bdb 907 * @}
Vkadaba 5:0728bde67bdb 908 */
Vkadaba 5:0728bde67bdb 909
Vkadaba 5:0728bde67bdb 910 #endif /* __ADMW1001_CONFIG_H__ */