ADMW1001_Mbed_FW / Mbed OS EV-PRO-MW1001_Development

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

inc/admw1001/admw1001_config.h@77:d90214f44903, 2020-05-07 (annotated)

Committer:
Vkadaba
Date:
Thu May 07 08:50:22 2020 +0000
Revision:
77:d90214f44903
Parent:
75:434d91af4cc7 
Modificaiton in SF configuration comments

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 77:d90214f44903 61 typedef enum {
Vkadaba 5:0728bde67bdb 62 ADMW1001_CHANNEL_PRIORITY_0 = 0,
Vkadaba 5:0728bde67bdb 63 ADMW1001_CHANNEL_PRIORITY_1,
Vkadaba 5:0728bde67bdb 64 ADMW1001_CHANNEL_PRIORITY_2,
Vkadaba 5:0728bde67bdb 65 ADMW1001_CHANNEL_PRIORITY_3,
Vkadaba 5:0728bde67bdb 66 ADMW1001_CHANNEL_PRIORITY_4,
Vkadaba 5:0728bde67bdb 67 ADMW1001_CHANNEL_PRIORITY_5,
Vkadaba 5:0728bde67bdb 68 ADMW1001_CHANNEL_PRIORITY_6,
Vkadaba 5:0728bde67bdb 69 ADMW1001_CHANNEL_PRIORITY_7,
Vkadaba 5:0728bde67bdb 70 ADMW1001_CHANNEL_PRIORITY_8,
Vkadaba 5:0728bde67bdb 71 ADMW1001_CHANNEL_PRIORITY_9,
Vkadaba 5:0728bde67bdb 72 ADMW1001_CHANNEL_PRIORITY_10,
Vkadaba 5:0728bde67bdb 73 ADMW1001_CHANNEL_PRIORITY_11,
Vkadaba 5:0728bde67bdb 74 ADMW1001_CHANNEL_PRIORITY_12,
Vkadaba 5:0728bde67bdb 75
Vkadaba 5:0728bde67bdb 76 ADMW1001_CHANNEL_PRIORITY_HIGHEST = ADMW1001_CHANNEL_PRIORITY_0,
Vkadaba 8:2f2775c34640 77 ADMW1001_CHANNEL_PRIORITY_LOWEST = ADMW1001_CHANNEL_PRIORITY_12,
Vkadaba 8:2f2775c34640 78
Vkadaba 8:2f2775c34640 79 } ADMW1001_CHANNEL_PRIORITY;
Vkadaba 5:0728bde67bdb 80
Vkadaba 5:0728bde67bdb 81 /*! ADMW1001 operating mode options */
Vkadaba 77:d90214f44903 82 typedef enum {
Vkadaba 5:0728bde67bdb 83 ADMW1001_OPERATING_MODE_SINGLECYCLE = 0,
Vkadaba 5:0728bde67bdb 84 /*!< Executes a single measurement cycle and stops */
Vkadaba 5:0728bde67bdb 85 ADMW1001_OPERATING_MODE_CONTINUOUS,
Vkadaba 5:0728bde67bdb 86 /*!< Continuously executes measurement cycles */
Vkadaba 8:2f2775c34640 87
Vkadaba 8:2f2775c34640 88 } ADMW1001_OPERATING_MODE;
Vkadaba 5:0728bde67bdb 89
Vkadaba 5:0728bde67bdb 90 /*! ADMW1001 data ready mode options */
Vkadaba 77:d90214f44903 91 typedef enum {
Vkadaba 5:0728bde67bdb 92 ADMW1001_DATAREADY_PER_CONVERSION = 0,
Vkadaba 5:0728bde67bdb 93 /*!< The DATAREADY signal is asserted after completion of each conversion
Vkadaba 5:0728bde67bdb 94 * - a single data sample only from the latest completed conversion is
Vkadaba 5:0728bde67bdb 95 * stored in this mode
Vkadaba 5:0728bde67bdb 96 */
Vkadaba 5:0728bde67bdb 97 ADMW1001_DATAREADY_PER_CYCLE,
Vkadaba 5:0728bde67bdb 98 /*!< The DATAREADY signal is asserted after completion of each measurement
Vkadaba 5:0728bde67bdb 99 * cycle
Vkadaba 5:0728bde67bdb 100 * - data samples only from the lastest completed measurement cycle are
Vkadaba 5:0728bde67bdb 101 * stored in this mode
Vkadaba 5:0728bde67bdb 102 */
Vkadaba 8:2f2775c34640 103 ADMW1001_DATAREADY_PER_FIFO_FILL,
Vkadaba 8:2f2775c34640 104 /*!< The DATAREADY signal is asserted after each fill of the data FIFO
Vkadaba 8:2f2775c34640 105 * - applicable only when @ref ADMW1001_OPERATING_MODE_CONTINUOUS or
Vkadaba 8:2f2775c34640 106 * @ref ADMW1001_OPERATING_MODE_MULTICYCLE is also selected
Vkadaba 5:0728bde67bdb 107 */
Vkadaba 8:2f2775c34640 108
Vkadaba 8:2f2775c34640 109 } ADMW1001_DATAREADY_MODE;
Vkadaba 5:0728bde67bdb 110
Vkadaba 5:0728bde67bdb 111 /*! ADMW1001 power mode options */
Vkadaba 77:d90214f44903 112 typedef enum {
Vkadaba 50:d84305e5e1c0 113 ADMW1001_POWER_MODE_ACTIVE = 0,
Vkadaba 50:d84305e5e1c0 114 /*!< Part is fully powered up and either cycling through a sequence or awaiting a configuration */
Vkadaba 50:d84305e5e1c0 115 ADMW1001_POWER_MODE_HIBERNATION,
Vkadaba 6:9d393a9677f4 116 /*!< module has entede hibernation mode. All analog circuitry is disabled. All peripherals disabled apart from the Wake-up pin functionality. */
Vkadaba 5:0728bde67bdb 117
Vkadaba 8:2f2775c34640 118 } ADMW1001_POWER_MODE;
Vkadaba 8:2f2775c34640 119
Vkadaba 72:35ea0b4e725b 120 /*! ADMW1001 External Vref Buffer Mode options */
Vkadaba 77:d90214f44903 121 typedef enum {
Vkadaba 72:35ea0b4e725b 122 ADMW1001_VREF_BUFF_MODE_DISABLE_BOTH = 0,
Vkadaba 72:35ea0b4e725b 123 /*!< Both Vref+ and Vref- buffers to be disabled */
Vkadaba 72:35ea0b4e725b 124 ADMW1001_VREF_BUFF_MODE_ONLY_POS,
Vkadaba 72:35ea0b4e725b 125 /*!< only Vref+ buffer to be disabled */
Vkadaba 72:35ea0b4e725b 126 ADMW1001_VREF_BUFF_MODE_ONLY_NEG,
Vkadaba 72:35ea0b4e725b 127 /*!< Only Vref- buffers to be disabled */
Vkadaba 77:d90214f44903 128 ADMW1001_VREF_BUFF_MODE_ENABLE_BOTH,
Vkadaba 72:35ea0b4e725b 129 /*!< Both Vref+ and Vref- buffers to be Enabled */
Vkadaba 72:35ea0b4e725b 130 } ADMW1001_VREF_BUFFER_MODE;
Vkadaba 5:0728bde67bdb 131
Vkadaba 5:0728bde67bdb 132 /*! ADMW1001 measurement unit options
Vkadaba 5:0728bde67bdb 133 *
Vkadaba 5:0728bde67bdb 134 * Optionally select a measurement unit for final conversion results.
Vkadaba 5:0728bde67bdb 135 * Currently applicable only to specific temperature sensor types.
Vkadaba 5:0728bde67bdb 136 */
Vkadaba 77:d90214f44903 137 typedef enum {
Vkadaba 5:0728bde67bdb 138 ADMW1001_MEASUREMENT_UNIT_UNSPECIFIED = 0,
Vkadaba 5:0728bde67bdb 139 /*!< No measurement unit specified */
Vkadaba 5:0728bde67bdb 140 ADMW1001_MEASUREMENT_UNIT_CELSIUS,
Vkadaba 5:0728bde67bdb 141 /*!< Celsius temperature unit - applicable to temperature sensors only */
Vkadaba 5:0728bde67bdb 142 ADMW1001_MEASUREMENT_UNIT_FAHRENHEIT,
Vkadaba 5:0728bde67bdb 143 /*!< Fahrenheit temperature unit - applicable to temperature sensors only */
Vkadaba 8:2f2775c34640 144
Vkadaba 8:2f2775c34640 145 } ADMW1001_MEASUREMENT_UNIT;
Vkadaba 5:0728bde67bdb 146
Vkadaba 77:d90214f44903 147 typedef enum {
Vkadaba 33:df7a00f1b8e1 148 ADMW1001_BUFFER_BYPASSS_DISABLED = 0,
Vkadaba 33:df7a00f1b8e1 149 /*!< Buffer Bypass Disabled */
Vkadaba 33:df7a00f1b8e1 150 ADMW1001_BUFFER_BYPASSS_ENABLED,
Vkadaba 33:df7a00f1b8e1 151 /*!< Buffer Bypass Enabled */
Vkadaba 34:b60ee1e0af2b 152
Vkadaba 33:df7a00f1b8e1 153 } ADMW1001_BUFFER_BYPASSS;
Vkadaba 33:df7a00f1b8e1 154
Vkadaba 5:0728bde67bdb 155 /*! ADMW1001 analog input signal amplification gain options
Vkadaba 5:0728bde67bdb 156 *
Vkadaba 5:0728bde67bdb 157 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 158 */
Vkadaba 77:d90214f44903 159 typedef enum {
Vkadaba 6:9d393a9677f4 160 ADMW1001_ADC_RTD_CURVE_EUROPEAN = 0,
Vkadaba 6:9d393a9677f4 161 /*!< EUROPEAN RTD curve used. */
Vkadaba 6:9d393a9677f4 162 ADMW1001_ADC_RTD_CURVE_AMERICAN,
Vkadaba 6:9d393a9677f4 163 /*!< AMERICAN RTD curve used. */
Vkadaba 6:9d393a9677f4 164 ADMW1001_ADC_RTD_CURVE_JAPANESE,
Vkadaba 6:9d393a9677f4 165 /*!< JAPANESE RTD curve used. */
Vkadaba 6:9d393a9677f4 166 ADMW1001_ADC_RTD_CURVE_ITS90,
Vkadaba 6:9d393a9677f4 167 /*!< ITS90 RTD curve used. */
Vkadaba 8:2f2775c34640 168
Vkadaba 8:2f2775c34640 169 } ADMW1001_ADC_RTD_CURVE;
Vkadaba 6:9d393a9677f4 170 /*! ADMW1001 analog input signal amplification gain options
Vkadaba 6:9d393a9677f4 171 *
Vkadaba 6:9d393a9677f4 172 * @note applicable only to ADC analog sensor channels
Vkadaba 6:9d393a9677f4 173 */
Vkadaba 77:d90214f44903 174 typedef enum {
Vkadaba 5:0728bde67bdb 175 ADMW1001_ADC_GAIN_1X = 0,
Vkadaba 5:0728bde67bdb 176 /*!< no amplification gain */
Vkadaba 5:0728bde67bdb 177 ADMW1001_ADC_GAIN_2X,
Vkadaba 5:0728bde67bdb 178 /*!< x2 amplification gain */
Vkadaba 5:0728bde67bdb 179 ADMW1001_ADC_GAIN_4X,
Vkadaba 5:0728bde67bdb 180 /*!< x4 amplification gain */
Vkadaba 5:0728bde67bdb 181 ADMW1001_ADC_GAIN_8X,
Vkadaba 5:0728bde67bdb 182 /*!< x8 amplification gain */
Vkadaba 5:0728bde67bdb 183 ADMW1001_ADC_GAIN_16X,
Vkadaba 5:0728bde67bdb 184 /*!< x16 amplification gain */
Vkadaba 5:0728bde67bdb 185 ADMW1001_ADC_GAIN_32X,
Vkadaba 5:0728bde67bdb 186 /*!< x32 amplification gain */
Vkadaba 5:0728bde67bdb 187 ADMW1001_ADC_GAIN_64X,
Vkadaba 5:0728bde67bdb 188 /*!< x64 amplification gain */
Vkadaba 8:2f2775c34640 189
Vkadaba 8:2f2775c34640 190 } ADMW1001_ADC_GAIN;
Vkadaba 5:0728bde67bdb 191
Vkadaba 6:9d393a9677f4 192 /*! ADMW1001 analog sensor excitation state options
Vkadaba 6:9d393a9677f4 193 *
Vkadaba 6:9d393a9677f4 194 * @note applicable only to ADC analog sensor channels, and
Vkadaba 6:9d393a9677f4 195 * specific sensor types
Vkadaba 6:9d393a9677f4 196 */
Vkadaba 77:d90214f44903 197 typedef enum {
Vkadaba 45:f5f553b8c0d5 198 ADMW1001_ADC_EXC_STATE_CYCLE_POWER = 0,
Vkadaba 33:df7a00f1b8e1 199 /*!< Excitation for measurement is active only during measurement */
Vkadaba 6:9d393a9677f4 200 ADMW1001_ADC_EXC_STATE_ALWAYS_ON,
Vkadaba 6:9d393a9677f4 201 /*!< Excitation for measurement is always on */
Vkadaba 45:f5f553b8c0d5 202
Vkadaba 8:2f2775c34640 203 } ADMW1001_ADC_EXC_STATE;
Vkadaba 6:9d393a9677f4 204
Vkadaba 5:0728bde67bdb 205 /*! ADMW1001 analog sensor excitation current output level options
Vkadaba 5:0728bde67bdb 206 *
Vkadaba 5:0728bde67bdb 207 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 208 * specific sensor types
Vkadaba 5:0728bde67bdb 209 */
Vkadaba 77:d90214f44903 210 typedef enum {
Vkadaba 18:cbf514cce921 211 ADMW1001_ADC_NO_EXTERNAL_EXC_CURRENT = -1,
Vkadaba 34:b60ee1e0af2b 212 /*!< NO External excitation is provided */
Vkadaba 6:9d393a9677f4 213 ADMW1001_ADC_EXC_CURRENT_EXTERNAL = 0,
Vkadaba 34:b60ee1e0af2b 214 /*!< External excitation is provided */
Vkadaba 5:0728bde67bdb 215 ADMW1001_ADC_EXC_CURRENT_50uA,
Vkadaba 5:0728bde67bdb 216 /*!< 50uA excitation current enabled */
Vkadaba 5:0728bde67bdb 217 ADMW1001_ADC_EXC_CURRENT_100uA,
Vkadaba 5:0728bde67bdb 218 /*!< 100uA excitation current */
Vkadaba 5:0728bde67bdb 219 ADMW1001_ADC_EXC_CURRENT_250uA,
Vkadaba 5:0728bde67bdb 220 /*!< 250uA excitation current enabled */
Vkadaba 5:0728bde67bdb 221 ADMW1001_ADC_EXC_CURRENT_500uA,
Vkadaba 5:0728bde67bdb 222 /*!< 500uA excitation current enabled */
Vkadaba 5:0728bde67bdb 223 ADMW1001_ADC_EXC_CURRENT_1000uA,
Vkadaba 5:0728bde67bdb 224 /*!< 1mA excitation current enabled */
Vkadaba 8:2f2775c34640 225
Vkadaba 8:2f2775c34640 226 } ADMW1001_ADC_EXC_CURRENT;
Vkadaba 5:0728bde67bdb 227
Vkadaba 5:0728bde67bdb 228 /*! ADMW1001 analog sensor excitation current ratios used for diode sensor
Vkadaba 5:0728bde67bdb 229 *
Vkadaba 5:0728bde67bdb 230 * @note applicable only to a diode sensor
Vkadaba 5:0728bde67bdb 231 */
Vkadaba 77:d90214f44903 232 typedef enum {
Vkadaba 34:b60ee1e0af2b 233 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_100UA = 0,
Vkadaba 6:9d393a9677f4 234 /**< 2 Current measurement 10uA 100uA */
Vkadaba 34:b60ee1e0af2b 235 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_160UA,
Vkadaba 6:9d393a9677f4 236 /**< 2 Current measurement 20uA 160uA */
Vkadaba 34:b60ee1e0af2b 237 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_300UA,
Vkadaba 6:9d393a9677f4 238 /**< 2 Current measurement 50uA 300uA */
Vkadaba 34:b60ee1e0af2b 239 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_600UA,
Vkadaba 6:9d393a9677f4 240 /**< 2 Current measurement 100uA 600uA */
Vkadaba 34:b60ee1e0af2b 241 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_50UA_100UA,
Vkadaba 6:9d393a9677f4 242 /**< 3 current measuremetn 10uA 50uA 100uA */
Vkadaba 34:b60ee1e0af2b 243 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_100UA_160UA,
Vkadaba 6:9d393a9677f4 244 /**< 3 current measuremetn 20uA 100uA 160uA */
Vkadaba 34:b60ee1e0af2b 245 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_150UA_300UA,
Vkadaba 6:9d393a9677f4 246 /**< 3 current measuremetn 50uA 150uA 300uA */
Vkadaba 6:9d393a9677f4 247 ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_300UA_600UA,
Vkadaba 6:9d393a9677f4 248 /**< 3 current measuremetn 100uA 300uA 600uA */
Vkadaba 8:2f2775c34640 249
Vkadaba 8:2f2775c34640 250 } ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO;
Vkadaba 5:0728bde67bdb 251
Vkadaba 5:0728bde67bdb 252 /*! ADMW1001 analog reference selection options
Vkadaba 5:0728bde67bdb 253 *
Vkadaba 5:0728bde67bdb 254 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 255 * specific sensor types
Vkadaba 5:0728bde67bdb 256 */
Vkadaba 77:d90214f44903 257 typedef enum {
Vkadaba 8:2f2775c34640 258 ADMW1001_ADC_REFERENCE_VOLTAGE_INTERNAL = 0,
Vkadaba 8:2f2775c34640 259 /*!< Internal VRef - 1.2V */
Vkadaba 61:0f16a2e3b58b 260 ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_1 = 1,
Vkadaba 8:2f2775c34640 261 /*!< External reference voltage #1 */
Vkadaba 61:0f16a2e3b58b 262 ADMW1001_ADC_REFERENCE_VOLTAGE_AVDD = 3,
Vkadaba 61:0f16a2e3b58b 263 /*!< Analog Supply Voltage AVDD reference (typically 3.3V) is selected */
Vkadaba 5:0728bde67bdb 264
Vkadaba 8:2f2775c34640 265 } ADMW1001_ADC_REFERENCE_TYPE;
Vkadaba 5:0728bde67bdb 266
Vkadaba 6:9d393a9677f4 267 /*! ADMW1001 ADC Reference configuration
Vkadaba 6:9d393a9677f4 268 *
Vkadaba 6:9d393a9677f4 269 * @note applicable only to ADC analog sensor channels
Vkadaba 6:9d393a9677f4 270 */
Vkadaba 77:d90214f44903 271 typedef enum {
Vkadaba 6:9d393a9677f4 272 ADMW1001_ADC_GND_SW_OPEN = 0,
Vkadaba 6:9d393a9677f4 273 /*!< Ground switch not enabled for measurement. */
Vkadaba 6:9d393a9677f4 274 ADMW1001_ADC_GND_SW_CLOSED,
Vkadaba 8:2f2775c34640 275 /*!< Ground switch enabled for measurement. */
Vkadaba 8:2f2775c34640 276
Vkadaba 8:2f2775c34640 277 } ADMW1001_ADC_GND_SW;
Vkadaba 8:2f2775c34640 278
Vkadaba 8:2f2775c34640 279 /*! ADMW1001 analog filter chop mode
Vkadaba 8:2f2775c34640 280 *
Vkadaba 8:2f2775c34640 281 * @note applicable only to ADC analog sensor channels
Vkadaba 8:2f2775c34640 282 */
Vkadaba 77:d90214f44903 283 typedef enum {
Vkadaba 75:434d91af4cc7 284 ADMW1001_DISABLE_CHOP = 0,
Vkadaba 63:2655a04c00f5 285 /*!< chop performed. */
Vkadaba 75:434d91af4cc7 286 ADMW1001_ENABLE_CHOP,
Vkadaba 34:b60ee1e0af2b 287
Vkadaba 8:2f2775c34640 288 } ADMW1001_CHOP_MD;
Vkadaba 6:9d393a9677f4 289
Vkadaba 5:0728bde67bdb 290 /*! ADMW1001 analog filter selection options
Vkadaba 5:0728bde67bdb 291 *
Vkadaba 5:0728bde67bdb 292 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 293 */
Vkadaba 77:d90214f44903 294 typedef enum {
Vkadaba 6:9d393a9677f4 295 ADMW1001_ADC_FILTER_SINC4 = 0,
Vkadaba 8:2f2775c34640 296 /*!< SINC4 - 4th order sinc response filter */
Vkadaba 6:9d393a9677f4 297 ADMW1001_ADC_FILTER_SINC3,
Vkadaba 8:2f2775c34640 298 /*!< SINC3 - 3rd order sinc response filter */
Vkadaba 8:2f2775c34640 299
Vkadaba 8:2f2775c34640 300 } ADMW1001_ADC_FILTER_TYPE;
Vkadaba 8:2f2775c34640 301
Vkadaba 8:2f2775c34640 302 /*! ADMW1001 Sinc Filter range (SF)
Vkadaba 8:2f2775c34640 303 *
Vkadaba 8:2f2775c34640 304 * @note applicable only to ADC analog sensor channels
Vkadaba 34:b60ee1e0af2b 305 * @note SF must be set in conjunction with chop mode
Vkadaba 8:2f2775c34640 306 * and sinc filter type to achieve the desired sampling rate.
Vkadaba 8:2f2775c34640 307 */
Vkadaba 77:d90214f44903 308 typedef enum {
Vkadaba 77:d90214f44903 309 ADMW1001_SF_7 = 7,
Vkadaba 77:d90214f44903 310 /*!< SF setting for fastest sampling rate, enable SINC4 filter. */
Vkadaba 77:d90214f44903 311 ADMW1001_SF_31 = 31,
Vkadaba 77:d90214f44903 312 /*!< SF setting for medium speed mode, enable SINC3 Filter. */
Vkadaba 77:d90214f44903 313 ADMW1001_SF_51 = 51,
Vkadaba 77:d90214f44903 314 /*!< SF setting for medium speed mode, enable SINC3 Filter. */
Vkadaba 77:d90214f44903 315 ADMW1001_SF_124 = 124,
Vkadaba 77:d90214f44903 316 /*!< SF setting for 60Hz rejection. */
Vkadaba 77:d90214f44903 317 ADMW1001_SF_125 = 125,
Vkadaba 77:d90214f44903 318 /*!< SF setting for 50Hz and 60Hz rejection when notch1p2 is enabled. Enable SINC3 Filter. */
Vkadaba 77:d90214f44903 319 ADMW1001_SF_127 = 127,
Vkadaba 77:d90214f44903 320 /*!< SF setting for Lowest noise, enable SINC3 Filter. */
Vkadaba 8:2f2775c34640 321
Vkadaba 8:2f2775c34640 322 } ADMW1001_SINC_FILTER_RANGE;
Vkadaba 5:0728bde67bdb 323
Vkadaba 77:d90214f44903 324
Vkadaba 5:0728bde67bdb 325 /*! ADMW1001 I2C clock speed options
Vkadaba 5:0728bde67bdb 326 *
Vkadaba 5:0728bde67bdb 327 * @note applicable only for I2C sensors
Vkadaba 5:0728bde67bdb 328 */
Vkadaba 77:d90214f44903 329 typedef enum {
Vkadaba 8:2f2775c34640 330 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_100K = 0,
Vkadaba 5:0728bde67bdb 331 /*!< 100kHz I2C clock speed */
Vkadaba 8:2f2775c34640 332 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_400K,
Vkadaba 5:0728bde67bdb 333 /*!< 400kHz I2C clock speed */
Vkadaba 8:2f2775c34640 334
Vkadaba 8:2f2775c34640 335 } ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED;
Vkadaba 5:0728bde67bdb 336
Vkadaba 5:0728bde67bdb 337
Vkadaba 5:0728bde67bdb 338 /*! ADMW1001 Power Configuration options */
Vkadaba 77:d90214f44903 339 typedef struct {
Vkadaba 5:0728bde67bdb 340 ADMW1001_POWER_MODE powerMode;
Vkadaba 5:0728bde67bdb 341 /*!< Power mode selection */
Vkadaba 8:2f2775c34640 342
Vkadaba 8:2f2775c34640 343 } ADMW1001_POWER_CONFIG;
Vkadaba 5:0728bde67bdb 344
Vkadaba 5:0728bde67bdb 345 /*! ADMW1001 Multi-Cycle Configuration options
Vkadaba 5:0728bde67bdb 346 *
Vkadaba 5:0728bde67bdb 347 * @note required only when ADMW1001_OPERATING_MODE_MULTICYCLE is selected
Vkadaba 5:0728bde67bdb 348 * as the operatingMode (@ref ADMW1001_MEASUREMENT_CONFIG)
Vkadaba 5:0728bde67bdb 349 */
Vkadaba 77:d90214f44903 350 typedef struct {
Vkadaba 8:2f2775c34640 351 uint32_t cyclesPerBurst;
Vkadaba 5:0728bde67bdb 352 /*!< Number of cycles to complete for a single burst */
Vkadaba 8:2f2775c34640 353 uint32_t burstInterval;
Vkadaba 5:0728bde67bdb 354 /*!< Interval, in seconds, between each successive burst of cycles */
Vkadaba 8:2f2775c34640 355
Vkadaba 8:2f2775c34640 356 } ADMW1001_MULTICYCLE_CONFIG;
Vkadaba 5:0728bde67bdb 357
Vkadaba 5:0728bde67bdb 358 /*! ADMW1001 Measurement Configuration options */
Vkadaba 77:d90214f44903 359 typedef struct {
Vkadaba 5:0728bde67bdb 360 ADMW1001_OPERATING_MODE operatingMode;
Vkadaba 5:0728bde67bdb 361 /*!< Operating mode - specifies how measurement cycles are scheduled */
Vkadaba 5:0728bde67bdb 362 ADMW1001_DATAREADY_MODE dataReadyMode;
Vkadaba 5:0728bde67bdb 363 /*!< Data read mode - specifies how output samples are stored for reading */
Vkadaba 45:f5f553b8c0d5 364 uint8_t excitationState;
Vkadaba 43:e1789b7214cf 365 /*!< Excitation current state */
Vkadaba 45:f5f553b8c0d5 366 uint8_t groundSwitch;
Vkadaba 45:f5f553b8c0d5 367 /*!< Option to open or close sensor ground switch */
Vkadaba 50:d84305e5e1c0 368 uint8_t fifoNumCycles;
Vkadaba 50:d84305e5e1c0 369 /*!< Specifies the number of cycles to fill a FIFO buffer
Vkadaba 50:d84305e5e1c0 370 * Applicable only when operatingMode is ADMW1001_OPERATING_MODE_CONTINUOUS
Vkadaba 34:b60ee1e0af2b 371 */
Vkadaba 8:2f2775c34640 372 uint32_t cycleInterval;
Vkadaba 8:2f2775c34640 373 /*!< Cycle interval - specifies the time interval between the start of each
Vkadaba 8:2f2775c34640 374 * successive measurement cycle. Applicable only when operatingMode is
Vkadaba 8:2f2775c34640 375 * not ADMW1001_OPERATING_MODE_SINGLECYCLE
Vkadaba 8:2f2775c34640 376 */
Vkadaba 8:2f2775c34640 377 bool vBiasEnable;
Vkadaba 8:2f2775c34640 378 /*!< Enable voltage Bias output of ADC
Vkadaba 8:2f2775c34640 379 */
Vkadaba 8:2f2775c34640 380 float32_t externalRef1Value;
Vkadaba 8:2f2775c34640 381 /*!< Voltage value connected to external reference input #1.
Vkadaba 5:0728bde67bdb 382 * Applicable only if the selected reference type is
Vkadaba 8:2f2775c34640 383 * voltage.
Vkadaba 5:0728bde67bdb 384 * (see @ref ADMW1001_ADC_REFERENCE_TYPE)
Vkadaba 34:b60ee1e0af2b 385 */
Vkadaba 33:df7a00f1b8e1 386 float32_t RSenseValue;
Vkadaba 34:b60ee1e0af2b 387 /*!< Sense resistor value in Ohms. */
Vkadaba 34:b60ee1e0af2b 388 float32_t externalRefVoltage;
Vkadaba 34:b60ee1e0af2b 389 /*!< External Reference Voltage.
Vkadaba 34:b60ee1e0af2b 390 */
Vkadaba 45:f5f553b8c0d5 391 float32_t AVDDVoltage;
Vkadaba 45:f5f553b8c0d5 392 /*!< AVDD Voltage.
Vkadaba 45:f5f553b8c0d5 393 */
Vkadaba 77:d90214f44903 394 uint8_t extVrefBuffMode;
Vkadaba 77:d90214f44903 395 /*!< External Vref Buff mode.
Vkadaba 72:35ea0b4e725b 396 uint32_t reserved1[3];
Vkadaba 45:f5f553b8c0d5 397 /*!< Reserved for future use and ensure word alignment.
Vkadaba 77:d90214f44903 398 */
Vkadaba 8:2f2775c34640 399
Vkadaba 8:2f2775c34640 400 } ADMW1001_MEASUREMENT_CONFIG;
Vkadaba 5:0728bde67bdb 401
Vkadaba 5:0728bde67bdb 402 /*! ADMW1001 ADC Excitation Current output configuration
Vkadaba 5:0728bde67bdb 403 *
Vkadaba 5:0728bde67bdb 404 * @note applicable only to ADC analog sensor channels, and
Vkadaba 5:0728bde67bdb 405 * specific sensor types
Vkadaba 5:0728bde67bdb 406 */
Vkadaba 77:d90214f44903 407 typedef struct {
Vkadaba 5:0728bde67bdb 408 ADMW1001_ADC_EXC_CURRENT outputLevel;
Vkadaba 5:0728bde67bdb 409 /*!< Excitation current output level */
Vkadaba 5:0728bde67bdb 410 ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO diodeRatio;
Vkadaba 5:0728bde67bdb 411 /*!< Excitation current output diode ratio */
Vkadaba 45:f5f553b8c0d5 412 float32_t idealityRatio;
Vkadaba 8:2f2775c34640 413
Vkadaba 8:2f2775c34640 414 } ADMW1001_ADC_EXC_CURRENT_CONFIG;
Vkadaba 5:0728bde67bdb 415
Vkadaba 5:0728bde67bdb 416 /*! ADMW1001 ADC Filter configuration
Vkadaba 5:0728bde67bdb 417 *
Vkadaba 5:0728bde67bdb 418 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 419 */
Vkadaba 77:d90214f44903 420 typedef struct {
Vkadaba 8:2f2775c34640 421 ADMW1001_ADC_FILTER_TYPE type;
Vkadaba 5:0728bde67bdb 422 /*!< Filter type selection */
Vkadaba 8:2f2775c34640 423 ADMW1001_SINC_FILTER_RANGE sf;
Vkadaba 8:2f2775c34640 424 /*!< SF value used along with filter type and chop mode to determine speed */
Vkadaba 17:2f0028880874 425 ADMW1001_CHOP_MD chopMode;
Vkadaba 6:9d393a9677f4 426 /*!< Enable filter chop */
Vkadaba 8:2f2775c34640 427 bool notch1p2;
Vkadaba 6:9d393a9677f4 428 /*!< Enable Notch 2 Filter Mode */
Vkadaba 45:f5f553b8c0d5 429
Vkadaba 8:2f2775c34640 430 } ADMW1001_ADC_FILTER_CONFIG;
Vkadaba 5:0728bde67bdb 431
Vkadaba 5:0728bde67bdb 432 /*! ADMW1001 ADC analog channel configuration details
Vkadaba 5:0728bde67bdb 433 *
Vkadaba 5:0728bde67bdb 434 * @note applicable only to ADC analog sensor channels
Vkadaba 5:0728bde67bdb 435 */
Vkadaba 77:d90214f44903 436 typedef struct {
Vkadaba 5:0728bde67bdb 437 ADMW1001_ADC_SENSOR_TYPE sensor;
Vkadaba 5:0728bde67bdb 438 /*!< Sensor type selection */
Vkadaba 6:9d393a9677f4 439 ADMW1001_ADC_RTD_CURVE rtdCurve;
Vkadaba 6:9d393a9677f4 440 /*!< Rtd curve selection */
Vkadaba 5:0728bde67bdb 441 ADMW1001_ADC_GAIN gain;
Vkadaba 5:0728bde67bdb 442 /*!< ADC Gain selection */
Vkadaba 5:0728bde67bdb 443 ADMW1001_ADC_EXC_CURRENT_CONFIG current;
Vkadaba 5:0728bde67bdb 444 /*!< ADC Excitation Current configuration */
Vkadaba 5:0728bde67bdb 445 ADMW1001_ADC_FILTER_CONFIG filter;
Vkadaba 5:0728bde67bdb 446 /*!< ADC Filter configuration */
Vkadaba 8:2f2775c34640 447 ADMW1001_ADC_REFERENCE_TYPE reference;
Vkadaba 5:0728bde67bdb 448 /*!< ADC Reference configuration */
Vkadaba 33:df7a00f1b8e1 449 uint8_t bufferBypass;
Vkadaba 77:d90214f44903 450 /*!< Buffer Bypass configuration */
Vkadaba 33:df7a00f1b8e1 451 uint8_t reserved0[2];
Vkadaba 8:2f2775c34640 452 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 453 uint32_t reserved1[6];
Vkadaba 8:2f2775c34640 454 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 455
Vkadaba 8:2f2775c34640 456 } ADMW1001_ADC_CHANNEL_CONFIG;
Vkadaba 8:2f2775c34640 457
Vkadaba 8:2f2775c34640 458 /*! ADMW1001 look-up table selection
Vkadaba 8:2f2775c34640 459 * Select table used to linearise the measurement.
Vkadaba 8:2f2775c34640 460 */
Vkadaba 77:d90214f44903 461 typedef enum {
Vkadaba 8:2f2775c34640 462 ADMW1001_LUT_DEFAULT = 0,
Vkadaba 8:2f2775c34640 463 /*!< Default LUT */
Vkadaba 45:f5f553b8c0d5 464 ADMW1001_LUT_CUSTOM = 1,
Vkadaba 8:2f2775c34640 465 /*!< User defined custom LUT */
Vkadaba 45:f5f553b8c0d5 466 ADMW1001_LUT_RESERVED = 2,
Vkadaba 8:2f2775c34640 467 /*!< Reserved for future use */
Vkadaba 34:b60ee1e0af2b 468
Vkadaba 8:2f2775c34640 469 } ADMW1001_LUT_SELECT;
Vkadaba 5:0728bde67bdb 470
Vkadaba 5:0728bde67bdb 471 /*! ADMW1001 digital sensor data encoding
Vkadaba 5:0728bde67bdb 472 *
Vkadaba 5:0728bde67bdb 473 * @note applicable only to SPI and I2C digital sensor channels
Vkadaba 5:0728bde67bdb 474 */
Vkadaba 77:d90214f44903 475 typedef enum {
Vkadaba 8:2f2775c34640 476 ADMW1001_DIGITAL_SENSOR_DATA_CODING_NONE = 0,
Vkadaba 5:0728bde67bdb 477 /**< None/Invalid - data format is ignored if coding is set to this value */
Vkadaba 5:0728bde67bdb 478 ADMW1001_DIGITAL_SENSOR_DATA_CODING_UNIPOLAR,
Vkadaba 5:0728bde67bdb 479 /**< Unipolar - unsigned integer values */
Vkadaba 5:0728bde67bdb 480 ADMW1001_DIGITAL_SENSOR_DATA_CODING_TWOS_COMPLEMENT,
Vkadaba 5:0728bde67bdb 481 /**< Twos-complement - signed integer values */
Vkadaba 5:0728bde67bdb 482 ADMW1001_DIGITAL_SENSOR_DATA_CODING_OFFSET_BINARY,
Vkadaba 5:0728bde67bdb 483 /**< Offset Binary - used to represent signed values with unsigned integers,
Vkadaba 5:0728bde67bdb 484 * with the mid-range value representing 0 */
Vkadaba 8:2f2775c34640 485
Vkadaba 8:2f2775c34640 486 } ADMW1001_DIGITAL_SENSOR_DATA_CODING;
Vkadaba 5:0728bde67bdb 487
Vkadaba 5:0728bde67bdb 488 /*! ADMW1001 digital sensor data format configuration
Vkadaba 5:0728bde67bdb 489 *
Vkadaba 5:0728bde67bdb 490 * @note applicable only to SPI and I2C digital sensor channels
Vkadaba 5:0728bde67bdb 491 */
Vkadaba 77:d90214f44903 492 typedef struct {
Vkadaba 5:0728bde67bdb 493 ADMW1001_DIGITAL_SENSOR_DATA_CODING coding;
Vkadaba 5:0728bde67bdb 494 /**< Data Encoding of Sensor Result */
Vkadaba 5:0728bde67bdb 495 bool littleEndian;
Vkadaba 5:0728bde67bdb 496 /**< Set as true if data format is little-endian, false otherwise */
Vkadaba 5:0728bde67bdb 497 bool leftJustified;
Vkadaba 5:0728bde67bdb 498 /**< Set as true if data is left-justified in the data frame, false otherwise */
Vkadaba 5:0728bde67bdb 499 uint8_t frameLength;
Vkadaba 5:0728bde67bdb 500 /**< Data frame length (number of bytes to read from the sensor) */
Vkadaba 5:0728bde67bdb 501 uint8_t numDataBits;
Vkadaba 5:0728bde67bdb 502 /**< Number of relevant data bits to extract from the data frame */
Vkadaba 5:0728bde67bdb 503 uint8_t bitOffset;
Vkadaba 5:0728bde67bdb 504 /**< Data bit offset, relative to data alignment within the data frame */
Vkadaba 8:2f2775c34640 505 uint8_t reserved[2];
Vkadaba 8:2f2775c34640 506 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 507
Vkadaba 8:2f2775c34640 508 } ADMW1001_DIGITAL_SENSOR_DATA_FORMAT;
Vkadaba 5:0728bde67bdb 509
Vkadaba 5:0728bde67bdb 510
Vkadaba 5:0728bde67bdb 511 /*! ADMW1001 digital sensor communication config
Vkadaba 5:0728bde67bdb 512 *
Vkadaba 5:0728bde67bdb 513 * @note applicable only to digital sensor channels
Vkadaba 5:0728bde67bdb 514 */
Vkadaba 77:d90214f44903 515 typedef struct {
Vkadaba 8:2f2775c34640 516 bool useCustomCommsConfig;
Vkadaba 5:0728bde67bdb 517 /*!< Optional parameter to enable user digital communication settings */
Vkadaba 8:2f2775c34640 518 ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED i2cClockSpeed;
Vkadaba 5:0728bde67bdb 519 /*!< Optional parameter to configure specific i2c speed for i2c sensor */
Vkadaba 8:2f2775c34640 520
Vkadaba 8:2f2775c34640 521 } ADMW1001_DIGITAL_SENSOR_COMMS;
Vkadaba 5:0728bde67bdb 522
Vkadaba 5:0728bde67bdb 523 /*! ADMW1001 I2C digital channel configuration details
Vkadaba 5:0728bde67bdb 524 *
Vkadaba 5:0728bde67bdb 525 * @note applicable only to I2C digital sensor channels
Vkadaba 5:0728bde67bdb 526 */
Vkadaba 77:d90214f44903 527 typedef struct {
Vkadaba 8:2f2775c34640 528 ADMW1001_I2C_SENSOR_TYPE sensor;
Vkadaba 5:0728bde67bdb 529 /*!< Sensor type selection */
Vkadaba 8:2f2775c34640 530 uint8_t deviceAddress;
Vkadaba 5:0728bde67bdb 531 /*!< I2C device address (7-bit) */
Vkadaba 8:2f2775c34640 532 uint8_t reserved;
Vkadaba 8:2f2775c34640 533 /*!< Reserved for future use and ensure word alignment. */
Vkadaba 8:2f2775c34640 534 ADMW1001_DIGITAL_SENSOR_DATA_FORMAT dataFormat;
Vkadaba 5:0728bde67bdb 535 /*!< Optional data format configuration to parse/extract data from the device.
Vkadaba 5:0728bde67bdb 536 * A default data format will be used if this is not specified.
Vkadaba 5:0728bde67bdb 537 * Applicable only to specific I2C sensor types
Vkadaba 5:0728bde67bdb 538 */
Vkadaba 8:2f2775c34640 539 ADMW1001_DIGITAL_SENSOR_COMMS configureComms;
Vkadaba 5:0728bde67bdb 540 /*!< Optional configuration to setup a user communication config.
Vkadaba 5:0728bde67bdb 541 * A default configuration will be used if this is not specified.
Vkadaba 5:0728bde67bdb 542 * Applicable only to specific I2C sensor types.
Vkadaba 5:0728bde67bdb 543 */
Vkadaba 8:2f2775c34640 544
Vkadaba 8:2f2775c34640 545 } ADMW1001_I2C_CHANNEL_CONFIG;
Vkadaba 5:0728bde67bdb 546
Vkadaba 5:0728bde67bdb 547
Vkadaba 5:0728bde67bdb 548 /*! ADMW1001 Measurement Channel configuration details */
Vkadaba 77:d90214f44903 549 typedef struct {
Vkadaba 8:2f2775c34640 550 bool enableChannel;
Vkadaba 5:0728bde67bdb 551 /*!< Option to include this channel in normal measurement cycles */
Vkadaba 8:2f2775c34640 552 bool disablePublishing;
Vkadaba 5:0728bde67bdb 553 /*!< Option to disable publishing of data samples from this channel. The
Vkadaba 5:0728bde67bdb 554 * channel may still be included in measurement cycles, but data samples
Vkadaba 5:0728bde67bdb 555 * obtained from this channel will not be published. This is typically
Vkadaba 5:0728bde67bdb 556 * used for channels which are required only as a compensation reference
Vkadaba 5:0728bde67bdb 557 * for another channel (e.g. Cold-Junction Compensation channels).
Vkadaba 5:0728bde67bdb 558 */
Vkadaba 8:2f2775c34640 559 ADMW1001_CH_ID compensationChannel;
Vkadaba 8:2f2775c34640 560 /*!< Optional compensation channel. Set to ADMW1001_CH_ID_NONE if not
Vkadaba 5:0728bde67bdb 561 * required. Typically used for thermocouple sensors that require a
Vkadaba 5:0728bde67bdb 562 * separate measurement of the "cold-junction" temperature, which can be
Vkadaba 5:0728bde67bdb 563 * be provided by an RTD temperature sensor connected on a separate
Vkadaba 5:0728bde67bdb 564 * "compensation channel" */
Vkadaba 8:2f2775c34640 565 ADMW1001_LUT_SELECT lutSelect;
Vkadaba 8:2f2775c34640 566 /*!<Select Look Up Table LUT for calculations, this implies that the
Vkadaba 5:0728bde67bdb 567 * fundamental measurement for the sensor (typically mV or Ohms)
Vkadaba 8:2f2775c34640 568 * 0 = default, 1= unity, 2 = custom
Vkadaba 5:0728bde67bdb 569 */
Vkadaba 8:2f2775c34640 570 ADMW1001_MEASUREMENT_UNIT measurementUnit;
Vkadaba 5:0728bde67bdb 571 /*!< Optional measurement unit selection for conversion results. Applicable
Vkadaba 5:0728bde67bdb 572 * only for certain sensor types. Set to
Vkadaba 5:0728bde67bdb 573 * ADMW1001_MEASUREMENT_UNIT_DEFAULT if not applicable.
Vkadaba 5:0728bde67bdb 574 */
Vkadaba 8:2f2775c34640 575 float32_t lowThreshold;
Vkadaba 5:0728bde67bdb 576 /*!< Optional minimum threshold value for each processed sample, to be
Vkadaba 5:0728bde67bdb 577 * checked prior to publishing. A channel ALERT condition is raised
Vkadaba 5:0728bde67bdb 578 * if the processed value is lower than this threshold. Set to NaN
Vkadaba 5:0728bde67bdb 579 * if not required.
Vkadaba 5:0728bde67bdb 580 */
Vkadaba 8:2f2775c34640 581 float32_t highThreshold;
Vkadaba 5:0728bde67bdb 582 /*!< Optional maximum threshold value for each processed sample, to be
Vkadaba 5:0728bde67bdb 583 * checked prior to publishing. A channel ALERT condition is raised
Vkadaba 5:0728bde67bdb 584 * if the processed value is higher than this threshold. Set to NaN
Vkadaba 5:0728bde67bdb 585 * if not required.
Vkadaba 5:0728bde67bdb 586 */
Vkadaba 8:2f2775c34640 587 float32_t offsetAdjustment;
Vkadaba 5:0728bde67bdb 588 /*!< Optional offset adjustment value applied to each processed sample.
Vkadaba 5:0728bde67bdb 589 * Set to NaN or 0.0 if not required.
Vkadaba 5:0728bde67bdb 590 */
Vkadaba 8:2f2775c34640 591 float32_t gainAdjustment;
Vkadaba 5:0728bde67bdb 592 /*!< Optional gain adjustment value applied to each processed sample.
Vkadaba 5:0728bde67bdb 593 * Set to NaN or 1.0 if not required.
Vkadaba 5:0728bde67bdb 594 */
Vkadaba 8:2f2775c34640 595 float32_t sensorParameter;
Vkadaba 5:0728bde67bdb 596 /*!< Optional sensor parameter adjustment.
Vkadaba 5:0728bde67bdb 597 * Set to NaN or 0 if not required.
Vkadaba 5:0728bde67bdb 598 */
Vkadaba 8:2f2775c34640 599 uint32_t measurementsPerCycle;
Vkadaba 5:0728bde67bdb 600 /*!< The number of measurements to obtain from this channel within each
Vkadaba 5:0728bde67bdb 601 * cycle. Each enabled channel is measured in turn, until the number of
Vkadaba 5:0728bde67bdb 602 * measurements requested for the channel has been reached. A different
Vkadaba 5:0728bde67bdb 603 * number of measurements-per-cycle may be specified for each channel.
Vkadaba 5:0728bde67bdb 604 */
Vkadaba 8:2f2775c34640 605 uint32_t cycleSkipCount;
Vkadaba 5:0728bde67bdb 606 /*!< Optional number of cycles to skip, such that this channel is included
Vkadaba 5:0728bde67bdb 607 * in the sequence in only one of every (cycleSkipCount + 1) cycles that
Vkadaba 5:0728bde67bdb 608 * occur. If set to 0 (default), this channel is included in every cycle;
Vkadaba 5:0728bde67bdb 609 * if set to 1, this channel is included in every 2nd cycle; if set to 2,
Vkadaba 5:0728bde67bdb 610 * this channel is included in every 3rd cycle, and so on.
Vkadaba 5:0728bde67bdb 611 */
Vkadaba 8:2f2775c34640 612 uint32_t extraSettlingTime;
Vkadaba 5:0728bde67bdb 613 /*!< A minimum settling time is applied internally for each channel, based
Vkadaba 45:f5f553b8c0d5 614 * on the sensor type. However, additional settling time (milliseconds)
Vkadaba 5:0728bde67bdb 615 * can optionally be specified. Set to 0 if not required.
Vkadaba 5:0728bde67bdb 616 */
Vkadaba 8:2f2775c34640 617 ADMW1001_CHANNEL_PRIORITY priority;
Vkadaba 5:0728bde67bdb 618 /*!< By default, channels are arranged in the measurement sequence based on
Vkadaba 5:0728bde67bdb 619 * ascending order of channel ID. However, a priority-level may be
Vkadaba 5:0728bde67bdb 620 * specified per channel to force a different ordering of the channels,
Vkadaba 5:0728bde67bdb 621 * with higher-priority channels appearing before lower-priority channels.
Vkadaba 5:0728bde67bdb 622 * Channels with equal priority are ordered by ascending order of channel
Vkadaba 5:0728bde67bdb 623 * ID. Lower numbers indicate higher priority, with 0 being the highest.
Vkadaba 5:0728bde67bdb 624 * Set to 0 if not required.
Vkadaba 5:0728bde67bdb 625 */
Vkadaba 77:d90214f44903 626 union {
Vkadaba 8:2f2775c34640 627 ADMW1001_ADC_CHANNEL_CONFIG adcChannelConfig;
Vkadaba 5:0728bde67bdb 628 /*!< ADC channel configuration - applicable only to ADC channels */
Vkadaba 8:2f2775c34640 629 ADMW1001_I2C_CHANNEL_CONFIG i2cChannelConfig;
Vkadaba 5:0728bde67bdb 630 /*!< I2C channel configuration - applicable only to I2C channels */
Vkadaba 5:0728bde67bdb 631 };
Vkadaba 6:9d393a9677f4 632 /*!< Only one of adcChannelConfig, i2cChannelConfig, spiChannelConfig
Vkadaba 6:9d393a9677f4 633 * is required, depending on the channel designation
Vkadaba 6:9d393a9677f4 634 * (analog, I2C, SPI)
Vkadaba 5:0728bde67bdb 635 */
Vkadaba 8:2f2775c34640 636
Vkadaba 8:2f2775c34640 637 } ADMW1001_CHANNEL_CONFIG;
Vkadaba 5:0728bde67bdb 638
Vkadaba 5:0728bde67bdb 639 /*! ADMW1001 Diagnostics configuration details */
Vkadaba 77:d90214f44903 640 typedef struct {
Vkadaba 8:2f2775c34640 641 bool disableGlobalDiag;
Vkadaba 5:0728bde67bdb 642 /*!< Option to disable the following diagnostic checks on the ADC:
Vkadaba 5:0728bde67bdb 643 * - Reference Detection errors
Vkadaba 5:0728bde67bdb 644 * - Input under-/over-voltage errors
Vkadaba 5:0728bde67bdb 645 * - Calibration, Conversion and Saturation errors
Vkadaba 5:0728bde67bdb 646 */
Vkadaba 8:2f2775c34640 647 bool disableMeasurementDiag;
Vkadaba 5:0728bde67bdb 648 /*!< Option to disable additional checks per measurement channel:
Vkadaba 5:0728bde67bdb 649 * - High/low threshold limit violation
Vkadaba 5:0728bde67bdb 650 */
Vkadaba 8:2f2775c34640 651
Vkadaba 8:2f2775c34640 652 bool disableCriticalTempAbort;
Vkadaba 5:0728bde67bdb 653 /*!< Option to disable abort of measurement cycle if the operating
Vkadaba 5:0728bde67bdb 654 * temperature of the ADMW1001 has exceeded critical limits
Vkadaba 5:0728bde67bdb 655 */
Vkadaba 8:2f2775c34640 656
Vkadaba 45:f5f553b8c0d5 657 uint8_t osdFrequency;
Vkadaba 5:0728bde67bdb 658 /*!< Option to enable Open-Circuit Detection at a selected cycle interval */
Vkadaba 5:0728bde67bdb 659
Vkadaba 8:2f2775c34640 660 } ADMW1001_DIAGNOSTICS_CONFIG;
Vkadaba 8:2f2775c34640 661
Vkadaba 5:0728bde67bdb 662
Vkadaba 5:0728bde67bdb 663 /*! ADMW1001 Device configuration details */
Vkadaba 77:d90214f44903 664 typedef struct {
Vkadaba 5:0728bde67bdb 665 ADMW1001_POWER_CONFIG power;
Vkadaba 5:0728bde67bdb 666 /*!< Power configuration details */
Vkadaba 5:0728bde67bdb 667 ADMW1001_MEASUREMENT_CONFIG measurement;
Vkadaba 5:0728bde67bdb 668 /*!< Measurement configuration details */
Vkadaba 5:0728bde67bdb 669 ADMW1001_DIAGNOSTICS_CONFIG diagnostics;
Vkadaba 5:0728bde67bdb 670 /*!< FFT configuration details */
Vkadaba 5:0728bde67bdb 671 ADMW1001_CHANNEL_CONFIG channels[ADMW1001_MAX_CHANNELS];
Vkadaba 5:0728bde67bdb 672 /*!< Channel-specific configuration details */
Vkadaba 8:2f2775c34640 673
Vkadaba 8:2f2775c34640 674 } ADMW1001_CONFIG;
Vkadaba 5:0728bde67bdb 675
Vkadaba 5:0728bde67bdb 676 #ifdef __cplusplus
Vkadaba 5:0728bde67bdb 677 }
Vkadaba 5:0728bde67bdb 678 #endif
Vkadaba 5:0728bde67bdb 679
Vkadaba 5:0728bde67bdb 680 /*!
Vkadaba 5:0728bde67bdb 681 * @}
Vkadaba 5:0728bde67bdb 682 */
Vkadaba 5:0728bde67bdb 683
Vkadaba 5:0728bde67bdb 684 #endif /* __ADMW1001_CONFIG_H__ */