STM32CubeF1/Projects/STM3210E_EVAL/Applications/STemWin/STemWin_HelloWorld/readme.txt

80 lines
3.4 KiB
Plaintext

/**
@page STemWin_HelloWorld Readme file
@verbatim
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
* @file STemWin_HelloWorld/readme.txt
* @author MCD Application Team
* @brief
******************************************************************************
* @attention
*
* <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
* All rights reserved.</center></h2>
*
* This software component is licensed by ST under Ultimate Liberty license
* SLA0044, the "License"; You may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* www.st.com/SLA0044
*
******************************************************************************
@endverbatim
@par Description
Simple "Hello World" example based on STemWin.
The example allows also to run the different Segger samples that can be
downloaded from here:
http://www.segger.com/emwin-samples.html
To do this, user has only to replace the file "Basic_HelloWorld.c" into the
project workspace by the downloaded one.
Note that the following user files may need to be updated:
LCDConf_stm3210e_eval.c
GUIConf_stm3210e_eval.c
(if for example more GUI allocated memory is needed)
@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 need to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Directory contents
- STemWin/STemWin_HelloWorld/Inc/GUIConf.h Header for GUIConf_stm3210e_eval.c
- STemWin/STemWin_HelloWorld/Inc/LCDConf_stm3210e_eval.h Header for LCDConf_stm3210e_eval.c
- STemWin/STemWin_HelloWorld/Inc/stm32f1xx_hal_conf.h HAL configuration file
- STemWin/STemWin_HelloWorld/Inc/stm32f1xx_it.h Interrupt handlers header file
- STemWin/STemWin_HelloWorld/Inc/main.h Header for main.c module
- STemWin/STemWin_HelloWorld/Src/stm32f1xx_it.c Interrupt handlers
- STemWin/STemWin_HelloWorld/Src/BASIC_HelloWorld.c Simple demo drawing "Hello world"
- STemWin/STemWin_HelloWorld/Src/GUIConf_stm3210e_eval.c Display controller initialization
- STemWin/STemWin_HelloWorld/Src/LCDConf_stm3210e_eval.c Configuration file for the GUI library
- STemWin/STemWin_HelloWorld/Src/main.c Main program
- STemWin/STemWin_HelloWorld/Src/system_stm32f1xx.c STM32F1xx system source file
@par Hardware and Software environment
- This example runs on STM32F103xG devices.
- This example has been tested with STM3210E-EVAL RevD board and can be
easily tailored to any other supported device and development board.
@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 example
* <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
*/