STM32CubeF4/Projects/STM32469I-Discovery/Applications/Display/LCD_Paint
Ali Labbene b5abca20c9 Release v1.24.1 2019-08-05 13:05:39 +01:00
..
EWARM Release v1.24.1 2019-08-05 13:05:39 +01:00
Inc Release v1.24.1 2019-08-05 13:05:39 +01:00
MDK-ARM Release v1.24.1 2019-08-05 13:05:39 +01:00
SW4STM32 Release v1.24.1 2019-08-05 13:05:39 +01:00
Src Release v1.24.1 2019-08-05 13:05:39 +01:00
readme.txt Release v1.24.1 2019-08-05 13:05:39 +01:00

readme.txt

/**
  @page LCD_Paint LCD Paint application
  
  @verbatim
  ******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
  * @file    Display/LCD_Paint/readme.txt 
  * @author  MCD Application Team
  * @brief   
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics International N.V. 
  * All rights reserved.</center></h2>
  *
  * Redistribution and use in source and binary forms, with or without 
  * modification, are permitted, provided that the following conditions are met:
  *
  * 1. Redistribution of source code must retain the above copyright notice, 
  *    this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
  * 3. Neither the name of STMicroelectronics nor the names of other 
  *    contributors to this software may be used to endorse or promote products 
  *    derived from this software without specific written permission.
  * 4. This software, including modifications and/or derivative works of this 
  *    software, must execute solely and exclusively on microcontroller or
  *    microprocessor devices manufactured by or for STMicroelectronics.
  * 5. Redistribution and use of this software other than as permitted under 
  *    this license is void and will automatically terminate your rights under 
  *    this license. 
  *
  * THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" 
  * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT 
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
  * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
  * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT 
  * SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
   @endverbatim

@par Application Description

 This application describes how to configure LCD touch screen and attribute 
 an action related to configured touch zone and how to save BMP picture in SDCard.
 
 At the beginning of the main program the HAL_Init() function is called to reset 
 all the peripherals, initialize the Flash interface and the systick.
 Then the SystemClock_Config() function is used to configure the system
 clock (SYSCLK) to run at 180 MHz. 

 After LCD and touch screen initialization, touchscreen calibration is requested
 for better accuracy, then, menu is displayed on the screen. 
 
 The menu contains palette of colors, clear icon, save icon, different kind 
 of draw size, the current selected size, selected color and working rectangle. 

 Select one of proposed colors and select the size of brush to draw 
 inside the working rectangle.
 
 Clear the working window by pressing the clear icon or/and save the picture 
 in SDCard by pressing the save icon.

                                          LCD Menu
               ____________________________________________________________
          /   |______|---------------------------------------------------- |
          |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||                                                   ||
palette   |   |______||               Working Rectangle                   ||
   of   __|   |______||                                                   ||
 Colors   |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||                                                   ||
          |   |______||___________________________________________________|| 
          \   |______|__________________ _________        __               | 
              |clear |  choose the brush|   Save  |      |__|         O    | 
              |______|________size______|__SDCard_|__selected color__size__|


  - LED1 is on to indicate the end of saving operation.
  - LED3 is ON when any error occurs.

Note: After save operation, the touch positions are not cleared from STMPE811 FIFO 
      and the next touch in any positions of the LCD screen leads second save 
      operation.


@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
      based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
      a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
      than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
      To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
      
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Directory contents

    - Display/LCD_Paint/Inc/main.h                      Main program header file
    - Display/LCD_Paint/Inc/sd_diskio.h                 FatFS sd diskio driver header file
    - Display/LCD_Paint/Inc/stm32f4xx_it.h              Interrupt handlers header file
    - Display/LCD_Paint/Inc/stm32f4xx_hal_conf.h        HAL Configuration file 
    - Display/LCD_Paint/Inc/color.h                     Image used for LCD Validation
    - Display/LCD_Paint/Inc/save.h                      Image used for LCD Validation 
    - Display/LCD_Paint/Inc/fatfs_storage.h             Header for fatfs_storage.c
    - Display/LCD_Paint/Inc/ffconf.h                    FAT file system module configuration file
    - Display/LCD_Paint/Src/main.c                      Main program  
    - Display/LCD_Paint/Src/sd_diskio.c                 FatFS sd diskio driver implementation
    - Display/LCD_Paint/Src/stm32f4xx_it.c              Interrupt handlers
    - Display/LCD_Paint/Src/system_stm32f4xx.c          STM32F4xx system clock configuration file
    - Display/LCD_Paint/Src/ts_calibration.c            Touchscreen calibration driver
    - Display/LCD_Paint/Src/fatfs_storage.c             Storage (FatFs) driver


@par Hardware and Software environment

  - This application runs on STM32F469xx devices.

  - This application has been tested with STM32469I-DISCOVERY discovery board 
    and can be easily tailored to any other supported device and development board.

  - STM32469I-DISCOVERY Set-up
   - Connect a uSD Card to the Micro SD connector (CN9). 


@par How to use it ?

In order to make the program work, you must do the following :
 - Open your preferred toolchain 
 - Rebuild all files and load your image into target memory
 - Run the application
  
 * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */