Bob Giesberts / LDC1101

Library to communicate with LDC1101

Dependents:   Inductive_Sensor Inductive_Sensor_Jasper Inductive_Sensor_3

Fork of LDC1000 by First Last

LDC1101.h@22:8da965ce5af3, 2016-01-16 (annotated)

Committer:
bobgiesberts
Date:
Sat Jan 16 09:12:32 2016 +0000
Revision:
22:8da965ce5af3
Parent:
20:8e1b1efdbb49
Child:
25:ae111662ee03
Small changes to the sleep function, little bit of waiting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bobgiesberts 16:07d0e43c2d12 1 #ifndef _LDC1101_H_
bobgiesberts 16:07d0e43c2d12 2 #define _LDC1101_H_
bobgiesberts 16:07d0e43c2d12 3
bobgiesberts 16:07d0e43c2d12 4 /**
bobgiesberts 16:07d0e43c2d12 5 * @file LDC1101.h
bobgiesberts 16:07d0e43c2d12 6 * @brief this header file will contain all required
bobgiesberts 16:07d0e43c2d12 7 * definitions for the functions to interface with Texas
bobgiesberts 16:07d0e43c2d12 8 * Instruments' LDC1101.
bobgiesberts 16:07d0e43c2d12 9 *
bobgiesberts 20:8e1b1efdbb49 10 * @author Victor Sluiter & Bob Giesberts
bobgiesberts 16:07d0e43c2d12 11 *
bobgiesberts 16:07d0e43c2d12 12 * @date 2015-12-09
bobgiesberts 16:07d0e43c2d12 13 */
bobgiesberts 16:07d0e43c2d12 14
bobgiesberts 16:07d0e43c2d12 15 #include "mbed.h"
bobgiesberts 16:07d0e43c2d12 16
bobgiesberts 16:07d0e43c2d12 17 #ifndef PI
bobgiesberts 16:07d0e43c2d12 18 #define PI 3.14
bobgiesberts 16:07d0e43c2d12 19 #endif
bobgiesberts 16:07d0e43c2d12 20
bobgiesberts 16:07d0e43c2d12 21 typedef enum { LDC_RESPONSE_192 = 2, \
bobgiesberts 16:07d0e43c2d12 22 LDC_RESPONSE_384 = 3, \
bobgiesberts 19:e205ab9142d8 23 LDC_RESPONSE_768 = 4, \
bobgiesberts 16:07d0e43c2d12 24 LDC_RESPONSE_1536= 5, \
bobgiesberts 16:07d0e43c2d12 25 LDC_RESPONSE_3072= 6, \
bobgiesberts 16:07d0e43c2d12 26 LDC_RESPONSE_6144= 7} LDC_RESPONSE;
bobgiesberts 16:07d0e43c2d12 27
bobgiesberts 19:e205ab9142d8 28 typedef enum { LDC_MODE_ACTIVE = 0, \
bobgiesberts 19:e205ab9142d8 29 LDC_MODE_STANDBY = 1, \
bobgiesberts 16:07d0e43c2d12 30 LDC_MODE_SHUTDOWN = 2} LDC_MODE;
bobgiesberts 16:07d0e43c2d12 31
bobgiesberts 17:a5cf2b4bec13 32 typedef enum { DIVIDER_1 = 0, \
bobgiesberts 17:a5cf2b4bec13 33 DIVIDER_2 = 1, \
bobgiesberts 17:a5cf2b4bec13 34 DIVIDER_4 = 2, \
bobgiesberts 17:a5cf2b4bec13 35 DIVIDER_8 = 3} DIVIDER;
bobgiesberts 17:a5cf2b4bec13 36
bobgiesberts 19:e205ab9142d8 37 typedef enum { RPMIN_96 = 0, \
bobgiesberts 19:e205ab9142d8 38 RPMIN_48 = 1, \
bobgiesberts 19:e205ab9142d8 39 RPMIN_24 = 2, \
bobgiesberts 19:e205ab9142d8 40 RPMIN_12 = 3, \
bobgiesberts 19:e205ab9142d8 41 RPMIN_6 = 4, \
bobgiesberts 19:e205ab9142d8 42 RPMIN_3 = 5, \
bobgiesberts 19:e205ab9142d8 43 RPMIN_1 = 6, \
bobgiesberts 19:e205ab9142d8 44 RPMIN_0 = 7} RPMIN;
bobgiesberts 17:a5cf2b4bec13 45
bobgiesberts 16:07d0e43c2d12 46 /**
bobgiesberts 16:07d0e43c2d12 47 * Class for the LDC1101.
bobgiesberts 16:07d0e43c2d12 48 * @author Victor Sluiter
bobgiesberts 16:07d0e43c2d12 49 * @date 2015-12-09
bobgiesberts 16:07d0e43c2d12 50 */
bobgiesberts 16:07d0e43c2d12 51 class LDC1101
bobgiesberts 16:07d0e43c2d12 52 {
bobgiesberts 16:07d0e43c2d12 53 public:
bobgiesberts 16:07d0e43c2d12 54 /**
bobgiesberts 16:07d0e43c2d12 55 * @brief Create a new Class to interface to an LDC1101
bobgiesberts 16:07d0e43c2d12 56 **/
bobgiesberts 18:fc9bb81a631f 57 LDC1101(PinName mosi, PinName miso, PinName sck, PinName cs, float capacitor, float f_CLKIN, PinName clock_out=NC);
bobgiesberts 16:07d0e43c2d12 58
bobgiesberts 16:07d0e43c2d12 59 /**
bobgiesberts 16:07d0e43c2d12 60 * @brief Set power mode.
bobgiesberts 16:07d0e43c2d12 61 * The constructor sets the LDC1101 in Active mode.
bobgiesberts 16:07d0e43c2d12 62 * @param mode choose from LDC_MODE_ACTIVE, LDC_MODE STANDBY or LDC_MODE_SHUTDOWN
bobgiesberts 16:07d0e43c2d12 63 **/
bobgiesberts 20:8e1b1efdbb49 64 void func_mode(LDC_MODE mode);
bobgiesberts 20:8e1b1efdbb49 65 /**
bobgiesberts 20:8e1b1efdbb49 66 * @brief Set LDC1101 to lowest power setting
bobgiesberts 20:8e1b1efdbb49 67 **/
bobgiesberts 20:8e1b1efdbb49 68 void sleep(void);
bobgiesberts 20:8e1b1efdbb49 69 /**
bobgiesberts 20:8e1b1efdbb49 70 * @brief Get LDC1101 to work for you again
bobgiesberts 20:8e1b1efdbb49 71 **/
bobgiesberts 20:8e1b1efdbb49 72 void wakeup(void);
bobgiesberts 16:07d0e43c2d12 73 /**
bobgiesberts 16:07d0e43c2d12 74 * @brief initial configurations
bobgiesberts 16:07d0e43c2d12 75 **/
bobgiesberts 16:07d0e43c2d12 76 void init(void);
bobgiesberts 16:07d0e43c2d12 77 /**
bobgiesberts 19:e205ab9142d8 78 * @brief initialises LHR mode
bobgiesberts 19:e205ab9142d8 79 * Also enables shutdown modus
bobgiesberts 19:e205ab9142d8 80 **/
bobgiesberts 20:8e1b1efdbb49 81 void setLHRmode(void);
bobgiesberts 19:e205ab9142d8 82
bobgiesberts 19:e205ab9142d8 83 /**
bobgiesberts 19:e205ab9142d8 84 * @brief Settings for RP
bobgiesberts 19:e205ab9142d8 85 * @param RPMAX_DIS [7]
bobgiesberts 19:e205ab9142d8 86 * 0 - not disabled: RP_MAX is driven
bobgiesberts 19:e205ab9142d8 87 * 1 - disabled: RP_MAX is ignored, current drive is off.
bobgiesberts 19:e205ab9142d8 88 * @param RPMIN [2:0]
bobgiesberts 19:e205ab9142d8 89 * This setting can be calibrated with the target closest to the sensor: R_p(d = 0mm)
bobgiesberts 19:e205ab9142d8 90 * RPMIN < 0.8 x R_p(d = 0mm)
bobgiesberts 19:e205ab9142d8 91 * If R_p < 750 Ohm --> increase distance to target
bobgiesberts 19:e205ab9142d8 92 **/
bobgiesberts 19:e205ab9142d8 93 void setRPsettings(bool RPMAX_DIS, RPMIN rpmin);
bobgiesberts 19:e205ab9142d8 94
bobgiesberts 19:e205ab9142d8 95 /**
bobgiesberts 17:a5cf2b4bec13 96 * @brief Sensor divider (p.26)
bobgiesberts 19:e205ab9142d8 97 * Sensor input divider (p.35)
bobgiesberts 20:8e1b1efdbb49 98 * Because f_CLKIN > 4*f_sensor_max is not realisable for higher frequencies, so there is a divider
bobgiesberts 20:8e1b1efdbb49 99 * f_CLKIN > 4 * f_sensor_max / SENSOR_DIV
bobgiesberts 17:a5cf2b4bec13 100 * @param div
bobgiesberts 17:a5cf2b4bec13 101 * - DIVIDER_1
bobgiesberts 17:a5cf2b4bec13 102 * - DIVIDER_2
bobgiesberts 17:a5cf2b4bec13 103 * - DIVIDER_4
bobgiesberts 17:a5cf2b4bec13 104 * - DIVIDER_8
bobgiesberts 17:a5cf2b4bec13 105 **/
bobgiesberts 17:a5cf2b4bec13 106 void setDivider(DIVIDER div);
bobgiesberts 19:e205ab9142d8 107
bobgiesberts 16:07d0e43c2d12 108 /**
bobgiesberts 19:e205ab9142d8 109 * @brief Set the Response Time parameters. Does not apply in LHR mode (p.17)
bobgiesberts 16:07d0e43c2d12 110 * @param responsetime
bobgiesberts 16:07d0e43c2d12 111 * Larger value increases accuracy, but slows down the output data rate. Choose one of these values:
bobgiesberts 16:07d0e43c2d12 112 * - LDC_RESPONSE_192
bobgiesberts 16:07d0e43c2d12 113 * - LDC_RESPONSE_384
bobgiesberts 16:07d0e43c2d12 114 * - LDC_RESPONSE_768
bobgiesberts 16:07d0e43c2d12 115 * - LDC_RESPONSE_1536
bobgiesberts 16:07d0e43c2d12 116 * - LDC_RESPONSE_3072
bobgiesberts 16:07d0e43c2d12 117 * - LDC_RESPONSE_6144
bobgiesberts 19:e205ab9142d8 118 * ResponseTime
bobgiesberts 19:e205ab9142d8 119 * t_conv (s) = ------------
bobgiesberts 19:e205ab9142d8 120 * 3 x f_sensor
bobgiesberts 16:07d0e43c2d12 121 **/
bobgiesberts 16:07d0e43c2d12 122 void setResponseTime(LDC_RESPONSE responsetime);
bobgiesberts 16:07d0e43c2d12 123
bobgiesberts 19:e205ab9142d8 124 /**
bobgiesberts 19:e205ab9142d8 125 * @brief Set the Reference Count parameter.
bobgiesberts 20:8e1b1efdbb49 126 * @param LHR_RCount
bobgiesberts 19:e205ab9142d8 127 * For LHR mode, the conversion time is set by the reference count LHR_RCOUNT (0x30 & 0x31) (p.34)
bobgiesberts 19:e205ab9142d8 128 * The conversion time represents the number of clock cycles used to measure the sensor frequency.
bobgiesberts 19:e205ab9142d8 129 * Higher values for LHR_RCOUNT have a higher effective measurement resolution but a lower sample rate. (p.34)
bobgiesberts 19:e205ab9142d8 130 * The maximum setting (0xffff) is required for full resolution (p. 35)
bobgiesberts 20:8e1b1efdbb49 131 * LHR_RCount = (f_CLKIN/sample rate - 55)/16
bobgiesberts 20:8e1b1efdbb49 132 **/
bobgiesberts 20:8e1b1efdbb49 133 void setReferenceCount(uint16_t LHR_RCount);
bobgiesberts 20:8e1b1efdbb49 134
bobgiesberts 20:8e1b1efdbb49 135 /**
bobgiesberts 20:8e1b1efdbb49 136 * @brief Set the rample rate (indirectly set the reference count)
bobgiesberts 19:e205ab9142d8 137 **/
bobgiesberts 20:8e1b1efdbb49 138 void setSampleRate( float samplerate );
bobgiesberts 20:8e1b1efdbb49 139
bobgiesberts 20:8e1b1efdbb49 140 /**
bobgiesberts 20:8e1b1efdbb49 141 * @brief Set the minimum sensor frequency (so without any target)
bobgiesberts 20:8e1b1efdbb49 142 * @param f_sensor_min
bobgiesberts 20:8e1b1efdbb49 143 * in MHz
bobgiesberts 20:8e1b1efdbb49 144 **/
bobgiesberts 20:8e1b1efdbb49 145 void setf_sensorMin(float f_sensor_min);
bobgiesberts 20:8e1b1efdbb49 146
bobgiesberts 19:e205ab9142d8 147 /**
bobgiesberts 19:e205ab9142d8 148 * @brief Set the value of the external capacitor
bobgiesberts 19:e205ab9142d8 149 * This is needed for the calculation of the inductance.
bobgiesberts 19:e205ab9142d8 150 **/
bobgiesberts 19:e205ab9142d8 151 void setCapacitor(float c){_cap = c;};
bobgiesberts 19:e205ab9142d8 152 /**
bobgiesberts 19:e205ab9142d8 153 * @brief set the value of the external clock
bobgiesberts 19:e205ab9142d8 154 * If PWMout is used to generate a clock signal, this will update the output frequency.s
bobgiesberts 19:e205ab9142d8 155 **/
bobgiesberts 19:e205ab9142d8 156 void setFrequency(float frequency){_fCLKIN = frequency;};
bobgiesberts 19:e205ab9142d8 157
bobgiesberts 19:e205ab9142d8 158
bobgiesberts 20:8e1b1efdbb49 159
bobgiesberts 20:8e1b1efdbb49 160
bobgiesberts 20:8e1b1efdbb49 161
bobgiesberts 19:e205ab9142d8 162 /**
bobgiesberts 19:e205ab9142d8 163 * @brief Read LHR_Data, the raw 24-bit inductance value.
bobgiesberts 19:e205ab9142d8 164 * This is needed for the calculation of the inductance.
bobgiesberts 19:e205ab9142d8 165 * It reads from addresses 0x38, 0x39 & 0x3A.
bobgiesberts 19:e205ab9142d8 166 **/
bobgiesberts 19:e205ab9142d8 167 uint32_t get_LHR_Data(void);
bobgiesberts 19:e205ab9142d8 168 /**
bobgiesberts 19:e205ab9142d8 169 * @brief get the calculated value for f_sensor
bobgiesberts 19:e205ab9142d8 170 **/
bobgiesberts 19:e205ab9142d8 171 float get_fsensor(void);
bobgiesberts 19:e205ab9142d8 172 /**
bobgiesberts 19:e205ab9142d8 173 * @brief get the calculated inductance value
bobgiesberts 19:e205ab9142d8 174 **/
bobgiesberts 19:e205ab9142d8 175 float get_Inductance(void);
bobgiesberts 19:e205ab9142d8 176 /**
bobgiesberts 19:e205ab9142d8 177 * @brief get the reference frequency (f_CLKIN)
bobgiesberts 19:e205ab9142d8 178 **/
bobgiesberts 19:e205ab9142d8 179 float get_fCLKIN(void);
bobgiesberts 19:e205ab9142d8 180 /**
bobgiesberts 19:e205ab9142d8 181 * @brief get the responsetime
bobgiesberts 19:e205ab9142d8 182 **/
bobgiesberts 20:8e1b1efdbb49 183 uint16_t get_responsetime(void) { uint16_t resps[] = {0, 0, 192, 384, 768, 1536, 3072, 6144}; uint8_t resp[1]; readSPI(resp, 0x04, 1); return resps[(resp[0] & 0x07)]; };
bobgiesberts 19:e205ab9142d8 184 /**
bobgiesberts 19:e205ab9142d8 185 * @brief get RPmin
bobgiesberts 19:e205ab9142d8 186 **/
bobgiesberts 19:e205ab9142d8 187 float get_RPmin(void);
bobgiesberts 19:e205ab9142d8 188 /**
bobgiesberts 19:e205ab9142d8 189 * @brief get the reference count
bobgiesberts 19:e205ab9142d8 190 **/
bobgiesberts 20:8e1b1efdbb49 191 uint16_t get_Rcount(void) { uint8_t rcount[2]; readSPI(rcount, 0x30, 2); return ((rcount[1] << 8) | rcount[0]); };
bobgiesberts 19:e205ab9142d8 192 /**
bobgiesberts 19:e205ab9142d8 193 * @brief get the divider
bobgiesberts 19:e205ab9142d8 194 **/
bobgiesberts 19:e205ab9142d8 195 uint8_t get_divider(void);
bobgiesberts 19:e205ab9142d8 196 /**
bobgiesberts 19:e205ab9142d8 197 * @brief get the capacitance
bobgiesberts 19:e205ab9142d8 198 **/
bobgiesberts 19:e205ab9142d8 199 float get_cap(void);
bobgiesberts 19:e205ab9142d8 200 /**
bobgiesberts 19:e205ab9142d8 201 * @brief get the quality
bobgiesberts 19:e205ab9142d8 202 **/
bobgiesberts 19:e205ab9142d8 203 float get_Q(void);
bobgiesberts 19:e205ab9142d8 204
bobgiesberts 22:8da965ce5af3 205 uint8_t get_status(void);
bobgiesberts 22:8da965ce5af3 206 uint8_t get_LHR_status(void);
bobgiesberts 22:8da965ce5af3 207 bool is_New_LHR_data(void);
bobgiesberts 22:8da965ce5af3 208 bool is_Oscillation_Error(void);
bobgiesberts 19:e205ab9142d8 209
bobgiesberts 19:e205ab9142d8 210
bobgiesberts 19:e205ab9142d8 211
bobgiesberts 19:e205ab9142d8 212
bobgiesberts 16:07d0e43c2d12 213 private:
bobgiesberts 16:07d0e43c2d12 214 void readSPI(uint8_t *data, uint8_t address, uint8_t num_bytes = 1);
bobgiesberts 16:07d0e43c2d12 215 void writeSPI(uint8_t *data, uint8_t address, uint8_t num_bytes = 1);
bobgiesberts 16:07d0e43c2d12 216 void writeSPIregister(uint8_t reg, uint8_t value){writeSPI(&value,reg);}; // VERKEERD OM?!
bobgiesberts 22:8da965ce5af3 217 void suicide(void *obj) {delete obj;};
bobgiesberts 16:07d0e43c2d12 218
bobgiesberts 16:07d0e43c2d12 219
bobgiesberts 19:e205ab9142d8 220 uint16_t _responsetime; // Response Time
bobgiesberts 19:e205ab9142d8 221 uint8_t _divider; // divider
bobgiesberts 19:e205ab9142d8 222 float _RPmin; // RP_MIN
bobgiesberts 19:e205ab9142d8 223 float _fsensor; // f_sensor: the calculated frequency of the sensor
bobgiesberts 19:e205ab9142d8 224 float _inductance; // the calculated inductance
bobgiesberts 19:e205ab9142d8 225 float _fCLKIN; // f_CLKIN: frequency of external clock: 16MHz
bobgiesberts 19:e205ab9142d8 226 float _cap; // capacitor: 120 pF
bobgiesberts 19:e205ab9142d8 227 uint32_t _L_data; // The raw measured data for inductance
bobgiesberts 19:e205ab9142d8 228 uint16_t _Rcount; // The reference count
bobgiesberts 19:e205ab9142d8 229
bobgiesberts 19:e205ab9142d8 230
bobgiesberts 16:07d0e43c2d12 231 SPI _spiport;
bobgiesberts 16:07d0e43c2d12 232 DigitalOut _cs_pin;
bobgiesberts 16:07d0e43c2d12 233
bobgiesberts 17:a5cf2b4bec13 234 //FastPWM _clock;
bobgiesberts 16:07d0e43c2d12 235 };
bobgiesberts 16:07d0e43c2d12 236
bobgiesberts 16:07d0e43c2d12 237 #endif