E&R S3 prime / BSP_DISCO_L476VG

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.

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers stm32l476g_discovery_compass.h Source File

stm32l476g_discovery_compass.h

Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l476g_discovery_compass.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains definitions for stm32l476g_discovery_compass.c
00006   *          firmware driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __STM32L476G_DISCOVERY_COMPASS_H
00023 #define __STM32L476G_DISCOVERY_COMPASS_H
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 #include "stm32l476g_discovery.h"
00031 
00032 /** @addtogroup BSP
00033   * @{
00034   */
00035 
00036 /** @addtogroup STM32L476G_DISCOVERY
00037   * @{
00038   */
00039 
00040 /** @addtogroup STM32L476G_DISCOVERY_COMPASS
00041   * @{
00042   */
00043 
00044 /** @defgroup STM32L476G_DISCOVERY_COMPASS_Exported_Types Exported Types
00045   * @{
00046   */
00047 
00048 /**
00049   * @}
00050   */
00051 
00052 /** @defgroup STM32L476G_DISCOVERY_COMPASS_Exported_Constants Exported Constants
00053   * @{
00054   */
00055 typedef enum
00056 {
00057   COMPASS_OK = 0,
00058   COMPASS_ERROR = 1,
00059   COMPASS_TIMEOUT = 2
00060 }
00061 COMPASS_StatusTypeDef;
00062 
00063 /**
00064   * @}
00065   */
00066 
00067 /** @defgroup STM32L476G_DISCOVERY_COMPASS_Exported_Macros Exported Macros
00068   * @{
00069   */
00070 
00071 /**
00072   * @}
00073   */
00074 
00075 /* Exported functions --------------------------------------------------------*/
00076 /** @defgroup STM32L476G_DISCOVERY_COMPASS_Exported_Functions Exported Functions
00077   * @{
00078   */
00079 /* COMPASS functions */
00080 COMPASS_StatusTypeDef   BSP_COMPASS_Init(void);
00081 void                    BSP_COMPASS_DeInit(void);
00082 void                    BSP_COMPASS_LowPower(void);
00083 void                    BSP_COMPASS_MagGetXYZ(int16_t *pDataXYZ);
00084 void                    BSP_COMPASS_AccGetXYZ(int16_t *pDataXYZ);
00085 
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 /**
00095   * @}
00096   */
00097 
00098 /**
00099   * @}
00100   */
00101 
00102 #ifdef __cplusplus
00103 }
00104 #endif
00105 
00106 #endif /* __STM32L476G_DISCOVERY_COMPASS_H */
00107 
00108 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/