Proj-2013-2014-Python-STM32F4:SRS - Revision history

RICM4-prj14-grp9: /* 3.1 Document External Interfaces */

2014-02-17T13:34:56Z

3.1 Document External Interfaces

← Older revision		Revision as of 13:34, 17 February 2014
Line 119:		Line 119:
	==3.1 Document External Interfaces==		==3.1 Document External Interfaces==

	The ~~project’s~~ only external interface to users is the command pythonSTM32 following with the options and the input file. The output of the program is the execution of the program on the board STM32 which is connected to the user’s computer, this program is right compiled from the users’ input python code.		The project's only external interface to users is the command pythonSTM32 following with the options and the input file. The output of the program is the execution of the program on the board STM32 which is connected to the user’s computer, this program is right compiled from the users’ input python code.


	==3.2 Function Requirements==		==3.2 Function Requirements==

RICM4-prj14-grp9: /* 2.1 Product perspective */

2014-02-17T13:34:21Z

2.1 Product perspective

← Older revision		Revision as of 13:34, 17 February 2014
Line 55:		Line 55:

	* '''System intefaces'''		* '''System intefaces'''
			[[File:PythonSurSTM32_SRS_1.png\|800px]]
	//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).		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).

RICM4-prj14-grp9: /* 1.2 Scope of the product */

2014-02-17T13:32:37Z

1.2 Scope of the product

← Older revision		Revision as of 13:32, 17 February 2014
Line 31:		Line 31:
	==1.2 Scope of the product==		==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.		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: diagram to add

	==1.3 Definitions, acronyms and abbreviations==		==1.3 Definitions, acronyms and abbreviations==

RICM4-prj14-grp9: /* 1.5 Overview of the remainder of the document */

2014-02-16T20:10:33Z

1.5 Overview of the remainder of the document

← Older revision		Revision as of 20:10, 16 February 2014
Line 48:		Line 48:

	==1.5 Overview of the remainder of the document==		==1.5 Overview of the remainder of the document==

			The second chapter describes the general factors that affect the project and its requirements. This section does not state specific requirements, instead, it is used to establish a context for the those requirements specification in the next chapter.

			The third chapter, Requirements Specification section, of this document is written primarily for the developers and describes the details of the functionality of the product.

	=2. General description=		=2. General description=
	==2.1 Product perspective==		==2.1 Product perspective==

RICM4-prj14-grp9: /* 1.4 References */

2014-02-16T20:01:25Z

1.4 References

← Older revision		Revision as of 20:01, 16 February 2014
Line 42:		Line 42:

	==1.4 References==		==1.4 References==
			* http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
			* http://en.wikipedia.org/wiki/Software_requirements_specification
			* [http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998]
			* [https://code.google.com/p/shedskin/wiki/docs ShedSkin]

	==1.5 Overview of the remainder of the document==		==1.5 Overview of the remainder of the document==
	=2. General description=		=2. General description=

RICM4-prj14-grp9: /* 3.2 Function Requirements */

2014-02-16T20:00:04Z

3.2 Function Requirements

← Older revision		Revision as of 20:00, 16 February 2014
Line 129:		Line 129:
	'''Destination''': To generate the executable file for the board STM32 from these C++ codes.		'''Destination''': To generate the executable file for the board STM32 from these C++ codes.

	'''Action''': ~~TBC~~(The function may be resolved by adding correspond libraries or/and compile the correspond part of C++ code.)		'''Action''': TBD(The function may be resolved by adding correspond libraries or/and compile the correspond part of C++ code.)

	'''Pre-condition''': The C++ code generated by Shed Skin is correct.		'''Pre-condition''': The C++ code generated by Shed Skin is correct.
Line 149:		Line 149:
	'''Destination''': To generate the executable file which implement GC for these C++ codes.		'''Destination''': To generate the executable file which implement GC for these C++ codes.

	'''Action''': ~~TBC~~(The function may be resolved by adding correspond libraries or/and compile the correspond part of C++ code.)		'''Action''': TBD(The function may be resolved by adding correspond libraries or/and compile the correspond part of C++ code.)

	'''Pre-condition''': The C++ code generated by Shed Skin are right.		'''Pre-condition''': The C++ code generated by Shed Skin are right.

RICM4-prj14-grp9: /* 1.3 Definitions, acronyms and abbreviations */

2014-02-16T19:59:32Z

1.3 Definitions, acronyms and abbreviations

← Older revision		Revision as of 19:59, 16 February 2014
Line 35:		Line 35:

	==1.3 Definitions, acronyms and abbreviations==		==1.3 Definitions, acronyms and abbreviations==

			* STL: Standard Template Library
			* GC: Garbage Collection
			* PCRE: Perl Compatible Regular Expressions
			* TBD: To Be Determined

	==1.4 References==		==1.4 References==
	==1.5 Overview of the remainder of the document==		==1.5 Overview of the remainder of the document==

RICM4-prj14-grp9: /* 2.2 Product functions */

2014-02-16T19:55:08Z

2.2 Product functions

← Older revision		Revision as of 19:55, 16 February 2014
Line 67:		Line 67:

	==2.2 Product functions==		==2.2 Product functions==

			The main purpose of the project is to generate the executable file of the board STM32F407 from the C++ code which is generated by the program Shed Skin. To achieve this goal, the project should embody the following features and functions:

			* support STL(Standard Template Library)
			* support Lib C
			* support GC(Garbage Collection)
			* support libprce(Perl Compatible Regular Expressions)

	==2.3 User characteristics==		==2.3 User characteristics==

RICM4-prj14-grp9: /* 2.5 Assumptions and dependencies */

2014-02-16T19:53:58Z

2.5 Assumptions and dependencies

← Older revision		Revision as of 19:53, 16 February 2014
Line 87:		Line 87:
	==2.5 Assumptions and dependencies==		==2.5 Assumptions and dependencies==

	The project assume that the users’ input python code observe these limitations listed [ [1]]:		The project assume that the users’ input python code observe these limitations listed [http://air.imag.fr/index.php/Proj-2013-2014-Python-STM32F4:SRS#6._Index [1]]:
	* Only builtin scalar and container types (int, float, complex, bool, str, list, tuple, dict, set) as well as None and instances of user-defined classes can be passed/returned. So for instance, anonymous functions and iterators are currently not supported.		* Only builtin scalar and container types (int, float, complex, bool, str, list, tuple, dict, set) as well as None and instances of user-defined classes can be passed/returned. So for instance, anonymous functions and iterators are currently not supported.
	* Builtin objects are completely converted for each call/return from Shed Skin to CPython types and back, including their contents. This means you cannot change CPython builtin objects from the Shed Skin side and vice versa, and conversion may be slow. Instances of user-defined classes can be passed/returned without any conversion, and changed from either side.		* Builtin objects are completely converted for each call/return from Shed Skin to CPython types and back, including their contents. This means you cannot change CPython builtin objects from the Shed Skin side and vice versa, and conversion may be slow. Instances of user-defined classes can be passed/returned without any conversion, and changed from either side.

RICM4-prj14-grp9: /* 6. Index */

2014-02-16T19:50:37Z

6. Index

← Older revision		Revision as of 19:50, 16 February 2014
Line 145:		Line 145:
	=5. Appendices=		=5. Appendices=
	=6. Index=		=6. Index=
			[1]https://code.google.com/p/shedskin/wiki/docs#Limitations