Analog Devices / mbed-drivers

A collection of Analog Devices drivers for the mbed platform

For additional information check out the mbed page of the Analog Devices wiki: https://wiki.analog.com/resources/tools-software/mbed-drivers-all

libraries/cn0357/CN0357.cpp@19:fb92949e59c9, 2016-05-17 (annotated)

Committer:
Adrian Suciu
Date:
Tue May 17 14:21:17 2016 +0300
Revision:
19:fb92949e59c9
Added ADXL362 driver & reference project

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Adrian Suciu 19:fb92949e59c9 1 /**
Adrian Suciu 19:fb92949e59c9 2 * @file cn0357.cpp
Adrian Suciu 19:fb92949e59c9 3 * @brief Source file for CN0357
Adrian Suciu 19:fb92949e59c9 4 * @author Analog Devices Inc.
Adrian Suciu 19:fb92949e59c9 5 *
Adrian Suciu 19:fb92949e59c9 6 * For support please go to:
Adrian Suciu 19:fb92949e59c9 7 * Github: https://github.com/analogdevicesinc/mbed-adi
Adrian Suciu 19:fb92949e59c9 8 * Support: https://ez.analog.com/community/linux-device-drivers/microcontroller-no-os-drivers
Adrian Suciu 19:fb92949e59c9 9 * Product: www.analog.com/EVAL-CN0357-ARDZ
Adrian Suciu 19:fb92949e59c9 10 * More: https://wiki.analog.com/resources/tools-software/mbed-drivers-all
Adrian Suciu 19:fb92949e59c9 11
Adrian Suciu 19:fb92949e59c9 12 ********************************************************************************
Adrian Suciu 19:fb92949e59c9 13 * Copyright 2016(c) Analog Devices, Inc.
Adrian Suciu 19:fb92949e59c9 14 *
Adrian Suciu 19:fb92949e59c9 15 * All rights reserved.
Adrian Suciu 19:fb92949e59c9 16 *
Adrian Suciu 19:fb92949e59c9 17 * Redistribution and use in source and binary forms, with or without
Adrian Suciu 19:fb92949e59c9 18 * modification, are permitted provided that the following conditions are met:
Adrian Suciu 19:fb92949e59c9 19 * - Redistributions of source code must retain the above copyright
Adrian Suciu 19:fb92949e59c9 20 * notice, this list of conditions and the following disclaimer.
Adrian Suciu 19:fb92949e59c9 21 * - Redistributions in binary form must reproduce the above copyright
Adrian Suciu 19:fb92949e59c9 22 * notice, this list of conditions and the following disclaimer in
Adrian Suciu 19:fb92949e59c9 23 * the documentation and/or other materials provided with the
Adrian Suciu 19:fb92949e59c9 24 * distribution.
Adrian Suciu 19:fb92949e59c9 25 * - Neither the name of Analog Devices, Inc. nor the names of its
Adrian Suciu 19:fb92949e59c9 26 * contributors may be used to endorse or promote products derived
Adrian Suciu 19:fb92949e59c9 27 * from this software without specific prior written permission.
Adrian Suciu 19:fb92949e59c9 28 * - The use of this software may or may not infringe the patent rights
Adrian Suciu 19:fb92949e59c9 29 * of one or more patent holders. This license does not release you
Adrian Suciu 19:fb92949e59c9 30 * from the requirement that you obtain separate licenses from these
Adrian Suciu 19:fb92949e59c9 31 * patent holders to use this software.
Adrian Suciu 19:fb92949e59c9 32 * - Use of the software either in source or binary form, must be run
Adrian Suciu 19:fb92949e59c9 33 * on or directly connected to an Analog Devices Inc. component.
Adrian Suciu 19:fb92949e59c9 34 *
Adrian Suciu 19:fb92949e59c9 35 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
Adrian Suciu 19:fb92949e59c9 36 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
Adrian Suciu 19:fb92949e59c9 37 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Adrian Suciu 19:fb92949e59c9 38 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
Adrian Suciu 19:fb92949e59c9 39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Adrian Suciu 19:fb92949e59c9 40 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
Adrian Suciu 19:fb92949e59c9 41 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Adrian Suciu 19:fb92949e59c9 42 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Adrian Suciu 19:fb92949e59c9 43 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Adrian Suciu 19:fb92949e59c9 44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Adrian Suciu 19:fb92949e59c9 45 *
Adrian Suciu 19:fb92949e59c9 46 ********************************************************************************/
Adrian Suciu 19:fb92949e59c9 47
Adrian Suciu 19:fb92949e59c9 48 #include "mbed.h"
Adrian Suciu 19:fb92949e59c9 49 #include "AD7790.h"
Adrian Suciu 19:fb92949e59c9 50 #include "AD5270.h"
Adrian Suciu 19:fb92949e59c9 51 #include "CN0357.h"
Adrian Suciu 19:fb92949e59c9 52
Adrian Suciu 19:fb92949e59c9 53 /**
Adrian Suciu 19:fb92949e59c9 54 * @brief CN0357 constructor
Adrian Suciu 19:fb92949e59c9 55 * @param CSAD7790 - (optional)chip select of the AD7790
Adrian Suciu 19:fb92949e59c9 56 * @param CSAD5270 - (optional)chip select of the AD5270
Adrian Suciu 19:fb92949e59c9 57 * @param MOSI - (optional)pin of the SPI interface
Adrian Suciu 19:fb92949e59c9 58 * @param MISO - (optional)pin of the SPI interface
Adrian Suciu 19:fb92949e59c9 59 * @param SCK - (optional)pin of the SPI interface
Adrian Suciu 19:fb92949e59c9 60 */
Adrian Suciu 19:fb92949e59c9 61 CN0357::CN0357(PinName CSAD7790, PinName CSAD5270, PinName MOSI, PinName MISO,
Adrian Suciu 19:fb92949e59c9 62 PinName SCK) :
Adrian Suciu 19:fb92949e59c9 63 _vref(1.2), _sensor_sensitivity(0), _sensor_range(0), _RDACvalue(0),
Adrian Suciu 19:fb92949e59c9 64 ad7790(_vref, CSAD7790, MOSI, MISO, SCK), ad5270(CSAD5270, 20000.0, MOSI, MISO, SCK)
Adrian Suciu 19:fb92949e59c9 65
Adrian Suciu 19:fb92949e59c9 66 {
Adrian Suciu 19:fb92949e59c9 67 }
Adrian Suciu 19:fb92949e59c9 68
Adrian Suciu 19:fb92949e59c9 69 /**
Adrian Suciu 19:fb92949e59c9 70 * @brief initializes the AD7790 and the AD5270
Adrian Suciu 19:fb92949e59c9 71 * @param range - range of the sensor used (in ppm)
Adrian Suciu 19:fb92949e59c9 72 * @param sensitivity - sensitivity of the sensor (A/ppm)
Adrian Suciu 19:fb92949e59c9 73 * @param jp - (optional)jumper configuration of the CN0357
Adrian Suciu 19:fb92949e59c9 74 * @param mode_val - (optional)if jp is set to InternalADC, configures the mode register of the Internal ADC
Adrian Suciu 19:fb92949e59c9 75 * @param filter_val - (optional)if jp is set to InternalADC, configures the filter register of the Internal ADC
Adrian Suciu 19:fb92949e59c9 76 */
Adrian Suciu 19:fb92949e59c9 77 void CN0357::init(float range, float sensitivity, JumperConfig_t jp, uint8_t mode_val, uint8_t filter_val)
Adrian Suciu 19:fb92949e59c9 78 {
Adrian Suciu 19:fb92949e59c9 79 ad5270.frequency(500000);
Adrian Suciu 19:fb92949e59c9 80 ad7790.frequency(500000);
Adrian Suciu 19:fb92949e59c9 81
Adrian Suciu 19:fb92949e59c9 82 float resistance = set_sensor_parameters(range, sensitivity);
Adrian Suciu 19:fb92949e59c9 83
Adrian Suciu 19:fb92949e59c9 84 if(jp == INTERNAL_AD7790) {
Adrian Suciu 19:fb92949e59c9 85 _AD7790_init(mode_val, filter_val);
Adrian Suciu 19:fb92949e59c9 86 }
Adrian Suciu 19:fb92949e59c9 87 _rdac_init(resistance);
Adrian Suciu 19:fb92949e59c9 88 }
Adrian Suciu 19:fb92949e59c9 89
Adrian Suciu 19:fb92949e59c9 90 /**
Adrian Suciu 19:fb92949e59c9 91 * @brief initializes the RDAC and sets SDO to HiZ
Adrian Suciu 19:fb92949e59c9 92 * @param resistance - resistance value to initialize the RDAC
Adrian Suciu 19:fb92949e59c9 93 * @return
Adrian Suciu 19:fb92949e59c9 94 */
Adrian Suciu 19:fb92949e59c9 95 void CN0357::_rdac_init(float resistance)
Adrian Suciu 19:fb92949e59c9 96 {
Adrian Suciu 19:fb92949e59c9 97 /* RDAC initialization*/
Adrian Suciu 19:fb92949e59c9 98 /* Compute for the nearest RDAC value from given resistance and save data to the structure */
Adrian Suciu 19:fb92949e59c9 99 set_RDAC_value(resistance);
Adrian Suciu 19:fb92949e59c9 100 /* Set AD5270 SDO to Hi-Z */
Adrian Suciu 19:fb92949e59c9 101 ad5270.set_SDO_HiZ();
Adrian Suciu 19:fb92949e59c9 102 }
Adrian Suciu 19:fb92949e59c9 103
Adrian Suciu 19:fb92949e59c9 104 /**
Adrian Suciu 19:fb92949e59c9 105 * @brief initializes the AD7790
Adrian Suciu 19:fb92949e59c9 106 * @param mode_val - configures the mode register of the Internal ADC
Adrian Suciu 19:fb92949e59c9 107 * @param filter_val - configures the filter register of the Internal ADC
Adrian Suciu 19:fb92949e59c9 108 */
Adrian Suciu 19:fb92949e59c9 109 void CN0357::_AD7790_init(uint8_t mode_val, uint8_t filter_val)
Adrian Suciu 19:fb92949e59c9 110 {
Adrian Suciu 19:fb92949e59c9 111 ad7790.reset();
Adrian Suciu 19:fb92949e59c9 112 wait_ms(50);
Adrian Suciu 19:fb92949e59c9 113
Adrian Suciu 19:fb92949e59c9 114 ad7790.write_mode_reg(mode_val);
Adrian Suciu 19:fb92949e59c9 115 wait_us(2);
Adrian Suciu 19:fb92949e59c9 116
Adrian Suciu 19:fb92949e59c9 117 ad7790.write_filter_reg(filter_val);
Adrian Suciu 19:fb92949e59c9 118 wait_ms(50);
Adrian Suciu 19:fb92949e59c9 119 }
Adrian Suciu 19:fb92949e59c9 120
Adrian Suciu 19:fb92949e59c9 121 /**
Adrian Suciu 19:fb92949e59c9 122 * @brief reads the status register of the AD7790
Adrian Suciu 19:fb92949e59c9 123 * @return status register value
Adrian Suciu 19:fb92949e59c9 124 */
Adrian Suciu 19:fb92949e59c9 125 uint8_t CN0357::read_adc_status(void)
Adrian Suciu 19:fb92949e59c9 126 {
Adrian Suciu 19:fb92949e59c9 127 return ad7790.read_status_reg();
Adrian Suciu 19:fb92949e59c9 128 }
Adrian Suciu 19:fb92949e59c9 129
Adrian Suciu 19:fb92949e59c9 130 /**
Adrian Suciu 19:fb92949e59c9 131 * @brief reads the ADC and computes the sensor voltage
Adrian Suciu 19:fb92949e59c9 132 * @return sensor voltage
Adrian Suciu 19:fb92949e59c9 133 */
Adrian Suciu 19:fb92949e59c9 134 float CN0357::read_sensor_voltage(void)
Adrian Suciu 19:fb92949e59c9 135 {
Adrian Suciu 19:fb92949e59c9 136 return ad7790.read_voltage();
Adrian Suciu 19:fb92949e59c9 137 }
Adrian Suciu 19:fb92949e59c9 138
Adrian Suciu 19:fb92949e59c9 139 /**
Adrian Suciu 19:fb92949e59c9 140 * @brief reads the data register of the AD7790
Adrian Suciu 19:fb92949e59c9 141 * @return data register value
Adrian Suciu 19:fb92949e59c9 142 */
Adrian Suciu 19:fb92949e59c9 143 uint16_t CN0357::read_sensor(void)
Adrian Suciu 19:fb92949e59c9 144 {
Adrian Suciu 19:fb92949e59c9 145 return ad7790.read_u16();
Adrian Suciu 19:fb92949e59c9 146 }
Adrian Suciu 19:fb92949e59c9 147
Adrian Suciu 19:fb92949e59c9 148 /**
Adrian Suciu 19:fb92949e59c9 149 * @brief reads and computes the sensor reading in PPM
Adrian Suciu 19:fb92949e59c9 150 * @return value of the sensor reading in PPM
Adrian Suciu 19:fb92949e59c9 151 */
Adrian Suciu 19:fb92949e59c9 152 float CN0357::read_ppm()
Adrian Suciu 19:fb92949e59c9 153 {
Adrian Suciu 19:fb92949e59c9 154 return calc_ppm(ad7790.read_voltage()); /* Convert voltage to Gas concentration*/
Adrian Suciu 19:fb92949e59c9 155 }
Adrian Suciu 19:fb92949e59c9 156
Adrian Suciu 19:fb92949e59c9 157 /**
Adrian Suciu 19:fb92949e59c9 158 * @brief computes a value in PPM from a reading received as a param
Adrian Suciu 19:fb92949e59c9 159 * @param adcVoltage - voltage to be converted to PPM
Adrian Suciu 19:fb92949e59c9 160 * @return sensor value in PPM
Adrian Suciu 19:fb92949e59c9 161 */
Adrian Suciu 19:fb92949e59c9 162 float CN0357::calc_ppm(float adcVoltage)
Adrian Suciu 19:fb92949e59c9 163 {
Adrian Suciu 19:fb92949e59c9 164 float fConcentration = 0;
Adrian Suciu 19:fb92949e59c9 165 fConcentration = (fabs(adcVoltage) / _RDACvalue) / _sensor_sensitivity;
Adrian Suciu 19:fb92949e59c9 166 return fConcentration;
Adrian Suciu 19:fb92949e59c9 167 }
Adrian Suciu 19:fb92949e59c9 168
Adrian Suciu 19:fb92949e59c9 169 /**
Adrian Suciu 19:fb92949e59c9 170 * @brief computes voltage from a 16 bit ADC value received as a parameter
Adrian Suciu 19:fb92949e59c9 171 * @param data - ADC value
Adrian Suciu 19:fb92949e59c9 172 * @return sensor voltage
Adrian Suciu 19:fb92949e59c9 173 */
Adrian Suciu 19:fb92949e59c9 174 float CN0357::data_to_voltage(uint16_t data)
Adrian Suciu 19:fb92949e59c9 175 {
Adrian Suciu 19:fb92949e59c9 176 return ad7790.data_to_voltage(data);
Adrian Suciu 19:fb92949e59c9 177 }
Adrian Suciu 19:fb92949e59c9 178
Adrian Suciu 19:fb92949e59c9 179 /**
Adrian Suciu 19:fb92949e59c9 180 * @brief sets a new value for the RDAC
Adrian Suciu 19:fb92949e59c9 181 * @param resistance new value for the resistance
Adrian Suciu 19:fb92949e59c9 182 * @return none
Adrian Suciu 19:fb92949e59c9 183 */
Adrian Suciu 19:fb92949e59c9 184 void CN0357::set_RDAC_value(float resistance)
Adrian Suciu 19:fb92949e59c9 185 {
Adrian Suciu 19:fb92949e59c9 186 _RDACvalue = ad5270.write_RDAC(resistance);
Adrian Suciu 19:fb92949e59c9 187 }
Adrian Suciu 19:fb92949e59c9 188
Adrian Suciu 19:fb92949e59c9 189 /**
Adrian Suciu 19:fb92949e59c9 190 * @brief getter method for RDAC value
Adrian Suciu 19:fb92949e59c9 191 * @return value of the RDAC in ohms
Adrian Suciu 19:fb92949e59c9 192 */
Adrian Suciu 19:fb92949e59c9 193 float CN0357::get_RDAC_value()
Adrian Suciu 19:fb92949e59c9 194 {
Adrian Suciu 19:fb92949e59c9 195 return _RDACvalue;
Adrian Suciu 19:fb92949e59c9 196 }
Adrian Suciu 19:fb92949e59c9 197
Adrian Suciu 19:fb92949e59c9 198 /**
Adrian Suciu 19:fb92949e59c9 199 * @brief set sensor range and sensitivity
Adrian Suciu 19:fb92949e59c9 200 * sets sensor range, sensitivity
Adrian Suciu 19:fb92949e59c9 201 * returns suggested resistance value for feedback resistor
Adrian Suciu 19:fb92949e59c9 202 * @param range - range of the sensor used (in ppm)
Adrian Suciu 19:fb92949e59c9 203 * @param sensitivity - sensitivity of the sensor (in A/ppm)
Adrian Suciu 19:fb92949e59c9 204 * @return suggested resistance value for feedback resistor
Adrian Suciu 19:fb92949e59c9 205 */
Adrian Suciu 19:fb92949e59c9 206 float CN0357::set_sensor_parameters(float range, float sensitivity)
Adrian Suciu 19:fb92949e59c9 207 {
Adrian Suciu 19:fb92949e59c9 208 _sensor_sensitivity = static_cast<float>(sensitivity);
Adrian Suciu 19:fb92949e59c9 209 _sensor_range = range;
Adrian Suciu 19:fb92949e59c9 210 return (_vref / (static_cast<float>(_sensor_range * _sensor_sensitivity)));
Adrian Suciu 19:fb92949e59c9 211 }
Adrian Suciu 19:fb92949e59c9 212
Adrian Suciu 19:fb92949e59c9 213 /**
Adrian Suciu 19:fb92949e59c9 214 * @brief getter method for sensor sensitivity
Adrian Suciu 19:fb92949e59c9 215 * @return sensor sensitivity (in A/ppm)
Adrian Suciu 19:fb92949e59c9 216 */
Adrian Suciu 19:fb92949e59c9 217 float CN0357::get_sensor_sensitivity()
Adrian Suciu 19:fb92949e59c9 218 {
Adrian Suciu 19:fb92949e59c9 219 return _sensor_sensitivity;
Adrian Suciu 19:fb92949e59c9 220 }
Adrian Suciu 19:fb92949e59c9 221
Adrian Suciu 19:fb92949e59c9 222 /**
Adrian Suciu 19:fb92949e59c9 223 * @brief getter method for sensor range
Adrian Suciu 19:fb92949e59c9 224 * @return sensor range (in ppm)
Adrian Suciu 19:fb92949e59c9 225 */
Adrian Suciu 19:fb92949e59c9 226 float CN0357::get_sensor_range()
Adrian Suciu 19:fb92949e59c9 227 {
Adrian Suciu 19:fb92949e59c9 228 return _sensor_range;
Adrian Suciu 19:fb92949e59c9 229 }