![](/media/cache/img/default_profile.jpg.50x50_q85.jpg)
Minor changes to support ADMW FWv1.17.75
inc/admw1001/admw1001_config.h@17:2f0028880874, 2019-08-07 (annotated)
- Committer:
- Vkadaba
- Date:
- Wed Aug 07 06:46:25 2019 +0000
- Revision:
- 17:2f0028880874
- Parent:
- 11:8e6023d2e584
- Child:
- 18:cbf514cce921
filter parameter - filterChop replaced with chopMode
Who changed what in which revision?
User | Revision | Line number | New 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 | 5:0728bde67bdb | 175 | /*! ADMW1001 analog input signal amplification gain options |
Vkadaba | 5:0728bde67bdb | 176 | * |
Vkadaba | 5:0728bde67bdb | 177 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 5:0728bde67bdb | 178 | */ |
Vkadaba | 8:2f2775c34640 | 179 | typedef enum |
Vkadaba | 8:2f2775c34640 | 180 | { |
Vkadaba | 6:9d393a9677f4 | 181 | ADMW1001_ADC_RTD_CURVE_EUROPEAN = 0, |
Vkadaba | 6:9d393a9677f4 | 182 | /*!< EUROPEAN RTD curve used. */ |
Vkadaba | 6:9d393a9677f4 | 183 | ADMW1001_ADC_RTD_CURVE_AMERICAN, |
Vkadaba | 6:9d393a9677f4 | 184 | /*!< AMERICAN RTD curve used. */ |
Vkadaba | 6:9d393a9677f4 | 185 | ADMW1001_ADC_RTD_CURVE_JAPANESE, |
Vkadaba | 6:9d393a9677f4 | 186 | /*!< JAPANESE RTD curve used. */ |
Vkadaba | 6:9d393a9677f4 | 187 | ADMW1001_ADC_RTD_CURVE_ITS90, |
Vkadaba | 6:9d393a9677f4 | 188 | /*!< ITS90 RTD curve used. */ |
Vkadaba | 8:2f2775c34640 | 189 | |
Vkadaba | 8:2f2775c34640 | 190 | } ADMW1001_ADC_RTD_CURVE; |
Vkadaba | 6:9d393a9677f4 | 191 | /*! ADMW1001 analog input signal amplification gain options |
Vkadaba | 6:9d393a9677f4 | 192 | * |
Vkadaba | 6:9d393a9677f4 | 193 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 6:9d393a9677f4 | 194 | */ |
Vkadaba | 8:2f2775c34640 | 195 | typedef enum |
Vkadaba | 8:2f2775c34640 | 196 | { |
Vkadaba | 5:0728bde67bdb | 197 | ADMW1001_ADC_GAIN_1X = 0, |
Vkadaba | 5:0728bde67bdb | 198 | /*!< no amplification gain */ |
Vkadaba | 5:0728bde67bdb | 199 | ADMW1001_ADC_GAIN_2X, |
Vkadaba | 5:0728bde67bdb | 200 | /*!< x2 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 201 | ADMW1001_ADC_GAIN_4X, |
Vkadaba | 5:0728bde67bdb | 202 | /*!< x4 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 203 | ADMW1001_ADC_GAIN_8X, |
Vkadaba | 5:0728bde67bdb | 204 | /*!< x8 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 205 | ADMW1001_ADC_GAIN_16X, |
Vkadaba | 5:0728bde67bdb | 206 | /*!< x16 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 207 | ADMW1001_ADC_GAIN_32X, |
Vkadaba | 5:0728bde67bdb | 208 | /*!< x32 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 209 | ADMW1001_ADC_GAIN_64X, |
Vkadaba | 5:0728bde67bdb | 210 | /*!< x64 amplification gain */ |
Vkadaba | 5:0728bde67bdb | 211 | ADMW1001_ADC_GAIN_128X, |
Vkadaba | 5:0728bde67bdb | 212 | /*!< x128 amplification gain */ |
Vkadaba | 8:2f2775c34640 | 213 | |
Vkadaba | 8:2f2775c34640 | 214 | } ADMW1001_ADC_GAIN; |
Vkadaba | 5:0728bde67bdb | 215 | |
Vkadaba | 6:9d393a9677f4 | 216 | /*! ADMW1001 analog sensor excitation state options |
Vkadaba | 6:9d393a9677f4 | 217 | * |
Vkadaba | 6:9d393a9677f4 | 218 | * @note applicable only to ADC analog sensor channels, and |
Vkadaba | 6:9d393a9677f4 | 219 | * specific sensor types |
Vkadaba | 6:9d393a9677f4 | 220 | */ |
Vkadaba | 8:2f2775c34640 | 221 | typedef enum |
Vkadaba | 8:2f2775c34640 | 222 | { |
Vkadaba | 6:9d393a9677f4 | 223 | ADMW1001_ADC_EXC_STATE_ALWAYS_ON, |
Vkadaba | 6:9d393a9677f4 | 224 | /*!< Excitation for measurement is always on */ |
Vkadaba | 6:9d393a9677f4 | 225 | ADMW1001_ADC_EXC_STATE_CYCLE_POWER, |
Vkadaba | 6:9d393a9677f4 | 226 | /*!< Excitation for measurement is active only during measurement */ |
Vkadaba | 8:2f2775c34640 | 227 | |
Vkadaba | 8:2f2775c34640 | 228 | } ADMW1001_ADC_EXC_STATE; |
Vkadaba | 6:9d393a9677f4 | 229 | |
Vkadaba | 5:0728bde67bdb | 230 | /*! ADMW1001 analog sensor excitation current output level options |
Vkadaba | 5:0728bde67bdb | 231 | * |
Vkadaba | 5:0728bde67bdb | 232 | * @note applicable only to ADC analog sensor channels, and |
Vkadaba | 5:0728bde67bdb | 233 | * specific sensor types |
Vkadaba | 5:0728bde67bdb | 234 | */ |
Vkadaba | 8:2f2775c34640 | 235 | typedef enum |
Vkadaba | 8:2f2775c34640 | 236 | { |
Vkadaba | 6:9d393a9677f4 | 237 | ADMW1001_ADC_EXC_CURRENT_EXTERNAL = 0, |
Vkadaba | 6:9d393a9677f4 | 238 | /*!< External excitation is provided */ |
Vkadaba | 5:0728bde67bdb | 239 | ADMW1001_ADC_EXC_CURRENT_50uA, |
Vkadaba | 5:0728bde67bdb | 240 | /*!< 50uA excitation current enabled */ |
Vkadaba | 5:0728bde67bdb | 241 | ADMW1001_ADC_EXC_CURRENT_100uA, |
Vkadaba | 5:0728bde67bdb | 242 | /*!< 100uA excitation current */ |
Vkadaba | 5:0728bde67bdb | 243 | ADMW1001_ADC_EXC_CURRENT_250uA, |
Vkadaba | 5:0728bde67bdb | 244 | /*!< 250uA excitation current enabled */ |
Vkadaba | 5:0728bde67bdb | 245 | ADMW1001_ADC_EXC_CURRENT_500uA, |
Vkadaba | 5:0728bde67bdb | 246 | /*!< 500uA excitation current enabled */ |
Vkadaba | 5:0728bde67bdb | 247 | ADMW1001_ADC_EXC_CURRENT_1000uA, |
Vkadaba | 5:0728bde67bdb | 248 | /*!< 1mA excitation current enabled */ |
Vkadaba | 8:2f2775c34640 | 249 | |
Vkadaba | 8:2f2775c34640 | 250 | } ADMW1001_ADC_EXC_CURRENT; |
Vkadaba | 5:0728bde67bdb | 251 | |
Vkadaba | 5:0728bde67bdb | 252 | /*! ADMW1001 analog sensor excitation current ratios used for diode sensor |
Vkadaba | 5:0728bde67bdb | 253 | * |
Vkadaba | 5:0728bde67bdb | 254 | * @note applicable only to a diode sensor |
Vkadaba | 5:0728bde67bdb | 255 | */ |
Vkadaba | 8:2f2775c34640 | 256 | typedef enum |
Vkadaba | 8:2f2775c34640 | 257 | { |
Vkadaba | 6:9d393a9677f4 | 258 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_100UA = 0, |
Vkadaba | 6:9d393a9677f4 | 259 | /**< 2 Current measurement 10uA 100uA */ |
Vkadaba | 6:9d393a9677f4 | 260 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_160UA, |
Vkadaba | 6:9d393a9677f4 | 261 | /**< 2 Current measurement 20uA 160uA */ |
Vkadaba | 6:9d393a9677f4 | 262 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_300UA, |
Vkadaba | 6:9d393a9677f4 | 263 | /**< 2 Current measurement 50uA 300uA */ |
Vkadaba | 6:9d393a9677f4 | 264 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_600UA, |
Vkadaba | 6:9d393a9677f4 | 265 | /**< 2 Current measurement 100uA 600uA */ |
Vkadaba | 6:9d393a9677f4 | 266 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_50UA_100UA, |
Vkadaba | 6:9d393a9677f4 | 267 | /**< 3 current measuremetn 10uA 50uA 100uA */ |
Vkadaba | 6:9d393a9677f4 | 268 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_100UA_160UA, |
Vkadaba | 6:9d393a9677f4 | 269 | /**< 3 current measuremetn 20uA 100uA 160uA */ |
Vkadaba | 6:9d393a9677f4 | 270 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_150UA_300UA, |
Vkadaba | 6:9d393a9677f4 | 271 | /**< 3 current measuremetn 50uA 150uA 300uA */ |
Vkadaba | 6:9d393a9677f4 | 272 | ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_300UA_600UA, |
Vkadaba | 6:9d393a9677f4 | 273 | /**< 3 current measuremetn 100uA 300uA 600uA */ |
Vkadaba | 8:2f2775c34640 | 274 | |
Vkadaba | 8:2f2775c34640 | 275 | } ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO; |
Vkadaba | 5:0728bde67bdb | 276 | |
Vkadaba | 5:0728bde67bdb | 277 | /*! ADMW1001 analog reference selection options |
Vkadaba | 5:0728bde67bdb | 278 | * |
Vkadaba | 5:0728bde67bdb | 279 | * @note applicable only to ADC analog sensor channels, and |
Vkadaba | 5:0728bde67bdb | 280 | * specific sensor types |
Vkadaba | 5:0728bde67bdb | 281 | */ |
Vkadaba | 8:2f2775c34640 | 282 | typedef enum |
Vkadaba | 8:2f2775c34640 | 283 | { |
Vkadaba | 8:2f2775c34640 | 284 | ADMW1001_ADC_REFERENCE_VOLTAGE_INTERNAL = 0, |
Vkadaba | 8:2f2775c34640 | 285 | /*!< Internal VRef - 1.2V */ |
Vkadaba | 8:2f2775c34640 | 286 | ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_1, |
Vkadaba | 8:2f2775c34640 | 287 | /*!< External reference voltage #1 */ |
Vkadaba | 8:2f2775c34640 | 288 | ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_2, |
Vkadaba | 8:2f2775c34640 | 289 | /*!< External reference voltage #2 */ |
Vkadaba | 5:0728bde67bdb | 290 | ADMW1001_ADC_REFERENCE_VOLTAGE_AVDD, |
Vkadaba | 5:0728bde67bdb | 291 | /*!< Analag Supply Voltage AVDD reference (typically 3.3V) is selected */ |
Vkadaba | 5:0728bde67bdb | 292 | |
Vkadaba | 8:2f2775c34640 | 293 | } ADMW1001_ADC_REFERENCE_TYPE; |
Vkadaba | 5:0728bde67bdb | 294 | |
Vkadaba | 6:9d393a9677f4 | 295 | /*! ADMW1001 ADC Reference configuration |
Vkadaba | 6:9d393a9677f4 | 296 | * |
Vkadaba | 6:9d393a9677f4 | 297 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 6:9d393a9677f4 | 298 | */ |
Vkadaba | 8:2f2775c34640 | 299 | typedef enum |
Vkadaba | 8:2f2775c34640 | 300 | { |
Vkadaba | 6:9d393a9677f4 | 301 | ADMW1001_ADC_GND_SW_OPEN = 0, |
Vkadaba | 6:9d393a9677f4 | 302 | /*!< Ground switch not enabled for measurement. */ |
Vkadaba | 6:9d393a9677f4 | 303 | ADMW1001_ADC_GND_SW_CLOSED, |
Vkadaba | 8:2f2775c34640 | 304 | /*!< Ground switch enabled for measurement. */ |
Vkadaba | 8:2f2775c34640 | 305 | |
Vkadaba | 8:2f2775c34640 | 306 | } ADMW1001_ADC_GND_SW; |
Vkadaba | 8:2f2775c34640 | 307 | |
Vkadaba | 8:2f2775c34640 | 308 | /*! ADMW1001 analog filter chop mode |
Vkadaba | 8:2f2775c34640 | 309 | * |
Vkadaba | 8:2f2775c34640 | 310 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 8:2f2775c34640 | 311 | */ |
Vkadaba | 8:2f2775c34640 | 312 | typedef enum |
Vkadaba | 8:2f2775c34640 | 313 | { |
Vkadaba | 8:2f2775c34640 | 314 | ADMW1001_CHOP_MD_NONE = 0, |
Vkadaba | 8:2f2775c34640 | 315 | /*!< No chop performed. */ |
Vkadaba | 8:2f2775c34640 | 316 | ADMW1001_CHOP_MD_HW, |
Vkadaba | 8:2f2775c34640 | 317 | /*!< Hardware only chop performed. */ |
Vkadaba | 8:2f2775c34640 | 318 | ADMW1001_CHOP_MD_SW, |
Vkadaba | 8:2f2775c34640 | 319 | /*!< Software only chop performed. */ |
Vkadaba | 8:2f2775c34640 | 320 | ADMW1001_CHOP_MD_HWSW, |
Vkadaba | 8:2f2775c34640 | 321 | /*!< Hardware and software chop performed. */ |
Vkadaba | 8:2f2775c34640 | 322 | |
Vkadaba | 8:2f2775c34640 | 323 | } ADMW1001_CHOP_MD; |
Vkadaba | 6:9d393a9677f4 | 324 | |
Vkadaba | 5:0728bde67bdb | 325 | /*! ADMW1001 analog filter selection options |
Vkadaba | 5:0728bde67bdb | 326 | * |
Vkadaba | 5:0728bde67bdb | 327 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 5:0728bde67bdb | 328 | */ |
Vkadaba | 8:2f2775c34640 | 329 | typedef enum |
Vkadaba | 8:2f2775c34640 | 330 | { |
Vkadaba | 6:9d393a9677f4 | 331 | ADMW1001_ADC_FILTER_SINC4 = 0, |
Vkadaba | 8:2f2775c34640 | 332 | /*!< SINC4 - 4th order sinc response filter */ |
Vkadaba | 6:9d393a9677f4 | 333 | ADMW1001_ADC_FILTER_SINC3, |
Vkadaba | 8:2f2775c34640 | 334 | /*!< SINC3 - 3rd order sinc response filter */ |
Vkadaba | 8:2f2775c34640 | 335 | |
Vkadaba | 8:2f2775c34640 | 336 | } ADMW1001_ADC_FILTER_TYPE; |
Vkadaba | 8:2f2775c34640 | 337 | |
Vkadaba | 8:2f2775c34640 | 338 | /*! ADMW1001 Sinc Filter range (SF) |
Vkadaba | 8:2f2775c34640 | 339 | * |
Vkadaba | 8:2f2775c34640 | 340 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 8:2f2775c34640 | 341 | * @note SF must be set in conjunction with chop mode |
Vkadaba | 8:2f2775c34640 | 342 | * and sinc filter type to achieve the desired sampling rate. |
Vkadaba | 8:2f2775c34640 | 343 | */ |
Vkadaba | 8:2f2775c34640 | 344 | typedef enum |
Vkadaba | 8:2f2775c34640 | 345 | { |
Vkadaba | 8:2f2775c34640 | 346 | ADMW1001_SF_976HZ = 0, |
Vkadaba | 8:2f2775c34640 | 347 | /*!< SF setting for 976Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 348 | ADMW1001_SF_488HZ = 1, |
Vkadaba | 8:2f2775c34640 | 349 | /*!< SF setting for 488Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 350 | ADMW1001_SF_244HZ = 3, |
Vkadaba | 8:2f2775c34640 | 351 | /*!< SF setting for 244Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 352 | ADMW1001_SF_122HZ = 7, |
Vkadaba | 8:2f2775c34640 | 353 | /*!< SF setting for 122Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 354 | ADMW1001_SF_61HZ = 31, |
Vkadaba | 8:2f2775c34640 | 355 | /*!< SF setting for 61Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 356 | ADMW1001_SF_30P5HZ = 51, |
Vkadaba | 8:2f2775c34640 | 357 | /*!< SF setting for 61Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 358 | ADMW1001_SF_10HZ = 124, |
Vkadaba | 8:2f2775c34640 | 359 | /*!< SF setting for 10Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 360 | ADMW1001_SF_8P24HZ = 125, |
Vkadaba | 8:2f2775c34640 | 361 | /*!< SF setting for 8.24Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 362 | ADMW1001_SF_5HZ = 127, |
Vkadaba | 8:2f2775c34640 | 363 | /*!< SF setting for 5Hz sample rate. */ |
Vkadaba | 8:2f2775c34640 | 364 | |
Vkadaba | 8:2f2775c34640 | 365 | } ADMW1001_SINC_FILTER_RANGE; |
Vkadaba | 5:0728bde67bdb | 366 | |
Vkadaba | 5:0728bde67bdb | 367 | /*! ADMW1001 I2C clock speed options |
Vkadaba | 5:0728bde67bdb | 368 | * |
Vkadaba | 5:0728bde67bdb | 369 | * @note applicable only for I2C sensors |
Vkadaba | 5:0728bde67bdb | 370 | */ |
Vkadaba | 5:0728bde67bdb | 371 | typedef enum |
Vkadaba | 5:0728bde67bdb | 372 | { |
Vkadaba | 8:2f2775c34640 | 373 | ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_100K = 0, |
Vkadaba | 5:0728bde67bdb | 374 | /*!< 100kHz I2C clock speed */ |
Vkadaba | 8:2f2775c34640 | 375 | ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_400K, |
Vkadaba | 5:0728bde67bdb | 376 | /*!< 400kHz I2C clock speed */ |
Vkadaba | 8:2f2775c34640 | 377 | |
Vkadaba | 8:2f2775c34640 | 378 | } ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED; |
Vkadaba | 5:0728bde67bdb | 379 | |
Vkadaba | 5:0728bde67bdb | 380 | /*! ADMW1001 SPI mode options |
Vkadaba | 5:0728bde67bdb | 381 | * |
Vkadaba | 5:0728bde67bdb | 382 | * @note applicable only for SPI sensors |
Vkadaba | 5:0728bde67bdb | 383 | */ |
Vkadaba | 5:0728bde67bdb | 384 | typedef enum |
Vkadaba | 5:0728bde67bdb | 385 | { |
Vkadaba | 8:2f2775c34640 | 386 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_0 = 0, |
Vkadaba | 5:0728bde67bdb | 387 | /*!< SPI mode 0 Clock Polarity = 0 Clock Phase = 0 */ |
Vkadaba | 8:2f2775c34640 | 388 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_1, |
Vkadaba | 5:0728bde67bdb | 389 | /*!< SPI mode 0 Clock Polarity = 0 Clock Phase = 1 */ |
Vkadaba | 8:2f2775c34640 | 390 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_2, |
Vkadaba | 5:0728bde67bdb | 391 | /*!< SPI mode 0 Clock Polarity = 1 Clock Phase = 0 */ |
Vkadaba | 8:2f2775c34640 | 392 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE_3, |
Vkadaba | 5:0728bde67bdb | 393 | /*!< SPI mode 0 Clock Polarity = 1 Clock Phase = 1 */ |
Vkadaba | 8:2f2775c34640 | 394 | |
Vkadaba | 8:2f2775c34640 | 395 | } ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE; |
Vkadaba | 5:0728bde67bdb | 396 | |
Vkadaba | 5:0728bde67bdb | 397 | /*! ADMW1001 SPI clock speed options |
Vkadaba | 5:0728bde67bdb | 398 | * |
Vkadaba | 5:0728bde67bdb | 399 | * @note applicable only for SPI sensors |
Vkadaba | 5:0728bde67bdb | 400 | */ |
Vkadaba | 5:0728bde67bdb | 401 | typedef enum |
Vkadaba | 5:0728bde67bdb | 402 | { |
Vkadaba | 8:2f2775c34640 | 403 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_8MHZ = 0, |
Vkadaba | 8:2f2775c34640 | 404 | /*!< SPI Clock Speed configured to 8MHz */ |
Vkadaba | 8:2f2775c34640 | 405 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_4MHZ, |
Vkadaba | 8:2f2775c34640 | 406 | /*!< SPI Clock Speed configured to 4MHz */ |
Vkadaba | 8:2f2775c34640 | 407 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_2MHZ, |
Vkadaba | 8:2f2775c34640 | 408 | /*!< SPI Clock Speed configured to 2MHz */ |
Vkadaba | 8:2f2775c34640 | 409 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_1MHZ, |
Vkadaba | 8:2f2775c34640 | 410 | /*!< SPI Clock Speed configured to 1MHz */ |
Vkadaba | 8:2f2775c34640 | 411 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_500KHZ, |
Vkadaba | 8:2f2775c34640 | 412 | /*!< SPI Clock Speed configured to 500kHz */ |
Vkadaba | 8:2f2775c34640 | 413 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_250KHZ, |
Vkadaba | 8:2f2775c34640 | 414 | /*!< SPI Clock Speed configured to 250kHz */ |
Vkadaba | 8:2f2775c34640 | 415 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_125KHZ, |
Vkadaba | 8:2f2775c34640 | 416 | /*!< SPI Clock Speed configured to 125kHz */ |
Vkadaba | 8:2f2775c34640 | 417 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_62P5KHZ, |
Vkadaba | 8:2f2775c34640 | 418 | /*!< SPI Clock Speed configured to 62.5kHz */ |
Vkadaba | 8:2f2775c34640 | 419 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_31P3KHZ, |
Vkadaba | 8:2f2775c34640 | 420 | /*!< SPI Clock Speed configured to 31.3kHz */ |
Vkadaba | 8:2f2775c34640 | 421 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_15P6KHZ, |
Vkadaba | 8:2f2775c34640 | 422 | /*!< SPI Clock Speed configured to 15.6kHz */ |
Vkadaba | 8:2f2775c34640 | 423 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_7P8KHZ, |
Vkadaba | 8:2f2775c34640 | 424 | /*!< SPI Clock Speed configured to 7.8kHz */ |
Vkadaba | 8:2f2775c34640 | 425 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_3P9KHZ, |
Vkadaba | 8:2f2775c34640 | 426 | /*!< SPI Clock Speed configured to 3.9kHz */ |
Vkadaba | 8:2f2775c34640 | 427 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_1P9KHZ, |
Vkadaba | 8:2f2775c34640 | 428 | /*!< SPI Clock Speed configured to 1.9kHz */ |
Vkadaba | 8:2f2775c34640 | 429 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_977HZ, |
Vkadaba | 8:2f2775c34640 | 430 | /*!< SPI Clock Speed configured to 977Hz */ |
Vkadaba | 8:2f2775c34640 | 431 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_488HZ, |
Vkadaba | 8:2f2775c34640 | 432 | /*!< SPI Clock Speed configured to 488Hz */ |
Vkadaba | 8:2f2775c34640 | 433 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK_244HZ, |
Vkadaba | 8:2f2775c34640 | 434 | /*!< SPI Clock Speed configured to 244Hz */ |
Vkadaba | 8:2f2775c34640 | 435 | |
Vkadaba | 8:2f2775c34640 | 436 | } ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK; |
Vkadaba | 5:0728bde67bdb | 437 | |
Vkadaba | 5:0728bde67bdb | 438 | /*! ADMW1001 Power Configuration options */ |
Vkadaba | 8:2f2775c34640 | 439 | typedef struct |
Vkadaba | 8:2f2775c34640 | 440 | { |
Vkadaba | 5:0728bde67bdb | 441 | ADMW1001_POWER_MODE powerMode; |
Vkadaba | 5:0728bde67bdb | 442 | /*!< Power mode selection */ |
Vkadaba | 8:2f2775c34640 | 443 | |
Vkadaba | 8:2f2775c34640 | 444 | } ADMW1001_POWER_CONFIG; |
Vkadaba | 5:0728bde67bdb | 445 | |
Vkadaba | 5:0728bde67bdb | 446 | /*! ADMW1001 Multi-Cycle Configuration options |
Vkadaba | 5:0728bde67bdb | 447 | * |
Vkadaba | 5:0728bde67bdb | 448 | * @note required only when ADMW1001_OPERATING_MODE_MULTICYCLE is selected |
Vkadaba | 5:0728bde67bdb | 449 | * as the operatingMode (@ref ADMW1001_MEASUREMENT_CONFIG) |
Vkadaba | 5:0728bde67bdb | 450 | */ |
Vkadaba | 8:2f2775c34640 | 451 | typedef struct |
Vkadaba | 8:2f2775c34640 | 452 | { |
Vkadaba | 8:2f2775c34640 | 453 | uint32_t cyclesPerBurst; |
Vkadaba | 5:0728bde67bdb | 454 | /*!< Number of cycles to complete for a single burst */ |
Vkadaba | 8:2f2775c34640 | 455 | uint32_t burstInterval; |
Vkadaba | 5:0728bde67bdb | 456 | /*!< Interval, in seconds, between each successive burst of cycles */ |
Vkadaba | 8:2f2775c34640 | 457 | |
Vkadaba | 8:2f2775c34640 | 458 | } ADMW1001_MULTICYCLE_CONFIG; |
Vkadaba | 5:0728bde67bdb | 459 | |
Vkadaba | 5:0728bde67bdb | 460 | /*! ADMW1001 Measurement Configuration options */ |
Vkadaba | 8:2f2775c34640 | 461 | typedef struct |
Vkadaba | 8:2f2775c34640 | 462 | { |
Vkadaba | 5:0728bde67bdb | 463 | ADMW1001_OPERATING_MODE operatingMode; |
Vkadaba | 5:0728bde67bdb | 464 | /*!< Operating mode - specifies how measurement cycles are scheduled */ |
Vkadaba | 5:0728bde67bdb | 465 | ADMW1001_DATAREADY_MODE dataReadyMode; |
Vkadaba | 5:0728bde67bdb | 466 | /*!< Data read mode - specifies how output samples are stored for reading */ |
Vkadaba | 5:0728bde67bdb | 467 | ADMW1001_MULTICYCLE_CONFIG multiCycleConfig; |
Vkadaba | 5:0728bde67bdb | 468 | /*!< Multi-Cycle configuration - specifies how bursts of measurement cycles |
Vkadaba | 5:0728bde67bdb | 469 | * are scheduled. Applicable only when operatingMode is |
Vkadaba | 5:0728bde67bdb | 470 | * ADMW1001_OPERATING_MODE_MULTICYCLE |
Vkadaba | 5:0728bde67bdb | 471 | */ |
Vkadaba | 5:0728bde67bdb | 472 | ADMW1001_FILTER_SETTLING filterSettling; |
Vkadaba | 5:0728bde67bdb | 473 | /*!< Analog filter settling - specifies the policy for settling time |
Vkadaba | 5:0728bde67bdb | 474 | * between consecutive measurements from an analog channel in a multi- |
Vkadaba | 5:0728bde67bdb | 475 | * channel configuration. Note that, in single analog channel |
Vkadaba | 5:0728bde67bdb | 476 | * configurations, settling time is always skipped between consecutive |
Vkadaba | 5:0728bde67bdb | 477 | * measurements in a measurement cycle. |
Vkadaba | 5:0728bde67bdb | 478 | */ |
Vkadaba | 8:2f2775c34640 | 479 | uint8_t reserved0[3]; |
Vkadaba | 8:2f2775c34640 | 480 | /*!< Reserved for future use and ensure word alignment. |
Vkadaba | 8:2f2775c34640 | 481 | */ |
Vkadaba | 8:2f2775c34640 | 482 | uint32_t cycleInterval; |
Vkadaba | 8:2f2775c34640 | 483 | /*!< Cycle interval - specifies the time interval between the start of each |
Vkadaba | 8:2f2775c34640 | 484 | * successive measurement cycle. Applicable only when operatingMode is |
Vkadaba | 8:2f2775c34640 | 485 | * not ADMW1001_OPERATING_MODE_SINGLECYCLE |
Vkadaba | 8:2f2775c34640 | 486 | */ |
Vkadaba | 8:2f2775c34640 | 487 | bool vBiasEnable; |
Vkadaba | 8:2f2775c34640 | 488 | /*!< Enable voltage Bias output of ADC |
Vkadaba | 8:2f2775c34640 | 489 | */ |
Vkadaba | 8:2f2775c34640 | 490 | float32_t externalRef1Value; |
Vkadaba | 8:2f2775c34640 | 491 | /*!< Voltage value connected to external reference input #1. |
Vkadaba | 5:0728bde67bdb | 492 | * Applicable only if the selected reference type is |
Vkadaba | 8:2f2775c34640 | 493 | * voltage. |
Vkadaba | 5:0728bde67bdb | 494 | * (see @ref ADMW1001_ADC_REFERENCE_TYPE) |
Vkadaba | 5:0728bde67bdb | 495 | */ |
Vkadaba | 8:2f2775c34640 | 496 | uint32_t reserved1[4]; |
Vkadaba | 8:2f2775c34640 | 497 | /*!< Reserved for future use and ensure word alignment. |
Vkadaba | 8:2f2775c34640 | 498 | */ |
Vkadaba | 8:2f2775c34640 | 499 | |
Vkadaba | 8:2f2775c34640 | 500 | } ADMW1001_MEASUREMENT_CONFIG; |
Vkadaba | 5:0728bde67bdb | 501 | |
Vkadaba | 5:0728bde67bdb | 502 | /*! ADMW1001 ADC Excitation Current output configuration |
Vkadaba | 5:0728bde67bdb | 503 | * |
Vkadaba | 5:0728bde67bdb | 504 | * @note applicable only to ADC analog sensor channels, and |
Vkadaba | 5:0728bde67bdb | 505 | * specific sensor types |
Vkadaba | 5:0728bde67bdb | 506 | */ |
Vkadaba | 8:2f2775c34640 | 507 | typedef struct |
Vkadaba | 8:2f2775c34640 | 508 | { |
Vkadaba | 6:9d393a9677f4 | 509 | ADMW1001_ADC_EXC_STATE excitationState; |
Vkadaba | 6:9d393a9677f4 | 510 | /*!< Excitation current state */ |
Vkadaba | 5:0728bde67bdb | 511 | ADMW1001_ADC_EXC_CURRENT outputLevel; |
Vkadaba | 5:0728bde67bdb | 512 | /*!< Excitation current output level */ |
Vkadaba | 5:0728bde67bdb | 513 | ADMW1001_ADC_EXC_CURRENT_DIODE_RATIO diodeRatio; |
Vkadaba | 5:0728bde67bdb | 514 | /*!< Excitation current output diode ratio */ |
Vkadaba | 8:2f2775c34640 | 515 | |
Vkadaba | 8:2f2775c34640 | 516 | } ADMW1001_ADC_EXC_CURRENT_CONFIG; |
Vkadaba | 5:0728bde67bdb | 517 | |
Vkadaba | 5:0728bde67bdb | 518 | /*! ADMW1001 ADC Filter configuration |
Vkadaba | 5:0728bde67bdb | 519 | * |
Vkadaba | 5:0728bde67bdb | 520 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 5:0728bde67bdb | 521 | */ |
Vkadaba | 8:2f2775c34640 | 522 | typedef struct |
Vkadaba | 8:2f2775c34640 | 523 | { |
Vkadaba | 8:2f2775c34640 | 524 | ADMW1001_ADC_FILTER_TYPE type; |
Vkadaba | 5:0728bde67bdb | 525 | /*!< Filter type selection */ |
Vkadaba | 8:2f2775c34640 | 526 | ADMW1001_SINC_FILTER_RANGE sf; |
Vkadaba | 8:2f2775c34640 | 527 | /*!< SF value used along with filter type and chop mode to determine speed */ |
Vkadaba | 17:2f0028880874 | 528 | ADMW1001_CHOP_MD chopMode; |
Vkadaba | 6:9d393a9677f4 | 529 | /*!< Enable filter chop */ |
Vkadaba | 8:2f2775c34640 | 530 | bool notch1p2; |
Vkadaba | 6:9d393a9677f4 | 531 | /*!< Enable Notch 2 Filter Mode */ |
Vkadaba | 8:2f2775c34640 | 532 | ADMW1001_ADC_GND_SW groundSwitch; |
Vkadaba | 6:9d393a9677f4 | 533 | /*!< Option to open or close sensor ground switch */ |
Vkadaba | 5:0728bde67bdb | 534 | |
Vkadaba | 8:2f2775c34640 | 535 | } ADMW1001_ADC_FILTER_CONFIG; |
Vkadaba | 5:0728bde67bdb | 536 | |
Vkadaba | 5:0728bde67bdb | 537 | /*! ADMW1001 ADC analog channel configuration details |
Vkadaba | 5:0728bde67bdb | 538 | * |
Vkadaba | 5:0728bde67bdb | 539 | * @note applicable only to ADC analog sensor channels |
Vkadaba | 5:0728bde67bdb | 540 | */ |
Vkadaba | 8:2f2775c34640 | 541 | typedef struct |
Vkadaba | 8:2f2775c34640 | 542 | { |
Vkadaba | 5:0728bde67bdb | 543 | ADMW1001_ADC_SENSOR_TYPE sensor; |
Vkadaba | 5:0728bde67bdb | 544 | /*!< Sensor type selection */ |
Vkadaba | 6:9d393a9677f4 | 545 | ADMW1001_ADC_RTD_CURVE rtdCurve; |
Vkadaba | 6:9d393a9677f4 | 546 | /*!< Rtd curve selection */ |
Vkadaba | 5:0728bde67bdb | 547 | ADMW1001_ADC_GAIN gain; |
Vkadaba | 5:0728bde67bdb | 548 | /*!< ADC Gain selection */ |
Vkadaba | 5:0728bde67bdb | 549 | ADMW1001_ADC_EXC_CURRENT_CONFIG current; |
Vkadaba | 5:0728bde67bdb | 550 | /*!< ADC Excitation Current configuration */ |
Vkadaba | 5:0728bde67bdb | 551 | ADMW1001_ADC_FILTER_CONFIG filter; |
Vkadaba | 5:0728bde67bdb | 552 | /*!< ADC Filter configuration */ |
Vkadaba | 8:2f2775c34640 | 553 | ADMW1001_ADC_REFERENCE_TYPE reference; |
Vkadaba | 11:8e6023d2e584 | 554 | bool vBiasEnable; |
Vkadaba | 5:0728bde67bdb | 555 | /*!< ADC Reference configuration */ |
Vkadaba | 8:2f2775c34640 | 556 | uint8_t reserved0[3]; |
Vkadaba | 8:2f2775c34640 | 557 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 8:2f2775c34640 | 558 | uint32_t reserved1[6]; |
Vkadaba | 8:2f2775c34640 | 559 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 8:2f2775c34640 | 560 | |
Vkadaba | 8:2f2775c34640 | 561 | } ADMW1001_ADC_CHANNEL_CONFIG; |
Vkadaba | 8:2f2775c34640 | 562 | |
Vkadaba | 8:2f2775c34640 | 563 | /*! ADMW1001 look-up table selection |
Vkadaba | 8:2f2775c34640 | 564 | * Select table used to linearise the measurement. |
Vkadaba | 8:2f2775c34640 | 565 | */ |
Vkadaba | 8:2f2775c34640 | 566 | typedef enum |
Vkadaba | 8:2f2775c34640 | 567 | { |
Vkadaba | 8:2f2775c34640 | 568 | ADMW1001_LUT_DEFAULT = 0, |
Vkadaba | 8:2f2775c34640 | 569 | /*!< Default LUT */ |
Vkadaba | 8:2f2775c34640 | 570 | ADMW1001_LUT_UNITY = 1, |
Vkadaba | 8:2f2775c34640 | 571 | /*!< Unity LUT */ |
Vkadaba | 8:2f2775c34640 | 572 | ADMW1001_LUT_CUSTOM = 2, |
Vkadaba | 8:2f2775c34640 | 573 | /*!< User defined custom LUT */ |
Vkadaba | 8:2f2775c34640 | 574 | ADMW1001_LUT_RESERVED = 3, |
Vkadaba | 8:2f2775c34640 | 575 | /*!< Reserved for future use */ |
Vkadaba | 8:2f2775c34640 | 576 | |
Vkadaba | 8:2f2775c34640 | 577 | } ADMW1001_LUT_SELECT; |
Vkadaba | 5:0728bde67bdb | 578 | |
Vkadaba | 5:0728bde67bdb | 579 | /*! ADMW1001 digital sensor data encoding |
Vkadaba | 5:0728bde67bdb | 580 | * |
Vkadaba | 5:0728bde67bdb | 581 | * @note applicable only to SPI and I2C digital sensor channels |
Vkadaba | 5:0728bde67bdb | 582 | */ |
Vkadaba | 5:0728bde67bdb | 583 | typedef enum |
Vkadaba | 5:0728bde67bdb | 584 | { |
Vkadaba | 8:2f2775c34640 | 585 | ADMW1001_DIGITAL_SENSOR_DATA_CODING_NONE = 0, |
Vkadaba | 5:0728bde67bdb | 586 | /**< None/Invalid - data format is ignored if coding is set to this value */ |
Vkadaba | 5:0728bde67bdb | 587 | ADMW1001_DIGITAL_SENSOR_DATA_CODING_UNIPOLAR, |
Vkadaba | 5:0728bde67bdb | 588 | /**< Unipolar - unsigned integer values */ |
Vkadaba | 5:0728bde67bdb | 589 | ADMW1001_DIGITAL_SENSOR_DATA_CODING_TWOS_COMPLEMENT, |
Vkadaba | 5:0728bde67bdb | 590 | /**< Twos-complement - signed integer values */ |
Vkadaba | 5:0728bde67bdb | 591 | ADMW1001_DIGITAL_SENSOR_DATA_CODING_OFFSET_BINARY, |
Vkadaba | 5:0728bde67bdb | 592 | /**< Offset Binary - used to represent signed values with unsigned integers, |
Vkadaba | 5:0728bde67bdb | 593 | * with the mid-range value representing 0 */ |
Vkadaba | 8:2f2775c34640 | 594 | |
Vkadaba | 8:2f2775c34640 | 595 | } ADMW1001_DIGITAL_SENSOR_DATA_CODING; |
Vkadaba | 5:0728bde67bdb | 596 | |
Vkadaba | 5:0728bde67bdb | 597 | /*! ADMW1001 digital sensor data format configuration |
Vkadaba | 5:0728bde67bdb | 598 | * |
Vkadaba | 5:0728bde67bdb | 599 | * @note applicable only to SPI and I2C digital sensor channels |
Vkadaba | 5:0728bde67bdb | 600 | */ |
Vkadaba | 8:2f2775c34640 | 601 | typedef struct |
Vkadaba | 8:2f2775c34640 | 602 | { |
Vkadaba | 5:0728bde67bdb | 603 | ADMW1001_DIGITAL_SENSOR_DATA_CODING coding; |
Vkadaba | 5:0728bde67bdb | 604 | /**< Data Encoding of Sensor Result */ |
Vkadaba | 5:0728bde67bdb | 605 | bool littleEndian; |
Vkadaba | 5:0728bde67bdb | 606 | /**< Set as true if data format is little-endian, false otherwise */ |
Vkadaba | 5:0728bde67bdb | 607 | bool leftJustified; |
Vkadaba | 5:0728bde67bdb | 608 | /**< Set as true if data is left-justified in the data frame, false otherwise */ |
Vkadaba | 5:0728bde67bdb | 609 | uint8_t frameLength; |
Vkadaba | 5:0728bde67bdb | 610 | /**< Data frame length (number of bytes to read from the sensor) */ |
Vkadaba | 5:0728bde67bdb | 611 | uint8_t numDataBits; |
Vkadaba | 5:0728bde67bdb | 612 | /**< Number of relevant data bits to extract from the data frame */ |
Vkadaba | 5:0728bde67bdb | 613 | uint8_t bitOffset; |
Vkadaba | 5:0728bde67bdb | 614 | /**< Data bit offset, relative to data alignment within the data frame */ |
Vkadaba | 8:2f2775c34640 | 615 | uint8_t reserved[2]; |
Vkadaba | 8:2f2775c34640 | 616 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 8:2f2775c34640 | 617 | |
Vkadaba | 8:2f2775c34640 | 618 | } ADMW1001_DIGITAL_SENSOR_DATA_FORMAT; |
Vkadaba | 5:0728bde67bdb | 619 | |
Vkadaba | 5:0728bde67bdb | 620 | /*! ADMW1001 digital sensor command |
Vkadaba | 5:0728bde67bdb | 621 | * |
Vkadaba | 5:0728bde67bdb | 622 | * @note applicable only to SPI and I2C digital sensor channels |
Vkadaba | 5:0728bde67bdb | 623 | */ |
Vkadaba | 8:2f2775c34640 | 624 | typedef struct |
Vkadaba | 8:2f2775c34640 | 625 | { |
Vkadaba | 5:0728bde67bdb | 626 | uint8_t command[ADMW1001_SENSOR_COMMAND_MAX_LENGTH]; |
Vkadaba | 5:0728bde67bdb | 627 | /*!< Optional command bytes to send to the device */ |
Vkadaba | 5:0728bde67bdb | 628 | uint8_t commandLength; |
Vkadaba | 5:0728bde67bdb | 629 | /*!< Number of valid command bytes. Set to 0 if unused */ |
Vkadaba | 8:2f2775c34640 | 630 | |
Vkadaba | 8:2f2775c34640 | 631 | } ADMW1001_DIGITAL_SENSOR_COMMAND; |
Vkadaba | 5:0728bde67bdb | 632 | |
Vkadaba | 5:0728bde67bdb | 633 | /*! ADMW1001 digital sensor calibration param |
Vkadaba | 5:0728bde67bdb | 634 | * |
Vkadaba | 5:0728bde67bdb | 635 | * @note applicable only to digital sensor channels |
Vkadaba | 5:0728bde67bdb | 636 | */ |
Vkadaba | 8:2f2775c34640 | 637 | typedef struct |
Vkadaba | 8:2f2775c34640 | 638 | { |
Vkadaba | 5:0728bde67bdb | 639 | uint32_t calibrationParam; |
Vkadaba | 5:0728bde67bdb | 640 | /*!< Independently established environmental variable used during calibration |
Vkadaba | 5:0728bde67bdb | 641 | * of a digital sensor. Used only if the sensor supports calibration |
Vkadaba | 5:0728bde67bdb | 642 | * and expects an environmental parameter |
Vkadaba | 5:0728bde67bdb | 643 | */ |
Vkadaba | 5:0728bde67bdb | 644 | bool enableCalibrationParam; |
Vkadaba | 5:0728bde67bdb | 645 | /*!< Allow Calibration_Parameter to be used during calibration of any digital sensor */ |
Vkadaba | 8:2f2775c34640 | 646 | uint8_t reserved[3]; |
Vkadaba | 8:2f2775c34640 | 647 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 8:2f2775c34640 | 648 | |
Vkadaba | 8:2f2775c34640 | 649 | } ADMW1001_DIGITAL_CALIBRATION_COMMAND; |
Vkadaba | 5:0728bde67bdb | 650 | |
Vkadaba | 5:0728bde67bdb | 651 | /*! ADMW1001 digital sensor communication config |
Vkadaba | 5:0728bde67bdb | 652 | * |
Vkadaba | 5:0728bde67bdb | 653 | * @note applicable only to digital sensor channels |
Vkadaba | 5:0728bde67bdb | 654 | */ |
Vkadaba | 8:2f2775c34640 | 655 | typedef struct |
Vkadaba | 8:2f2775c34640 | 656 | { |
Vkadaba | 8:2f2775c34640 | 657 | bool useCustomCommsConfig; |
Vkadaba | 5:0728bde67bdb | 658 | /*!< Optional parameter to enable user digital communication settings */ |
Vkadaba | 8:2f2775c34640 | 659 | ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED i2cClockSpeed; |
Vkadaba | 5:0728bde67bdb | 660 | /*!< Optional parameter to configure specific i2c speed for i2c sensor */ |
Vkadaba | 8:2f2775c34640 | 661 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_MODE spiMode; |
Vkadaba | 5:0728bde67bdb | 662 | /*!< Optional parameter to configure specific spi mode for spi sensor */ |
Vkadaba | 8:2f2775c34640 | 663 | ADMW1001_DIGITAL_SENSOR_COMMS_SPI_CLOCK spiClock; |
Vkadaba | 5:0728bde67bdb | 664 | /*!< Optional parameter to configure specific spi clock for spi sensor */ |
Vkadaba | 8:2f2775c34640 | 665 | |
Vkadaba | 8:2f2775c34640 | 666 | } ADMW1001_DIGITAL_SENSOR_COMMS; |
Vkadaba | 5:0728bde67bdb | 667 | |
Vkadaba | 5:0728bde67bdb | 668 | /*! ADMW1001 I2C digital channel configuration details |
Vkadaba | 5:0728bde67bdb | 669 | * |
Vkadaba | 5:0728bde67bdb | 670 | * @note applicable only to I2C digital sensor channels |
Vkadaba | 5:0728bde67bdb | 671 | */ |
Vkadaba | 8:2f2775c34640 | 672 | typedef struct |
Vkadaba | 8:2f2775c34640 | 673 | { |
Vkadaba | 8:2f2775c34640 | 674 | ADMW1001_I2C_SENSOR_TYPE sensor; |
Vkadaba | 5:0728bde67bdb | 675 | /*!< Sensor type selection */ |
Vkadaba | 8:2f2775c34640 | 676 | uint8_t deviceAddress; |
Vkadaba | 5:0728bde67bdb | 677 | /*!< I2C device address (7-bit) */ |
Vkadaba | 8:2f2775c34640 | 678 | uint8_t reserved; |
Vkadaba | 8:2f2775c34640 | 679 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 8:2f2775c34640 | 680 | ADMW1001_DIGITAL_SENSOR_COMMAND configurationCommand; |
Vkadaba | 5:0728bde67bdb | 681 | /*!< Optional configuration command to send to the device at start-up. |
Vkadaba | 5:0728bde67bdb | 682 | * A default configuration command will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 683 | * Applicable only to specific I2C sensor types. |
Vkadaba | 5:0728bde67bdb | 684 | */ |
Vkadaba | 8:2f2775c34640 | 685 | ADMW1001_DIGITAL_SENSOR_COMMAND dataRequestCommand; |
Vkadaba | 5:0728bde67bdb | 686 | /*!< Optional data request command to send to the device for each sample. |
Vkadaba | 5:0728bde67bdb | 687 | * A default data request command will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 688 | * Applicable only to specific I2C sensor types. |
Vkadaba | 5:0728bde67bdb | 689 | */ |
Vkadaba | 8:2f2775c34640 | 690 | ADMW1001_DIGITAL_SENSOR_DATA_FORMAT dataFormat; |
Vkadaba | 5:0728bde67bdb | 691 | /*!< Optional data format configuration to parse/extract data from the device. |
Vkadaba | 5:0728bde67bdb | 692 | * A default data format will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 693 | * Applicable only to specific I2C sensor types |
Vkadaba | 5:0728bde67bdb | 694 | */ |
Vkadaba | 8:2f2775c34640 | 695 | ADMW1001_DIGITAL_CALIBRATION_COMMAND digitalCalibrationParam; |
Vkadaba | 5:0728bde67bdb | 696 | /*!< This is used to supply an independently established environmental variable |
Vkadaba | 5:0728bde67bdb | 697 | * that must be used during calibration of a [digital] sensor which a) |
Vkadaba | 5:0728bde67bdb | 698 | * supports calibration and b) expects an environmental parameter. |
Vkadaba | 5:0728bde67bdb | 699 | * An example is a CO2 sensor, which may require the CO2 concentration level |
Vkadaba | 5:0728bde67bdb | 700 | * when performing a calibration |
Vkadaba | 5:0728bde67bdb | 701 | */ |
Vkadaba | 8:2f2775c34640 | 702 | ADMW1001_DIGITAL_SENSOR_COMMS configureComms; |
Vkadaba | 5:0728bde67bdb | 703 | /*!< Optional configuration to setup a user communication config. |
Vkadaba | 5:0728bde67bdb | 704 | * A default configuration will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 705 | * Applicable only to specific I2C sensor types. |
Vkadaba | 5:0728bde67bdb | 706 | */ |
Vkadaba | 8:2f2775c34640 | 707 | |
Vkadaba | 8:2f2775c34640 | 708 | } ADMW1001_I2C_CHANNEL_CONFIG; |
Vkadaba | 5:0728bde67bdb | 709 | |
Vkadaba | 5:0728bde67bdb | 710 | /*! ADMW1001 SPI digital channel configuration details |
Vkadaba | 5:0728bde67bdb | 711 | * |
Vkadaba | 5:0728bde67bdb | 712 | * @note applicable only to SPI digital sensor channels |
Vkadaba | 5:0728bde67bdb | 713 | */ |
Vkadaba | 8:2f2775c34640 | 714 | typedef struct |
Vkadaba | 8:2f2775c34640 | 715 | { |
Vkadaba | 5:0728bde67bdb | 716 | ADMW1001_SPI_SENSOR_TYPE sensor; |
Vkadaba | 5:0728bde67bdb | 717 | /*!< Sensor type selection */ |
Vkadaba | 8:2f2775c34640 | 718 | uint8_t reserved[2]; |
Vkadaba | 8:2f2775c34640 | 719 | /*!< Reserved for future use and ensure word alignment. */ |
Vkadaba | 5:0728bde67bdb | 720 | ADMW1001_DIGITAL_SENSOR_COMMAND configurationCommand; |
Vkadaba | 5:0728bde67bdb | 721 | /*!< Optional configuration command to send to the device at start-up. |
Vkadaba | 5:0728bde67bdb | 722 | * A default configuration command will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 723 | * Applicable only to specific SPI sensor types. |
Vkadaba | 5:0728bde67bdb | 724 | */ |
Vkadaba | 5:0728bde67bdb | 725 | ADMW1001_DIGITAL_SENSOR_COMMAND dataRequestCommand; |
Vkadaba | 5:0728bde67bdb | 726 | /*!< Optional data request command to send to the device for each sample. |
Vkadaba | 5:0728bde67bdb | 727 | * A default data request command will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 728 | * Applicable only to specific SPI sensor types. |
Vkadaba | 5:0728bde67bdb | 729 | */ |
Vkadaba | 5:0728bde67bdb | 730 | ADMW1001_DIGITAL_SENSOR_DATA_FORMAT dataFormat; |
Vkadaba | 5:0728bde67bdb | 731 | /*!< Optional data format configuration to parse/extract data from the device. |
Vkadaba | 5:0728bde67bdb | 732 | * A default data format will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 733 | * Applicable only to specific SPI sensor types |
Vkadaba | 5:0728bde67bdb | 734 | */ |
Vkadaba | 5:0728bde67bdb | 735 | ADMW1001_DIGITAL_CALIBRATION_COMMAND digitalCalibrationParam; |
Vkadaba | 5:0728bde67bdb | 736 | /*!< This is used to supply an independently established environmental variable |
Vkadaba | 5:0728bde67bdb | 737 | * that must be used during calibration of a [digital] sensor which a) |
Vkadaba | 5:0728bde67bdb | 738 | * supports calibration and b) expects an environmental parameter. |
Vkadaba | 5:0728bde67bdb | 739 | * An example is a CO2 sensor, which may require the CO2 concentration level |
Vkadaba | 5:0728bde67bdb | 740 | * when performing a calibration |
Vkadaba | 5:0728bde67bdb | 741 | */ |
Vkadaba | 8:2f2775c34640 | 742 | ADMW1001_DIGITAL_SENSOR_COMMS configureComms; |
Vkadaba | 5:0728bde67bdb | 743 | /*!< Optional configuration to setup a user communication config. |
Vkadaba | 5:0728bde67bdb | 744 | * A default configuration will be used if this is not specified. |
Vkadaba | 5:0728bde67bdb | 745 | * Applicable only to specific SPI sensor types. |
Vkadaba | 5:0728bde67bdb | 746 | */ |
Vkadaba | 5:0728bde67bdb | 747 | |
Vkadaba | 8:2f2775c34640 | 748 | } ADMW1001_SPI_CHANNEL_CONFIG; |
Vkadaba | 5:0728bde67bdb | 749 | |
Vkadaba | 5:0728bde67bdb | 750 | /*! ADMW1001 Measurement Channel configuration details */ |
Vkadaba | 8:2f2775c34640 | 751 | typedef struct |
Vkadaba | 8:2f2775c34640 | 752 | { |
Vkadaba | 8:2f2775c34640 | 753 | bool enableChannel; |
Vkadaba | 5:0728bde67bdb | 754 | /*!< Option to include this channel in normal measurement cycles */ |
Vkadaba | 8:2f2775c34640 | 755 | bool disablePublishing; |
Vkadaba | 5:0728bde67bdb | 756 | /*!< Option to disable publishing of data samples from this channel. The |
Vkadaba | 5:0728bde67bdb | 757 | * channel may still be included in measurement cycles, but data samples |
Vkadaba | 5:0728bde67bdb | 758 | * obtained from this channel will not be published. This is typically |
Vkadaba | 5:0728bde67bdb | 759 | * used for channels which are required only as a compensation reference |
Vkadaba | 5:0728bde67bdb | 760 | * for another channel (e.g. Cold-Junction Compensation channels). |
Vkadaba | 5:0728bde67bdb | 761 | */ |
Vkadaba | 8:2f2775c34640 | 762 | ADMW1001_CH_ID compensationChannel; |
Vkadaba | 8:2f2775c34640 | 763 | /*!< Optional compensation channel. Set to ADMW1001_CH_ID_NONE if not |
Vkadaba | 5:0728bde67bdb | 764 | * required. Typically used for thermocouple sensors that require a |
Vkadaba | 5:0728bde67bdb | 765 | * separate measurement of the "cold-junction" temperature, which can be |
Vkadaba | 5:0728bde67bdb | 766 | * be provided by an RTD temperature sensor connected on a separate |
Vkadaba | 5:0728bde67bdb | 767 | * "compensation channel" */ |
Vkadaba | 8:2f2775c34640 | 768 | ADMW1001_LUT_SELECT lutSelect; |
Vkadaba | 8:2f2775c34640 | 769 | /*!<Select Look Up Table LUT for calculations, this implies that the |
Vkadaba | 5:0728bde67bdb | 770 | * fundamental measurement for the sensor (typically mV or Ohms) |
Vkadaba | 8:2f2775c34640 | 771 | * 0 = default, 1= unity, 2 = custom |
Vkadaba | 5:0728bde67bdb | 772 | */ |
Vkadaba | 8:2f2775c34640 | 773 | ADMW1001_MEASUREMENT_UNIT measurementUnit; |
Vkadaba | 5:0728bde67bdb | 774 | /*!< Optional measurement unit selection for conversion results. Applicable |
Vkadaba | 5:0728bde67bdb | 775 | * only for certain sensor types. Set to |
Vkadaba | 5:0728bde67bdb | 776 | * ADMW1001_MEASUREMENT_UNIT_DEFAULT if not applicable. |
Vkadaba | 5:0728bde67bdb | 777 | */ |
Vkadaba | 8:2f2775c34640 | 778 | float32_t lowThreshold; |
Vkadaba | 5:0728bde67bdb | 779 | /*!< Optional minimum threshold value for each processed sample, to be |
Vkadaba | 5:0728bde67bdb | 780 | * checked prior to publishing. A channel ALERT condition is raised |
Vkadaba | 5:0728bde67bdb | 781 | * if the processed value is lower than this threshold. Set to NaN |
Vkadaba | 5:0728bde67bdb | 782 | * if not required. |
Vkadaba | 5:0728bde67bdb | 783 | */ |
Vkadaba | 8:2f2775c34640 | 784 | float32_t highThreshold; |
Vkadaba | 5:0728bde67bdb | 785 | /*!< Optional maximum threshold value for each processed sample, to be |
Vkadaba | 5:0728bde67bdb | 786 | * checked prior to publishing. A channel ALERT condition is raised |
Vkadaba | 5:0728bde67bdb | 787 | * if the processed value is higher than this threshold. Set to NaN |
Vkadaba | 5:0728bde67bdb | 788 | * if not required. |
Vkadaba | 5:0728bde67bdb | 789 | */ |
Vkadaba | 8:2f2775c34640 | 790 | float32_t offsetAdjustment; |
Vkadaba | 5:0728bde67bdb | 791 | /*!< Optional offset adjustment value applied to each processed sample. |
Vkadaba | 5:0728bde67bdb | 792 | * Set to NaN or 0.0 if not required. |
Vkadaba | 5:0728bde67bdb | 793 | */ |
Vkadaba | 8:2f2775c34640 | 794 | float32_t gainAdjustment; |
Vkadaba | 5:0728bde67bdb | 795 | /*!< Optional gain adjustment value applied to each processed sample. |
Vkadaba | 5:0728bde67bdb | 796 | * Set to NaN or 1.0 if not required. |
Vkadaba | 5:0728bde67bdb | 797 | */ |
Vkadaba | 8:2f2775c34640 | 798 | float32_t sensorParameter; |
Vkadaba | 5:0728bde67bdb | 799 | /*!< Optional sensor parameter adjustment. |
Vkadaba | 5:0728bde67bdb | 800 | * Set to NaN or 0 if not required. |
Vkadaba | 5:0728bde67bdb | 801 | */ |
Vkadaba | 8:2f2775c34640 | 802 | uint32_t measurementsPerCycle; |
Vkadaba | 5:0728bde67bdb | 803 | /*!< The number of measurements to obtain from this channel within each |
Vkadaba | 5:0728bde67bdb | 804 | * cycle. Each enabled channel is measured in turn, until the number of |
Vkadaba | 5:0728bde67bdb | 805 | * measurements requested for the channel has been reached. A different |
Vkadaba | 5:0728bde67bdb | 806 | * number of measurements-per-cycle may be specified for each channel. |
Vkadaba | 5:0728bde67bdb | 807 | */ |
Vkadaba | 8:2f2775c34640 | 808 | uint32_t cycleSkipCount; |
Vkadaba | 5:0728bde67bdb | 809 | /*!< Optional number of cycles to skip, such that this channel is included |
Vkadaba | 5:0728bde67bdb | 810 | * in the sequence in only one of every (cycleSkipCount + 1) cycles that |
Vkadaba | 5:0728bde67bdb | 811 | * occur. If set to 0 (default), this channel is included in every cycle; |
Vkadaba | 5:0728bde67bdb | 812 | * if set to 1, this channel is included in every 2nd cycle; if set to 2, |
Vkadaba | 5:0728bde67bdb | 813 | * this channel is included in every 3rd cycle, and so on. |
Vkadaba | 5:0728bde67bdb | 814 | */ |
Vkadaba | 8:2f2775c34640 | 815 | uint32_t extraSettlingTime; |
Vkadaba | 5:0728bde67bdb | 816 | /*!< A minimum settling time is applied internally for each channel, based |
Vkadaba | 5:0728bde67bdb | 817 | * on the sensor type. However, additional settling time (microseconds) |
Vkadaba | 5:0728bde67bdb | 818 | * can optionally be specified. Set to 0 if not required. |
Vkadaba | 5:0728bde67bdb | 819 | */ |
Vkadaba | 8:2f2775c34640 | 820 | ADMW1001_CHANNEL_PRIORITY priority; |
Vkadaba | 5:0728bde67bdb | 821 | /*!< By default, channels are arranged in the measurement sequence based on |
Vkadaba | 5:0728bde67bdb | 822 | * ascending order of channel ID. However, a priority-level may be |
Vkadaba | 5:0728bde67bdb | 823 | * specified per channel to force a different ordering of the channels, |
Vkadaba | 5:0728bde67bdb | 824 | * with higher-priority channels appearing before lower-priority channels. |
Vkadaba | 5:0728bde67bdb | 825 | * Channels with equal priority are ordered by ascending order of channel |
Vkadaba | 5:0728bde67bdb | 826 | * ID. Lower numbers indicate higher priority, with 0 being the highest. |
Vkadaba | 5:0728bde67bdb | 827 | * Set to 0 if not required. |
Vkadaba | 5:0728bde67bdb | 828 | */ |
Vkadaba | 8:2f2775c34640 | 829 | union |
Vkadaba | 8:2f2775c34640 | 830 | { |
Vkadaba | 8:2f2775c34640 | 831 | ADMW1001_ADC_CHANNEL_CONFIG adcChannelConfig; |
Vkadaba | 5:0728bde67bdb | 832 | /*!< ADC channel configuration - applicable only to ADC channels */ |
Vkadaba | 8:2f2775c34640 | 833 | ADMW1001_I2C_CHANNEL_CONFIG i2cChannelConfig; |
Vkadaba | 5:0728bde67bdb | 834 | /*!< I2C channel configuration - applicable only to I2C channels */ |
Vkadaba | 8:2f2775c34640 | 835 | ADMW1001_SPI_CHANNEL_CONFIG spiChannelConfig; |
Vkadaba | 5:0728bde67bdb | 836 | /*!< SPI channel configuration - applicable only to SPI channels */ |
Vkadaba | 5:0728bde67bdb | 837 | }; |
Vkadaba | 6:9d393a9677f4 | 838 | /*!< Only one of adcChannelConfig, i2cChannelConfig, spiChannelConfig |
Vkadaba | 6:9d393a9677f4 | 839 | * is required, depending on the channel designation |
Vkadaba | 6:9d393a9677f4 | 840 | * (analog, I2C, SPI) |
Vkadaba | 5:0728bde67bdb | 841 | */ |
Vkadaba | 8:2f2775c34640 | 842 | |
Vkadaba | 8:2f2775c34640 | 843 | } ADMW1001_CHANNEL_CONFIG; |
Vkadaba | 5:0728bde67bdb | 844 | |
Vkadaba | 5:0728bde67bdb | 845 | /*! ADMW1001 Diagnostics configuration details */ |
Vkadaba | 8:2f2775c34640 | 846 | typedef struct |
Vkadaba | 8:2f2775c34640 | 847 | { |
Vkadaba | 8:2f2775c34640 | 848 | bool disableGlobalDiag; |
Vkadaba | 5:0728bde67bdb | 849 | /*!< Option to disable the following diagnostic checks on the ADC: |
Vkadaba | 5:0728bde67bdb | 850 | * - Reference Detection errors |
Vkadaba | 5:0728bde67bdb | 851 | * - Input under-/over-voltage errors |
Vkadaba | 5:0728bde67bdb | 852 | * - Calibration, Conversion and Saturation errors |
Vkadaba | 5:0728bde67bdb | 853 | */ |
Vkadaba | 8:2f2775c34640 | 854 | bool disableMeasurementDiag; |
Vkadaba | 5:0728bde67bdb | 855 | /*!< Option to disable additional checks per measurement channel: |
Vkadaba | 5:0728bde67bdb | 856 | * - High/low threshold limit violation |
Vkadaba | 5:0728bde67bdb | 857 | */ |
Vkadaba | 8:2f2775c34640 | 858 | |
Vkadaba | 8:2f2775c34640 | 859 | bool disableCriticalTempAbort; |
Vkadaba | 5:0728bde67bdb | 860 | /*!< Option to disable abort of measurement cycle if the operating |
Vkadaba | 5:0728bde67bdb | 861 | * temperature of the ADMW1001 has exceeded critical limits |
Vkadaba | 5:0728bde67bdb | 862 | */ |
Vkadaba | 8:2f2775c34640 | 863 | |
Vkadaba | 8:2f2775c34640 | 864 | ADMW1001_OPEN_SENSOR_DIAGNOSTICS osdFrequency; |
Vkadaba | 5:0728bde67bdb | 865 | /*!< Option to enable Open-Circuit Detection at a selected cycle interval */ |
Vkadaba | 5:0728bde67bdb | 866 | |
Vkadaba | 8:2f2775c34640 | 867 | } ADMW1001_DIAGNOSTICS_CONFIG; |
Vkadaba | 8:2f2775c34640 | 868 | |
Vkadaba | 5:0728bde67bdb | 869 | typedef uint16_t ADMW1001_ADVANCED_ACCESS_KEY; |
Vkadaba | 5:0728bde67bdb | 870 | |
Vkadaba | 5:0728bde67bdb | 871 | /*! ADMW1001 Device configuration details */ |
Vkadaba | 8:2f2775c34640 | 872 | typedef struct |
Vkadaba | 8:2f2775c34640 | 873 | { |
Vkadaba | 5:0728bde67bdb | 874 | ADMW1001_POWER_CONFIG power; |
Vkadaba | 5:0728bde67bdb | 875 | /*!< Power configuration details */ |
Vkadaba | 5:0728bde67bdb | 876 | ADMW1001_MEASUREMENT_CONFIG measurement; |
Vkadaba | 5:0728bde67bdb | 877 | /*!< Measurement configuration details */ |
Vkadaba | 5:0728bde67bdb | 878 | ADMW1001_DIAGNOSTICS_CONFIG diagnostics; |
Vkadaba | 5:0728bde67bdb | 879 | /*!< FFT configuration details */ |
Vkadaba | 5:0728bde67bdb | 880 | ADMW1001_CHANNEL_CONFIG channels[ADMW1001_MAX_CHANNELS]; |
Vkadaba | 5:0728bde67bdb | 881 | /*!< Channel-specific configuration details */ |
Vkadaba | 5:0728bde67bdb | 882 | ADMW1001_ADVANCED_ACCESS_KEY advancedAccessKey; |
Vkadaba | 5:0728bde67bdb | 883 | /*!< Key to enable access to advanced sensor configuration options */ |
Vkadaba | 8:2f2775c34640 | 884 | |
Vkadaba | 8:2f2775c34640 | 885 | } ADMW1001_CONFIG; |
Vkadaba | 5:0728bde67bdb | 886 | |
Vkadaba | 5:0728bde67bdb | 887 | #ifdef __cplusplus |
Vkadaba | 5:0728bde67bdb | 888 | } |
Vkadaba | 5:0728bde67bdb | 889 | #endif |
Vkadaba | 5:0728bde67bdb | 890 | |
Vkadaba | 5:0728bde67bdb | 891 | /*! |
Vkadaba | 5:0728bde67bdb | 892 | * @} |
Vkadaba | 5:0728bde67bdb | 893 | */ |
Vkadaba | 5:0728bde67bdb | 894 | |
Vkadaba | 5:0728bde67bdb | 895 | #endif /* __ADMW1001_CONFIG_H__ */ |