STM32L0538-Discovery BSP User Manual: stm32l0538_discovery_epd.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l0538_discovery_epd.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for the 
00006   *          stm32l0538_discovery_epd.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036   
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32L0538_DISCOVERY_EPD_H
00039 #define __STM32L0538_DISCOVERY_EPD_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "../Components/gde021a1/gde021a1.h"
00047 #include "fontsepd.h"
00048 
00049 /** @addtogroup BSP
00050   * @{
00051   */
00052 
00053 /** @addtogroup STM32L0538_DISCOVERY
00054   * @{
00055   */
00056 
00057 /** @defgroup STM32L053_DISCOVERY_EPD
00058   * @{
00059   */
00060 
00061 
00062 /** @defgroup STM32L0538_DISCOVERY_EPD_Exported_Types
00063   * @{
00064   */
00065 typedef enum
00066 {
00067   EPD_OK = 0,
00068   EPD_ERROR = 1,
00069   EPD_TIMEOUT = 2
00070 } EPD_StatusTypeDef;
00071 
00072 /**
00073   * @brief  Line mode structures definition
00074   */
00075 typedef enum
00076 {
00077   CENTER_MODE             = 0x01,    /*!< Center mode */
00078   RIGHT_MODE              = 0x02,    /*!< Right mode  */
00079   LEFT_MODE               = 0x03     /*!< Left mode   */
00080 } Text_AlignModeTypdef;
00081 
00082 /**
00083   * @}
00084   */
00085 
00086 /** @defgroup STM32L0538_DISCOVERY_EPD_Exported_Constants
00087   * @{
00088   */
00089 
00090 /**
00091   * @brief  EPD color
00092   */
00093 #define EPD_COLOR_BLACK         0x00
00094 #define EPD_COLOR_DARKGRAY      0x55
00095 #define EPD_COLOR_LIGHTGRAY     0xAA
00096 #define EPD_COLOR_WHITE         0xFF
00097 
00098 /**
00099   * @brief EPD default font
00100   */
00101 #define EPD_DEFAULT_FONT         Font12
00102 
00103 /**
00104   * @}
00105   */
00106 
00107 /** @defgroup STM32L0538_DISCOVERY_EPD_Exported_Functions
00108   * @{
00109   */
00110 uint8_t  BSP_EPD_Init(void);
00111 uint32_t BSP_EPD_GetXSize(void);
00112 uint32_t BSP_EPD_GetYSize(void);
00113 
00114 void     BSP_EPD_SetFont(sFONT *pFonts);
00115 sFONT    *BSP_EPD_GetFont(void);
00116 
00117 void     BSP_EPD_Clear(uint16_t Color);
00118 
00119 void     BSP_EPD_DisplayStringAtLine(uint16_t Line, uint8_t *ptr);
00120 void     BSP_EPD_DisplayStringAt(uint16_t Xpos, uint16_t Ypos, uint8_t *pText, Text_AlignModeTypdef mode);
00121 void     BSP_EPD_DisplayChar(uint16_t Xpos, uint16_t Ypos, uint8_t Ascii);
00122 
00123 void     BSP_EPD_DrawHLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00124 void     BSP_EPD_DrawVLine(uint16_t Xpos, uint16_t Ypos, uint16_t Length);
00125 void     BSP_EPD_DrawRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00126 void     BSP_EPD_FillRect(uint16_t Xpos, uint16_t Ypos, uint16_t Width, uint16_t Height);
00127 
00128 void     BSP_EPD_RefreshDisplay(void);
00129 
00130 void     BSP_EPD_CloseChargePump(void);
00131 
00132 void     BSP_EPD_DrawImage(uint16_t Xpos, uint16_t Ypos, uint16_t Xsize, uint16_t Ysize, uint8_t *pdata);
00133 
00134 #ifdef __cplusplus
00135 }
00136 #endif
00137 
00138 #endif /* __STM32L0538_DISCOVERY_EPD_H */
00139 
00140 /**
00141   * @}
00142   */
00143 
00144 /**
00145   * @}
00146   */
00147 
00148 /**
00149   * @}
00150   */
00151 
00152 /**
00153   * @}
00154   */
00155 
00156 /*********************** (C) COPYRIGHT STMicroelectronics *****END OF FILE****/