Proj-2013-2014-Python-STM32F4:SRS: Difference between revisions
Line 39: | Line 39: | ||
=2. General description= |
=2. General description= |
||
==2.1 Product perspective== |
==2.1 Product perspective== |
||
* '''System intefaces''' |
|||
//TODO diagram to add |
|||
1. With the help of the project Shed Skin, firstly we compile the users’ input python source code(.py) to C++ code(.cpp, .hpp, Makefile). |
|||
2. The core part of this project is to modify the Makefile, to add necessary initialisation to the C++ code generated by Shed Skin and to add other needed files (linder.ld, etc) and libraries to make it compilable by the compiler arm-none-eabi-g++. |
|||
3. With the help of the GNU/ARM toolchain (command arm-none-eabi-g++), compile the program and obtain the executable file *.bin. |
|||
4. To use the tool ST-LINK which is an in-circuit debugger and programmer for the STM8 and STM32 microcontroller families to write the executable file .bin to the board. |
|||
* '''User interfaces''' |
|||
The command line style will be used as the user interface of this programme. And the specific error messages will be returned to the user when error occurs. |
|||
* '''Hardware interfaces''' |
|||
The programme should be run on Linux System. |
|||
The STM32F407 is used as the targed board. |
|||
* '''Software interfaces''' |
|||
Shed Skin |
|||
GNU/ARM toolchain |
|||
ST-LINK |
|||
==2.2 Product functions== |
==2.2 Product functions== |
||
==2.3 User characteristics== |
==2.3 User characteristics== |
Revision as of 19:23, 16 February 2014
This document describes the software requirements specification of the project Proj-2013-2014-Python-STM32F4
Version | Date | Authors | Description | Validator | Validation Date | |
---|---|---|---|---|---|---|
0.1.0 | 10 févr. 2014 | TAO Xinxiu, XIA ye | SRS | TBC | TBC |
1. Introduction
1.1 Purpose of the requirements document
The purpose of this requirements document is to present the requirements and specifications of the project Proj-2013-2014-Python-STM32F4. The document explains the purpose and functional features of the system, the interfaces details of the system, what the system will do, the constraints under which it must operate.
The intended audiences of this document is the users, the developers and the tutor of the project.
1.2 Scope of the product
The project aim to compile Python programs to run them on the board STM32F4. This project will use the project Shedskin which is a python-to-C++ compiler. The main function of the project is to compile the C++ code which is generated by the compiler Shed Skin to executable code which can be run on the board STM32F4. Instead of modifying the project Shed Skin, we will just compile the C++ code files and the Makefile file to make it executable on the board.
// TODO: chart to added
1.3 Definitions, acronyms and abbreviations
1.4 References
1.5 Overview of the remainder of the document
2. General description
2.1 Product perspective
- System intefaces
//TODO diagram to add
1. With the help of the project Shed Skin, firstly we compile the users’ input python source code(.py) to C++ code(.cpp, .hpp, Makefile).
2. The core part of this project is to modify the Makefile, to add necessary initialisation to the C++ code generated by Shed Skin and to add other needed files (linder.ld, etc) and libraries to make it compilable by the compiler arm-none-eabi-g++.
3. With the help of the GNU/ARM toolchain (command arm-none-eabi-g++), compile the program and obtain the executable file *.bin.
4. To use the tool ST-LINK which is an in-circuit debugger and programmer for the STM8 and STM32 microcontroller families to write the executable file .bin to the board.
- User interfaces
The command line style will be used as the user interface of this programme. And the specific error messages will be returned to the user when error occurs.
- Hardware interfaces
The programme should be run on Linux System. The STM32F407 is used as the targed board.
- Software interfaces
Shed Skin GNU/ARM toolchain ST-LINK
2.2 Product functions
2.3 User characteristics
2.4 General constraints
2.5 Assumptions and dependencies
3.Specific requirements, covering functional, non-functional and interface requirements
- document external interfaces,
- describe system functionality and performance
- specify logical database requirements,
- design constraints,
- emergent system properties and quality characteristics.
3.1 Requirement X.Y.Z (in Structured Natural Language)
Function:
Description:
Inputs:
Source:
Outputs:
Destination:
Action:
- Natural language sentences (with MUST, MAY, SHALL)
- Graphical Notations : UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
- Mathematical Notations
- Tabular notations for several (condition --> action) tuples
Non functional requirements:
Pre-condition:
Post-condition:
Side-effects: