Diff: readme.txt

Revision:

0:c00e6c923941

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.txt	Mon Nov 02 23:38:08 2015 +0000
@@ -0,0 +1,127 @@
+/**
+  @page Demo   STM32746G-DISCO Demonstration Firmware
+ 
+  @verbatim
+  ******************** (C) COPYRIGHT 2015 STMicroelectronics *******************
+  * @file    Demonstrations/readme.txt 
+  * @author  MCD Application Team
+  * @version V1.1.0
+  * @date    21-September-2015
+  * @brief   Description of STM32746G-DISCO Demonstration
+  ******************************************************************************
+  *
+  * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
+  * You may not use this file except in compliance with the License.
+  * You may obtain a copy of the License at:
+  *
+  *        http://www.st.com/software_license_agreement_liberty_v2
+  *
+  * Unless required by applicable law or agreed to in writing, software 
+  * distributed under the License is distributed on an "AS IS" BASIS, 
+  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  * See the License for the specific language governing permissions and
+  * limitations under the License.
+  *
+  ******************************************************************************
+  @endverbatim
+
+@par Demo Description
+
+The STM32Cube Demonstration platform comes on top of the STM32CubeTM as a firmware
+package that offers a full set of software components based on a modules architecture
+allowing re-using them separately in standalone applications. All these modules are
+managed by the STM32Cube Demonstration kernel allowing to dynamically adding new
+modules and access to common resources (storage, graphical components and widgets,
+memory management, Real-Time operating system)
+
+The STM32Cube Demonstration platform is built around the powerful graphical library
+STemWin and the FreeRTOS real time operating system and uses almost the whole STM32
+capability to offer a large scope of usage based on the STM32Cube HAL BSP and several
+middleware components.
+
+@par Demo Description
+
+The STM32 F7 demonstration is running on STM32746G-DISCOVERY boards RevB. 
+
+  
+Below you find an overview of the different offered module in the demonstration:
+
+ + Video player
+ --------------
+ The video player module provides a video solution based on the STM32F7xx and STemWin
+ movie API. It supports playing movie in emf format.
+ 
+ + Audio player
+ --------------
+ The audio player module provides a complete audio solution based on the STM32F7xx and
+ delivers a high-quality music experience. It supports playing music in WAV format but may
+ be extended to support other compressed formats such as MP3 and WMA audio formats.
+ The Module supports background mode feature.
+ 
+  + Audio recorder
+ -----------------
+ The audio recorder module allows recording audio and playing it back.
+ 
+ + VNC Server
+ ------------
+ The VNC server module allows to control the demo from a remote machine. It is based on
+ the TCP/IP LwIP stacks. The background mode is supported.
+ 
+ + Audio Recorder
+ ----------------
+ The Audio record module allows to record an audio file. The audio format supported is 
+ WAV format but may be extended to support other compressed formats such as MP3.
+ The recorded files are stored in USB Disk flash(USB High Speed).
+  
+ + Home alarm
+ ------------ 
+ Control of Home alarm system, equipped with cameras.
+ Static picture shown when a room is selected and then the camera icon pressed
+ General room alarm activation/deactivation when pressed.
+ 
+ + Gardening control
+ -------------------
+ The gardening control module provides a graphic garden watering system behaviour
+ 
+ + Game
+ ------
+ The game coming in the STM32Cube demonstration is based on the Reversi game. It is a
+ strategy board game for two players, played on an 8×8 board. The goal of the game is to
+ have the majority of disks turned to display your color when the last playable empty square
+ is filled.
+ 
+ + System Info
+ --------------  
+ The system info module provides information about the core, supported eval boards, 
+ CPU speed and demonstration version.  
+    
+    For more details about the demonstration modules please refers to  STM32CubeF7 demonstration (UM1906)
+    
+@note The STM32F7xx devices can reach a maximum clock frequency of 216MHz but as this demonstration uses SDRAM,
+      the system clock is limited to 200MHz. Indeed proper functioning of the SDRAM is only guaranteed 
+      at a maximum system clock frequency of 200MHz.
+      
+@par Hardware and Software environment
+
+  - This application runs on STM32F746xx devices.  
+
+  - This example has been tested with STMicroelectronics STM32746G_DISCOVERY
+    boards RevB 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
+ - Open STM32 ST-Link Utility V3.7, click on "External Loader" from the bar menu then check "N25Q128A_STM32F746G-DISCO" box 
+ - Connect the STM32746G-DISCOVERY board to PC with USB cable through CN14
+ - Use "STM32CubeDemo_STM32746G-DISCO_V1.1.0.hex" file with STM32 ST-Link Utility to program both internal Flash and external QSPI memory
+ - Run the demonstration
+ - copy the audio and video files provided under "Utilities/Media/" in the USB key
+ - Plug a USB micro A-Male to A-Female cable on CN12 connector 
+     
+ * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
+ */
+