Arkadi Rafalovich / X_NUCLEO_IKS01A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Dependents:   STM32_MagneticLight

Fork of X_NUCLEO_IKS01A1 by ST

Components/LIS3MDL/lis3mdl.cpp@1:591d1746019c, 2015-04-13 (annotated)

Committer:
Wolfgang Betz
Date:
Mon Apr 13 11:47:26 2015 +0200
Revision:
1:591d1746019c
Child:
2:5f95b745eedb
Merge commit '0f910ecdacb98aed2f4ea01a79e371be1cf84345' into betzw_wb

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 1:591d1746019c 1 /**
Wolfgang Betz 1:591d1746019c 2 ******************************************************************************
Wolfgang Betz 1:591d1746019c 3 * @file x_cube_mems_lis3mdl.h
Wolfgang Betz 1:591d1746019c 4 * @author AST / EST
Wolfgang Betz 1:591d1746019c 5 * @version V0.0.1
Wolfgang Betz 1:591d1746019c 6 * @date 9-December-2014
Wolfgang Betz 1:591d1746019c 7 * @brief Implementation file for component LIS3MDL
Wolfgang Betz 1:591d1746019c 8 ******************************************************************************
Wolfgang Betz 1:591d1746019c 9 * @attention
Wolfgang Betz 1:591d1746019c 10 *
Wolfgang Betz 1:591d1746019c 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Wolfgang Betz 1:591d1746019c 12 *
Wolfgang Betz 1:591d1746019c 13 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 1:591d1746019c 14 * are permitted provided that the following conditions are met:
Wolfgang Betz 1:591d1746019c 15 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 1:591d1746019c 16 * this list of conditions and the following disclaimer.
Wolfgang Betz 1:591d1746019c 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 1:591d1746019c 18 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 1:591d1746019c 19 * and/or other materials provided with the distribution.
Wolfgang Betz 1:591d1746019c 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 1:591d1746019c 21 * may be used to endorse or promote products derived from this software
Wolfgang Betz 1:591d1746019c 22 * without specific prior written permission.
Wolfgang Betz 1:591d1746019c 23 *
Wolfgang Betz 1:591d1746019c 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 1:591d1746019c 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 1:591d1746019c 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 1:591d1746019c 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 1:591d1746019c 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 1:591d1746019c 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 1:591d1746019c 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 1:591d1746019c 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 1:591d1746019c 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 1:591d1746019c 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 1:591d1746019c 34 *
Wolfgang Betz 1:591d1746019c 35 ******************************************************************************
Wolfgang Betz 1:591d1746019c 36 */
Wolfgang Betz 1:591d1746019c 37
Wolfgang Betz 1:591d1746019c 38 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 1:591d1746019c 39 #include "mbed.h"
Wolfgang Betz 1:591d1746019c 40 #include "lis3mdl.h"
Wolfgang Betz 1:591d1746019c 41 #include "lis3mdl_platform.h"
Wolfgang Betz 1:591d1746019c 42 #include <math.h>
Wolfgang Betz 1:591d1746019c 43
Wolfgang Betz 1:591d1746019c 44 /* Methods -------------------------------------------------------------------*/
Wolfgang Betz 1:591d1746019c 45
Wolfgang Betz 1:591d1746019c 46 /**
Wolfgang Betz 1:591d1746019c 47 * @brief Read data from LIS3MDL Magnetic sensor and calculate Magnetic in mgauss.
Wolfgang Betz 1:591d1746019c 48 * @param float *pfData
Wolfgang Betz 1:591d1746019c 49 * @retval None.
Wolfgang Betz 1:591d1746019c 50 */
Wolfgang Betz 1:591d1746019c 51 void LIS3MDL::GetAxes(AxesRaw_TypeDef *pData)
Wolfgang Betz 1:591d1746019c 52 {
Wolfgang Betz 1:591d1746019c 53 uint8_t tempReg = 0x00;
Wolfgang Betz 1:591d1746019c 54 int16_t pDataRaw[3];
Wolfgang Betz 1:591d1746019c 55 float sensitivity = 0;
Wolfgang Betz 1:591d1746019c 56 int ret;
Wolfgang Betz 1:591d1746019c 57
Wolfgang Betz 1:591d1746019c 58 GetAxesRaw(pDataRaw);
Wolfgang Betz 1:591d1746019c 59
Wolfgang Betz 1:591d1746019c 60 ret = dev_i2c.i2c_read(&tempReg, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG2_M, 1);
Wolfgang Betz 1:591d1746019c 61
Wolfgang Betz 1:591d1746019c 62 tempReg &= LIS3MDL_M_FS_MASK;
Wolfgang Betz 1:591d1746019c 63
Wolfgang Betz 1:591d1746019c 64 switch(tempReg)
Wolfgang Betz 1:591d1746019c 65 {
Wolfgang Betz 1:591d1746019c 66 case LIS3MDL_M_FS_4:
Wolfgang Betz 1:591d1746019c 67 sensitivity = 0.14;
Wolfgang Betz 1:591d1746019c 68 break;
Wolfgang Betz 1:591d1746019c 69 case LIS3MDL_M_FS_8:
Wolfgang Betz 1:591d1746019c 70 sensitivity = 0.29;
Wolfgang Betz 1:591d1746019c 71 break;
Wolfgang Betz 1:591d1746019c 72 case LIS3MDL_M_FS_12:
Wolfgang Betz 1:591d1746019c 73 sensitivity = 0.43;
Wolfgang Betz 1:591d1746019c 74 break;
Wolfgang Betz 1:591d1746019c 75 case LIS3MDL_M_FS_16:
Wolfgang Betz 1:591d1746019c 76 sensitivity = 0.58;
Wolfgang Betz 1:591d1746019c 77 break;
Wolfgang Betz 1:591d1746019c 78 }
Wolfgang Betz 1:591d1746019c 79
Wolfgang Betz 1:591d1746019c 80 pData->AXIS_X = (int32_t)(pDataRaw[0] * sensitivity);
Wolfgang Betz 1:591d1746019c 81 pData->AXIS_Y = (int32_t)(pDataRaw[1] * sensitivity);
Wolfgang Betz 1:591d1746019c 82 pData->AXIS_Z = (int32_t)(pDataRaw[2] * sensitivity);
Wolfgang Betz 1:591d1746019c 83
Wolfgang Betz 1:591d1746019c 84 }
Wolfgang Betz 1:591d1746019c 85
Wolfgang Betz 1:591d1746019c 86 /**
Wolfgang Betz 1:591d1746019c 87 * @brief Read raw data from LIS3MDL Magnetic sensor output register.
Wolfgang Betz 1:591d1746019c 88 * @param float *pfData
Wolfgang Betz 1:591d1746019c 89 * @retval None.
Wolfgang Betz 1:591d1746019c 90 */
Wolfgang Betz 1:591d1746019c 91 void LIS3MDL::GetAxesRaw(int16_t *pData)
Wolfgang Betz 1:591d1746019c 92 {
Wolfgang Betz 1:591d1746019c 93 uint8_t tempReg[2] = {0,0};
Wolfgang Betz 1:591d1746019c 94 int ret;
Wolfgang Betz 1:591d1746019c 95
Wolfgang Betz 1:591d1746019c 96 ret = dev_i2c.i2c_read(&tempReg[0], LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_OUT_X_L_M + 0x80, 2);
Wolfgang Betz 1:591d1746019c 97
Wolfgang Betz 1:591d1746019c 98 pData[0] = ((((int16_t)tempReg[1]) << 8)+(int16_t)tempReg[0]);
Wolfgang Betz 1:591d1746019c 99
Wolfgang Betz 1:591d1746019c 100 ret = dev_i2c.i2c_read(&tempReg[0], LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_OUT_Y_L_M + 0x80, 2);
Wolfgang Betz 1:591d1746019c 101
Wolfgang Betz 1:591d1746019c 102 pData[1] = ((((int16_t)tempReg[1]) << 8)+(int16_t)tempReg[0]);
Wolfgang Betz 1:591d1746019c 103
Wolfgang Betz 1:591d1746019c 104 ret = dev_i2c.i2c_read(&tempReg[0], LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_OUT_Z_L_M + 0x80, 2);
Wolfgang Betz 1:591d1746019c 105
Wolfgang Betz 1:591d1746019c 106 pData[2] = ((((int16_t)tempReg[1]) << 8)+(int16_t)tempReg[0]);
Wolfgang Betz 1:591d1746019c 107 }
Wolfgang Betz 1:591d1746019c 108
Wolfgang Betz 1:591d1746019c 109 /**
Wolfgang Betz 1:591d1746019c 110 * @brief Read ID address of HTS221
Wolfgang Betz 1:591d1746019c 111 * @param Device ID address
Wolfgang Betz 1:591d1746019c 112 * @retval ID name
Wolfgang Betz 1:591d1746019c 113 */
Wolfgang Betz 1:591d1746019c 114 uint8_t LIS3MDL::ReadID(void)
Wolfgang Betz 1:591d1746019c 115 {
Wolfgang Betz 1:591d1746019c 116 uint8_t tmp=0x00;
Wolfgang Betz 1:591d1746019c 117 int ret;
Wolfgang Betz 1:591d1746019c 118
Wolfgang Betz 1:591d1746019c 119 /* Read WHO I AM register */
Wolfgang Betz 1:591d1746019c 120 ret = dev_i2c.i2c_read(&tmp, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_WHO_AM_I_ADDR, 1);
Wolfgang Betz 1:591d1746019c 121
Wolfgang Betz 1:591d1746019c 122 /* Return the ID */
Wolfgang Betz 1:591d1746019c 123 return (uint8_t)tmp;
Wolfgang Betz 1:591d1746019c 124 }
Wolfgang Betz 1:591d1746019c 125
Wolfgang Betz 1:591d1746019c 126 /**
Wolfgang Betz 1:591d1746019c 127 * @brief Set HTS221 Initialization.
Wolfgang Betz 1:591d1746019c 128 * @param InitStruct: it contains the configuration setting for the HTS221.
Wolfgang Betz 1:591d1746019c 129 * @retval None
Wolfgang Betz 1:591d1746019c 130 */
Wolfgang Betz 1:591d1746019c 131 void LIS3MDL::Init() {
Wolfgang Betz 1:591d1746019c 132
Wolfgang Betz 1:591d1746019c 133 uint8_t tmp1 = 0x00;
Wolfgang Betz 1:591d1746019c 134 int ret;
Wolfgang Betz 1:591d1746019c 135
Wolfgang Betz 1:591d1746019c 136 /****** Magnetic sensor *******/
Wolfgang Betz 1:591d1746019c 137
Wolfgang Betz 1:591d1746019c 138 ret = dev_i2c.i2c_read(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG3_M, 1);
Wolfgang Betz 1:591d1746019c 139
Wolfgang Betz 1:591d1746019c 140 /* Conversion mode selection */
Wolfgang Betz 1:591d1746019c 141 tmp1 &= ~(LIS3MDL_M_MD_MASK);
Wolfgang Betz 1:591d1746019c 142 tmp1 |= LIS3MDL_M_MD_CONTINUOUS;
Wolfgang Betz 1:591d1746019c 143
Wolfgang Betz 1:591d1746019c 144 ret = dev_i2c.i2c_write(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG3_M, 1);
Wolfgang Betz 1:591d1746019c 145
Wolfgang Betz 1:591d1746019c 146 ret = dev_i2c.i2c_read(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG1_M, 1);
Wolfgang Betz 1:591d1746019c 147
Wolfgang Betz 1:591d1746019c 148 /* Output data rate selection */
Wolfgang Betz 1:591d1746019c 149 tmp1 &= ~(LIS3MDL_M_DO_MASK);
Wolfgang Betz 1:591d1746019c 150 tmp1 |= LIS3MDL_M_DO_80;
Wolfgang Betz 1:591d1746019c 151
Wolfgang Betz 1:591d1746019c 152 /* X and Y axes Operative mode selection */
Wolfgang Betz 1:591d1746019c 153 tmp1 &= ~(LIS3MDL_M_OM_MASK);
Wolfgang Betz 1:591d1746019c 154 tmp1 |= LIS3MDL_M_OM_HP;
Wolfgang Betz 1:591d1746019c 155
Wolfgang Betz 1:591d1746019c 156 ret = dev_i2c.i2c_write(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG1_M, 1);
Wolfgang Betz 1:591d1746019c 157
Wolfgang Betz 1:591d1746019c 158 ret = dev_i2c.i2c_read(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG2_M, 1);
Wolfgang Betz 1:591d1746019c 159
Wolfgang Betz 1:591d1746019c 160 /* Full scale selection */
Wolfgang Betz 1:591d1746019c 161 tmp1 &= ~(LIS3MDL_M_FS_MASK);
Wolfgang Betz 1:591d1746019c 162 tmp1 |= LIS3MDL_M_FS_4;
Wolfgang Betz 1:591d1746019c 163
Wolfgang Betz 1:591d1746019c 164 ret = dev_i2c.i2c_write(&tmp1, LIS3MDL_M_MEMS_ADDRESS, LIS3MDL_M_CTRL_REG2_M, 1);
Wolfgang Betz 1:591d1746019c 165
Wolfgang Betz 1:591d1746019c 166 /******************************/
Wolfgang Betz 1:591d1746019c 167
Wolfgang Betz 1:591d1746019c 168
Wolfgang Betz 1:591d1746019c 169 if(ReadID() == I_AM_LIS3MDL_M)
Wolfgang Betz 1:591d1746019c 170 {
Wolfgang Betz 1:591d1746019c 171 LIS3MDLInitialized = 1;
Wolfgang Betz 1:591d1746019c 172 }
Wolfgang Betz 1:591d1746019c 173
Wolfgang Betz 1:591d1746019c 174 return;
Wolfgang Betz 1:591d1746019c 175 }
Wolfgang Betz 1:591d1746019c 176
Wolfgang Betz 1:591d1746019c 177