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/CN0397/CN0397.h@33:c3ec596a29c2, 2016-11-07 (annotated)

Committer:
Adrian Suciu
Date:
Mon Nov 07 16:27:12 2016 +0200
Revision:
33:c3ec596a29c2
Added CN0391, CN0396 and CN0397 shields

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Adrian Suciu 33:c3ec596a29c2 1 /**
Adrian Suciu 33:c3ec596a29c2 2 * @file CN0397.cpp
Adrian Suciu 33:c3ec596a29c2 3 * @brief Header file for the CN0397
Adrian Suciu 33:c3ec596a29c2 4 * @author Analog Devices Inc.
Adrian Suciu 33:c3ec596a29c2 5 *
Adrian Suciu 33:c3ec596a29c2 6 * For support please go to:
Adrian Suciu 33:c3ec596a29c2 7 * Github: https://github.com/analogdevicesinc/mbed-adi
Adrian Suciu 33:c3ec596a29c2 8 * Support: https://ez.analog.com/community/linux-device-drivers/microcontroller-no-os-drivers
Adrian Suciu 33:c3ec596a29c2 9 * Product: www.analog.com/EVAL-CN0397-ARDZ
Adrian Suciu 33:c3ec596a29c2 10 * More: https://wiki.analog.com/resources/tools-software/mbed-drivers-all
Adrian Suciu 33:c3ec596a29c2 11
Adrian Suciu 33:c3ec596a29c2 12 ********************************************************************************
Adrian Suciu 33:c3ec596a29c2 13 * Copyright 2016(c) Analog Devices, Inc.
Adrian Suciu 33:c3ec596a29c2 14 *
Adrian Suciu 33:c3ec596a29c2 15 * All rights reserved.
Adrian Suciu 33:c3ec596a29c2 16 *
Adrian Suciu 33:c3ec596a29c2 17 * Redistribution and use in source and binary forms, with or without
Adrian Suciu 33:c3ec596a29c2 18 * modification, are permitted provided that the following conditions are met:
Adrian Suciu 33:c3ec596a29c2 19 * - Redistributions of source code must retain the above copyright
Adrian Suciu 33:c3ec596a29c2 20 * notice, this list of conditions and the following disclaimer.
Adrian Suciu 33:c3ec596a29c2 21 * - Redistributions in binary form must reproduce the above copyright
Adrian Suciu 33:c3ec596a29c2 22 * notice, this list of conditions and the following disclaimer in
Adrian Suciu 33:c3ec596a29c2 23 * the documentation and/or other materials provided with the
Adrian Suciu 33:c3ec596a29c2 24 * distribution.
Adrian Suciu 33:c3ec596a29c2 25 * - Neither the name of Analog Devices, Inc. nor the names of its
Adrian Suciu 33:c3ec596a29c2 26 * contributors may be used to endorse or promote products derived
Adrian Suciu 33:c3ec596a29c2 27 * from this software without specific prior written permission.
Adrian Suciu 33:c3ec596a29c2 28 * - The use of this software may or may not infringe the patent rights
Adrian Suciu 33:c3ec596a29c2 29 * of one or more patent holders. This license does not release you
Adrian Suciu 33:c3ec596a29c2 30 * from the requirement that you obtain separate licenses from these
Adrian Suciu 33:c3ec596a29c2 31 * patent holders to use this software.
Adrian Suciu 33:c3ec596a29c2 32 * - Use of the software either in source or binary form, must be run
Adrian Suciu 33:c3ec596a29c2 33 * on or directly connected to an Analog Devices Inc. component.
Adrian Suciu 33:c3ec596a29c2 34 *
Adrian Suciu 33:c3ec596a29c2 35 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
Adrian Suciu 33:c3ec596a29c2 36 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
Adrian Suciu 33:c3ec596a29c2 37 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Adrian Suciu 33:c3ec596a29c2 38 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
Adrian Suciu 33:c3ec596a29c2 39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Adrian Suciu 33:c3ec596a29c2 40 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
Adrian Suciu 33:c3ec596a29c2 41 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Adrian Suciu 33:c3ec596a29c2 42 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Adrian Suciu 33:c3ec596a29c2 43 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Adrian Suciu 33:c3ec596a29c2 44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Adrian Suciu 33:c3ec596a29c2 45 *
Adrian Suciu 33:c3ec596a29c2 46 ********************************************************************************/
Adrian Suciu 33:c3ec596a29c2 47
Adrian Suciu 33:c3ec596a29c2 48 #ifndef CN0397_H_
Adrian Suciu 33:c3ec596a29c2 49 #define CN0397_H_
Adrian Suciu 33:c3ec596a29c2 50
Adrian Suciu 33:c3ec596a29c2 51 #include <stdio.h>
Adrian Suciu 33:c3ec596a29c2 52 #include <string.h>
Adrian Suciu 33:c3ec596a29c2 53 #include "AD7798.h"
Adrian Suciu 33:c3ec596a29c2 54
Adrian Suciu 33:c3ec596a29c2 55 #define REGISTERS_VALUES 3
Adrian Suciu 33:c3ec596a29c2 56 #define CONVERSION_DATA 4
Adrian Suciu 33:c3ec596a29c2 57
Adrian Suciu 33:c3ec596a29c2 58 #define V_REF 3150.0 // [mV]
Adrian Suciu 33:c3ec596a29c2 59 #define _2_16 65535.0 // 2^16
Adrian Suciu 33:c3ec596a29c2 60
Adrian Suciu 33:c3ec596a29c2 61
Adrian Suciu 33:c3ec596a29c2 62 /* Available settings:
Adrian Suciu 33:c3ec596a29c2 63 * AD7798_CH_AIN1P_AIN1M - select channel 1
Adrian Suciu 33:c3ec596a29c2 64 * AD7798_CH_AIN2P_AIN2M - select channel 2
Adrian Suciu 33:c3ec596a29c2 65 * AD7798_CH_AIN3P_AIN3M - select channel 3
Adrian Suciu 33:c3ec596a29c2 66 */
Adrian Suciu 33:c3ec596a29c2 67 #define ADC_CHANNEL AD7798_CH_AIN2P_AIN2M
Adrian Suciu 33:c3ec596a29c2 68
Adrian Suciu 33:c3ec596a29c2 69 /* Available settings:
Adrian Suciu 33:c3ec596a29c2 70 * AD7798_GAIN_1, AD7798_GAIN_2,
Adrian Suciu 33:c3ec596a29c2 71 * AD7798_GAIN_4, AD7798_GAIN_8,
Adrian Suciu 33:c3ec596a29c2 72 * AD7798_GAIN_16, AD7798_GAIN_32,
Adrian Suciu 33:c3ec596a29c2 73 * AD7798_GAIN_64, AD7798_GAIN_128
Adrian Suciu 33:c3ec596a29c2 74 */
Adrian Suciu 33:c3ec596a29c2 75 #define ADC_GAIN AD7798_GAIN_1
Adrian Suciu 33:c3ec596a29c2 76 /* Available settings:
Adrian Suciu 33:c3ec596a29c2 77 * Check available value from datasheet
Adrian Suciu 33:c3ec596a29c2 78 */
Adrian Suciu 33:c3ec596a29c2 79 #define ADC_SPS 0x05 /*50SPS*/
Adrian Suciu 33:c3ec596a29c2 80
Adrian Suciu 33:c3ec596a29c2 81
Adrian Suciu 33:c3ec596a29c2 82 /* Available settings:
Adrian Suciu 33:c3ec596a29c2 83 * How often to display output values on terminal -> msec
Adrian Suciu 33:c3ec596a29c2 84 */
Adrian Suciu 33:c3ec596a29c2 85 #define DISPLAY_REFRESH 1000 /*[msec]*/
Adrian Suciu 33:c3ec596a29c2 86
Adrian Suciu 33:c3ec596a29c2 87 #define CHANNELS 3
Adrian Suciu 33:c3ec596a29c2 88
Adrian Suciu 33:c3ec596a29c2 89
Adrian Suciu 33:c3ec596a29c2 90 #define USE_CALIBRATION /* Select if you want to use system zero-scale calibration before reading the system data*/
Adrian Suciu 33:c3ec596a29c2 91 /**
Adrian Suciu 33:c3ec596a29c2 92 * Helper function used to flush the serial interface
Adrian Suciu 33:c3ec596a29c2 93 */
Adrian Suciu 33:c3ec596a29c2 94 void flush_serial();
Adrian Suciu 33:c3ec596a29c2 95
Adrian Suciu 33:c3ec596a29c2 96 /**
Adrian Suciu 33:c3ec596a29c2 97 * @brief The CN0397 shield class
Adrian Suciu 33:c3ec596a29c2 98 */
Adrian Suciu 33:c3ec596a29c2 99 class CN0397
Adrian Suciu 33:c3ec596a29c2 100 {
Adrian Suciu 33:c3ec596a29c2 101 public:
Adrian Suciu 33:c3ec596a29c2 102 /**
Adrian Suciu 33:c3ec596a29c2 103 * @brief The CN0397 class constructor
Adrian Suciu 33:c3ec596a29c2 104 */
Adrian Suciu 33:c3ec596a29c2 105 CN0397(PinName cs);
Adrian Suciu 33:c3ec596a29c2 106 /**
Adrian Suciu 33:c3ec596a29c2 107 * @brief Initialization method of the class. Initializes the AD7798 and initiates calibration if needed
Adrian Suciu 33:c3ec596a29c2 108 */
Adrian Suciu 33:c3ec596a29c2 109 void init(void);
Adrian Suciu 33:c3ec596a29c2 110
Adrian Suciu 33:c3ec596a29c2 111 /**
Adrian Suciu 33:c3ec596a29c2 112 * @brief Displays data on the serial interface
Adrian Suciu 33:c3ec596a29c2 113 */
Adrian Suciu 33:c3ec596a29c2 114 void display_data(void);
Adrian Suciu 33:c3ec596a29c2 115
Adrian Suciu 33:c3ec596a29c2 116 /**
Adrian Suciu 33:c3ec596a29c2 117 * @brief Converts ADC counts to voltage
Adrian Suciu 33:c3ec596a29c2 118 * @param adcValue - ADC counts
Adrian Suciu 33:c3ec596a29c2 119 * @param voltage - computed voltage
Adrian Suciu 33:c3ec596a29c2 120 */
Adrian Suciu 33:c3ec596a29c2 121 void data_to_voltage(uint16_t adcValue, float *voltage);
Adrian Suciu 33:c3ec596a29c2 122
Adrian Suciu 33:c3ec596a29c2 123 /**
Adrian Suciu 33:c3ec596a29c2 124 * @brief Computes light intensity of the channel
Adrian Suciu 33:c3ec596a29c2 125 * @param channel - channel to be converted
Adrian Suciu 33:c3ec596a29c2 126 * @param adcValue - ADC counts
Adrian Suciu 33:c3ec596a29c2 127 * @param intensity - computed light intensity
Adrian Suciu 33:c3ec596a29c2 128 */
Adrian Suciu 33:c3ec596a29c2 129 void calc_light_intensity(uint8_t channel, uint16_t adcValue, float *intensity);
Adrian Suciu 33:c3ec596a29c2 130
Adrian Suciu 33:c3ec596a29c2 131 /**
Adrian Suciu 33:c3ec596a29c2 132 * @brief Computes light concentration from light intensity
Adrian Suciu 33:c3ec596a29c2 133 * @param channel - channel to be converted
Adrian Suciu 33:c3ec596a29c2 134 * @param intensity - light intensity
Adrian Suciu 33:c3ec596a29c2 135 * @param conc - computed light concentration
Adrian Suciu 33:c3ec596a29c2 136 */
Adrian Suciu 33:c3ec596a29c2 137 void calc_light_concentration(uint8_t channel, float intensity, float *conc);
Adrian Suciu 33:c3ec596a29c2 138
Adrian Suciu 33:c3ec596a29c2 139 /**
Adrian Suciu 33:c3ec596a29c2 140 * @brief Reads the ADC channels and computes intensity and concentration
Adrian Suciu 33:c3ec596a29c2 141 */
Adrian Suciu 33:c3ec596a29c2 142 void set_app_data(void);
Adrian Suciu 33:c3ec596a29c2 143
Adrian Suciu 33:c3ec596a29c2 144 /**
Adrian Suciu 33:c3ec596a29c2 145 * @brief Calibrates the channel
Adrian Suciu 33:c3ec596a29c2 146 * @param channel - channel to be calibrated
Adrian Suciu 33:c3ec596a29c2 147 */
Adrian Suciu 33:c3ec596a29c2 148 void calibration(uint8_t channel);
Adrian Suciu 33:c3ec596a29c2 149
Adrian Suciu 33:c3ec596a29c2 150 /**
Adrian Suciu 33:c3ec596a29c2 151 * @brief Instance of the AD7798
Adrian Suciu 33:c3ec596a29c2 152 */
Adrian Suciu 33:c3ec596a29c2 153 AD7798 ad7798;
Adrian Suciu 33:c3ec596a29c2 154 private:
Adrian Suciu 33:c3ec596a29c2 155
Adrian Suciu 33:c3ec596a29c2 156 uint8_t statusReg, idReg, ioReg, gainAdc;
Adrian Suciu 33:c3ec596a29c2 157 uint16_t modeReg, configReg, offsetReg, fullscaleReg, dataReg;
Adrian Suciu 33:c3ec596a29c2 158 uint16_t adcValue[3];
Adrian Suciu 33:c3ec596a29c2 159 float voltageValue[3], intensityValue[3], lightConcentration[3];
Adrian Suciu 33:c3ec596a29c2 160 const uint8_t Channels[3] = { 1, 0, 2};
Adrian Suciu 33:c3ec596a29c2 161 const char colour[3][6] = {
Adrian Suciu 33:c3ec596a29c2 162 "RED", "GREEN", "BLUE",
Adrian Suciu 33:c3ec596a29c2 163 };
Adrian Suciu 33:c3ec596a29c2 164
Adrian Suciu 33:c3ec596a29c2 165 const uint8_t ColorPrint[3] = { 31, 32, 34 };
Adrian Suciu 33:c3ec596a29c2 166 const uint8_t Gain[8] = { 1, 2, 4, 8, 16, 32, 64, 128};
Adrian Suciu 33:c3ec596a29c2 167 const float Lux_LSB[3] = {2.122, 2.124, 2.113};
Adrian Suciu 33:c3ec596a29c2 168 const float Optimal_Levels[3] = {26909.0, 8880.0, 26909.0};
Adrian Suciu 33:c3ec596a29c2 169
Adrian Suciu 33:c3ec596a29c2 170 };
Adrian Suciu 33:c3ec596a29c2 171
Adrian Suciu 33:c3ec596a29c2 172 #endif /* CN0397_H_ */
Adrian Suciu 33:c3ec596a29c2 173