SparkFun_9DOF_SensorStick
Dependencies: FatFileSystem mbed
Fork of 9DOF_SensorStick by
HMC5883L.h@2:3ffce3e97527, 2012-01-25 (annotated)
- Committer:
- higedura
- Date:
- Wed Jan 25 05:25:29 2012 +0000
- Revision:
- 2:3ffce3e97527
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
higedura | 2:3ffce3e97527 | 1 | /** |
higedura | 2:3ffce3e97527 | 2 | * @author Uwe Gartmann |
higedura | 2:3ffce3e97527 | 3 | * @author Used HMC5883L library developed by Jose R. Padron and Aaron Berk as template |
higedura | 2:3ffce3e97527 | 4 | * |
higedura | 2:3ffce3e97527 | 5 | * @section LICENSE |
higedura | 2:3ffce3e97527 | 6 | * |
higedura | 2:3ffce3e97527 | 7 | * Copyright (c) 2010 ARM Limited |
higedura | 2:3ffce3e97527 | 8 | * |
higedura | 2:3ffce3e97527 | 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
higedura | 2:3ffce3e97527 | 10 | * of this software and associated documentation files (the "Software"), to deal |
higedura | 2:3ffce3e97527 | 11 | * in the Software without restriction, including without limitation the rights |
higedura | 2:3ffce3e97527 | 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
higedura | 2:3ffce3e97527 | 13 | * copies of the Software, and to permit persons to whom the Software is |
higedura | 2:3ffce3e97527 | 14 | * furnished to do so, subject to the following conditions: |
higedura | 2:3ffce3e97527 | 15 | * |
higedura | 2:3ffce3e97527 | 16 | * The above copyright notice and this permission notice shall be included in |
higedura | 2:3ffce3e97527 | 17 | * all copies or substantial portions of the Software. |
higedura | 2:3ffce3e97527 | 18 | * |
higedura | 2:3ffce3e97527 | 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
higedura | 2:3ffce3e97527 | 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
higedura | 2:3ffce3e97527 | 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
higedura | 2:3ffce3e97527 | 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
higedura | 2:3ffce3e97527 | 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
higedura | 2:3ffce3e97527 | 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
higedura | 2:3ffce3e97527 | 25 | * THE SOFTWARE. |
higedura | 2:3ffce3e97527 | 26 | * |
higedura | 2:3ffce3e97527 | 27 | * @section DESCRIPTION |
higedura | 2:3ffce3e97527 | 28 | * |
higedura | 2:3ffce3e97527 | 29 | * Honeywell HMC5883L digital compass. |
higedura | 2:3ffce3e97527 | 30 | * |
higedura | 2:3ffce3e97527 | 31 | * Datasheet: |
higedura | 2:3ffce3e97527 | 32 | * |
higedura | 2:3ffce3e97527 | 33 | * http://www.ssec.honeywell.com/magnetic/datasheets/HMC5883L.pdf |
higedura | 2:3ffce3e97527 | 34 | */ |
higedura | 2:3ffce3e97527 | 35 | |
higedura | 2:3ffce3e97527 | 36 | #ifndef HMC5883L_H |
higedura | 2:3ffce3e97527 | 37 | #define HMC5883L_H |
higedura | 2:3ffce3e97527 | 38 | |
higedura | 2:3ffce3e97527 | 39 | /** |
higedura | 2:3ffce3e97527 | 40 | * Includes |
higedura | 2:3ffce3e97527 | 41 | */ |
higedura | 2:3ffce3e97527 | 42 | #include "mbed.h" |
higedura | 2:3ffce3e97527 | 43 | |
higedura | 2:3ffce3e97527 | 44 | /** |
higedura | 2:3ffce3e97527 | 45 | * Defines |
higedura | 2:3ffce3e97527 | 46 | */ |
higedura | 2:3ffce3e97527 | 47 | #define HMC5883L_I2C_ADDRESS 0x1E //7-bit address. 0x3C write, 0x3D read. |
higedura | 2:3ffce3e97527 | 48 | #define HMC5883L_I2C_WRITE 0x3C |
higedura | 2:3ffce3e97527 | 49 | #define HMC5883L_I2C_READ 0x3D |
higedura | 2:3ffce3e97527 | 50 | |
higedura | 2:3ffce3e97527 | 51 | //Values Config A |
higedura | 2:3ffce3e97527 | 52 | #define HMC5883L_0_5HZ_NORMAL 0x00 |
higedura | 2:3ffce3e97527 | 53 | #define HMC5883L_0_5HZ_POSITIVE 0x01 |
higedura | 2:3ffce3e97527 | 54 | #define HMC5883L_0_5HZ_NEGATIVE 0x02 |
higedura | 2:3ffce3e97527 | 55 | |
higedura | 2:3ffce3e97527 | 56 | #define HMC5883L_1HZ_NORMAL 0x04 |
higedura | 2:3ffce3e97527 | 57 | #define HMC5883L_1HZ_POSITIVE 0x05 |
higedura | 2:3ffce3e97527 | 58 | #define HMC5883L_1HZ_NEGATIVE 0x06 |
higedura | 2:3ffce3e97527 | 59 | |
higedura | 2:3ffce3e97527 | 60 | #define HMC5883L_2HZ_NORMAL 0x08 |
higedura | 2:3ffce3e97527 | 61 | #define HMC5883L_2HZ_POSITIVE 0x09 |
higedura | 2:3ffce3e97527 | 62 | #define HMC5883L_2HZ_NEGATIVE 0x0A |
higedura | 2:3ffce3e97527 | 63 | |
higedura | 2:3ffce3e97527 | 64 | #define HMC5883L_5HZ_NORMAL 0x0C |
higedura | 2:3ffce3e97527 | 65 | #define HMC5883L_5HZ_POSITIVE 0x0D |
higedura | 2:3ffce3e97527 | 66 | #define HMC5883L_5HZ_NEGATIVE 0x0E |
higedura | 2:3ffce3e97527 | 67 | |
higedura | 2:3ffce3e97527 | 68 | #define HMC5883L_10HZ_NORMAL 0x10 |
higedura | 2:3ffce3e97527 | 69 | #define HMC5883L_10HZ_POSITIVE 0x11 |
higedura | 2:3ffce3e97527 | 70 | #define HMC5883L_10HZ_NEGATIVE 0x12 |
higedura | 2:3ffce3e97527 | 71 | |
higedura | 2:3ffce3e97527 | 72 | #define HMC5883L_20HZ_NORMAL 0x14 |
higedura | 2:3ffce3e97527 | 73 | #define HMC5883L_20HZ_POSITIVE 0x15 |
higedura | 2:3ffce3e97527 | 74 | #define HMC5883L_20HZ_NEGATIVE 0x16 |
higedura | 2:3ffce3e97527 | 75 | |
higedura | 2:3ffce3e97527 | 76 | #define HMC5883L_50HZ_NORMAL 0x18 |
higedura | 2:3ffce3e97527 | 77 | #define HMC5883L_50HZ_POSITIVE 0x19 |
higedura | 2:3ffce3e97527 | 78 | #define HMC5883L_50HZ_NEGATIVE 0x1A |
higedura | 2:3ffce3e97527 | 79 | |
higedura | 2:3ffce3e97527 | 80 | //Values Config B |
higedura | 2:3ffce3e97527 | 81 | #define HMC5883L_0_7GA 0x00 |
higedura | 2:3ffce3e97527 | 82 | #define HMC5883L_1_0GA 0x20 |
higedura | 2:3ffce3e97527 | 83 | #define HMC5883L_1_5GA 0x40 |
higedura | 2:3ffce3e97527 | 84 | #define HMC5883L_2_0GA 0x60 |
higedura | 2:3ffce3e97527 | 85 | #define HMC5883L_3_2GA 0x80 |
higedura | 2:3ffce3e97527 | 86 | #define HMC5883L_3_8GA 0xA0 |
higedura | 2:3ffce3e97527 | 87 | #define HMC5883L_4_5GA 0xC0 |
higedura | 2:3ffce3e97527 | 88 | #define HMC5883L_6_5GA 0xE0 |
higedura | 2:3ffce3e97527 | 89 | |
higedura | 2:3ffce3e97527 | 90 | //Values MODE |
higedura | 2:3ffce3e97527 | 91 | #define HMC5883L_CONTINUOUS 0x00 |
higedura | 2:3ffce3e97527 | 92 | #define HMC5883L_SINGLE 0x01 |
higedura | 2:3ffce3e97527 | 93 | #define HMC5883L_IDLE 0x02 |
higedura | 2:3ffce3e97527 | 94 | #define HMC5883L_SLEEP 0x03 |
higedura | 2:3ffce3e97527 | 95 | |
higedura | 2:3ffce3e97527 | 96 | |
higedura | 2:3ffce3e97527 | 97 | |
higedura | 2:3ffce3e97527 | 98 | #define HMC5883L_CONFIG_A 0x00 |
higedura | 2:3ffce3e97527 | 99 | #define HMC5883L_CONFIG_B 0x01 |
higedura | 2:3ffce3e97527 | 100 | #define HMC5883L_MODE 0x02 |
higedura | 2:3ffce3e97527 | 101 | #define HMC5883L_X_MSB 0x03 |
higedura | 2:3ffce3e97527 | 102 | #define HMC5883L_X_LSB 0x04 |
higedura | 2:3ffce3e97527 | 103 | #define HMC5883L_Z_MSB 0x05 |
higedura | 2:3ffce3e97527 | 104 | #define HMC5883L_Z_LSB 0x06 |
higedura | 2:3ffce3e97527 | 105 | #define HMC5883L_Y_MSB 0x07 |
higedura | 2:3ffce3e97527 | 106 | #define HMC5883L_Y_LSB 0x08 |
higedura | 2:3ffce3e97527 | 107 | #define HMC5883L_STATUS 0x09 |
higedura | 2:3ffce3e97527 | 108 | #define HMC5883L_IDENT_A 0x0A |
higedura | 2:3ffce3e97527 | 109 | #define HMC5883L_IDENT_B 0x0B |
higedura | 2:3ffce3e97527 | 110 | #define HMC5883L_IDENT_C 0x0C |
higedura | 2:3ffce3e97527 | 111 | |
higedura | 2:3ffce3e97527 | 112 | |
higedura | 2:3ffce3e97527 | 113 | |
higedura | 2:3ffce3e97527 | 114 | /** |
higedura | 2:3ffce3e97527 | 115 | * Honeywell HMC5883L digital compass. |
higedura | 2:3ffce3e97527 | 116 | */ |
higedura | 2:3ffce3e97527 | 117 | class HMC5883L { |
higedura | 2:3ffce3e97527 | 118 | |
higedura | 2:3ffce3e97527 | 119 | public: |
higedura | 2:3ffce3e97527 | 120 | |
higedura | 2:3ffce3e97527 | 121 | /** |
higedura | 2:3ffce3e97527 | 122 | * Constructor. |
higedura | 2:3ffce3e97527 | 123 | * |
higedura | 2:3ffce3e97527 | 124 | * @param sda mbed pin to use for SDA line of I2C interface. |
higedura | 2:3ffce3e97527 | 125 | * @param scl mbed pin to use for SCL line of I2C interface. |
higedura | 2:3ffce3e97527 | 126 | */ |
higedura | 2:3ffce3e97527 | 127 | HMC5883L(PinName sda, PinName scl); |
higedura | 2:3ffce3e97527 | 128 | |
higedura | 2:3ffce3e97527 | 129 | |
higedura | 2:3ffce3e97527 | 130 | /** |
higedura | 2:3ffce3e97527 | 131 | * Enter into sleep mode. |
higedura | 2:3ffce3e97527 | 132 | * |
higedura | 2:3ffce3e97527 | 133 | */ |
higedura | 2:3ffce3e97527 | 134 | void setSleepMode(); |
higedura | 2:3ffce3e97527 | 135 | |
higedura | 2:3ffce3e97527 | 136 | |
higedura | 2:3ffce3e97527 | 137 | /** |
higedura | 2:3ffce3e97527 | 138 | * Set Device in Default Mode. |
higedura | 2:3ffce3e97527 | 139 | * HMC5883L_CONTINUOUS, HMC5883L_10HZ_NORMAL HMC5883L_1_0GA |
higedura | 2:3ffce3e97527 | 140 | */ |
higedura | 2:3ffce3e97527 | 141 | void setDefault(); |
higedura | 2:3ffce3e97527 | 142 | |
higedura | 2:3ffce3e97527 | 143 | |
higedura | 2:3ffce3e97527 | 144 | /** |
higedura | 2:3ffce3e97527 | 145 | * Read the memory location on the device which contains the address. |
higedura | 2:3ffce3e97527 | 146 | * |
higedura | 2:3ffce3e97527 | 147 | * @param Pointer to a buffer to hold the address value |
higedura | 2:3ffce3e97527 | 148 | * Expected H, 4 and 3. |
higedura | 2:3ffce3e97527 | 149 | */ |
higedura | 2:3ffce3e97527 | 150 | void getAddress(char * address); |
higedura | 2:3ffce3e97527 | 151 | |
higedura | 2:3ffce3e97527 | 152 | |
higedura | 2:3ffce3e97527 | 153 | |
higedura | 2:3ffce3e97527 | 154 | /** |
higedura | 2:3ffce3e97527 | 155 | * Set the operation mode. |
higedura | 2:3ffce3e97527 | 156 | * |
higedura | 2:3ffce3e97527 | 157 | * @param mode 0x00 -> Continuous |
higedura | 2:3ffce3e97527 | 158 | * 0x01 -> Single |
higedura | 2:3ffce3e97527 | 159 | * 0x02 -> Idle |
higedura | 2:3ffce3e97527 | 160 | * @param ConfigA values |
higedura | 2:3ffce3e97527 | 161 | * @param ConfigB values |
higedura | 2:3ffce3e97527 | 162 | */ |
higedura | 2:3ffce3e97527 | 163 | void setOpMode(int mode, int ConfigA, int ConfigB); |
higedura | 2:3ffce3e97527 | 164 | |
higedura | 2:3ffce3e97527 | 165 | /** |
higedura | 2:3ffce3e97527 | 166 | * Write to on the device. |
higedura | 2:3ffce3e97527 | 167 | * |
higedura | 2:3ffce3e97527 | 168 | * @param address Address to write to. |
higedura | 2:3ffce3e97527 | 169 | * @param data Data to write. |
higedura | 2:3ffce3e97527 | 170 | */ |
higedura | 2:3ffce3e97527 | 171 | |
higedura | 2:3ffce3e97527 | 172 | void write(int address, int data); |
higedura | 2:3ffce3e97527 | 173 | |
higedura | 2:3ffce3e97527 | 174 | /** |
higedura | 2:3ffce3e97527 | 175 | * Get the output of all three axes. |
higedura | 2:3ffce3e97527 | 176 | * |
higedura | 2:3ffce3e97527 | 177 | * @param Pointer to a buffer to hold the magnetics value for the |
higedura | 2:3ffce3e97527 | 178 | * x-axis, y-axis and z-axis [in that order]. |
higedura | 2:3ffce3e97527 | 179 | */ |
higedura | 2:3ffce3e97527 | 180 | void readData(int* getMag); |
higedura | 2:3ffce3e97527 | 181 | |
higedura | 2:3ffce3e97527 | 182 | /** |
higedura | 2:3ffce3e97527 | 183 | * Get the output of X axis. |
higedura | 2:3ffce3e97527 | 184 | * |
higedura | 2:3ffce3e97527 | 185 | * @return x-axis magnetic value |
higedura | 2:3ffce3e97527 | 186 | */ |
higedura | 2:3ffce3e97527 | 187 | int getMx(); |
higedura | 2:3ffce3e97527 | 188 | |
higedura | 2:3ffce3e97527 | 189 | /** |
higedura | 2:3ffce3e97527 | 190 | * Get the output of Y axis. |
higedura | 2:3ffce3e97527 | 191 | * |
higedura | 2:3ffce3e97527 | 192 | * @return y-axis magnetic value |
higedura | 2:3ffce3e97527 | 193 | */ |
higedura | 2:3ffce3e97527 | 194 | int getMy(); |
higedura | 2:3ffce3e97527 | 195 | |
higedura | 2:3ffce3e97527 | 196 | /** |
higedura | 2:3ffce3e97527 | 197 | * Get the output of Z axis. |
higedura | 2:3ffce3e97527 | 198 | * |
higedura | 2:3ffce3e97527 | 199 | * @return z-axis magnetic value |
higedura | 2:3ffce3e97527 | 200 | */ |
higedura | 2:3ffce3e97527 | 201 | int getMz(); |
higedura | 2:3ffce3e97527 | 202 | |
higedura | 2:3ffce3e97527 | 203 | |
higedura | 2:3ffce3e97527 | 204 | /** |
higedura | 2:3ffce3e97527 | 205 | * Get the current operation mode. |
higedura | 2:3ffce3e97527 | 206 | * |
higedura | 2:3ffce3e97527 | 207 | * @return Status register values |
higedura | 2:3ffce3e97527 | 208 | */ |
higedura | 2:3ffce3e97527 | 209 | int getStatus(void); |
higedura | 2:3ffce3e97527 | 210 | |
higedura | 2:3ffce3e97527 | 211 | |
higedura | 2:3ffce3e97527 | 212 | |
higedura | 2:3ffce3e97527 | 213 | I2C* i2c_; |
higedura | 2:3ffce3e97527 | 214 | |
higedura | 2:3ffce3e97527 | 215 | |
higedura | 2:3ffce3e97527 | 216 | |
higedura | 2:3ffce3e97527 | 217 | }; |
higedura | 2:3ffce3e97527 | 218 | |
higedura | 2:3ffce3e97527 | 219 | #endif /* HMC5883L_H */ |