Proj-2014-2015-ESP8266/SRS - Revision history

Luc.Libralesso: /* 3.1 Requirement X.Y.Z (in Structured Natural Language) */

2015-01-26T15:40:15Z

3.1 Requirement X.Y.Z (in Structured Natural Language)

← Older revision		Revision as of 15:40, 26 January 2015
Line 117:		Line 117:
	'''Destination''': All the people who is interested in the IoT.		'''Destination''': All the people who is interested in the IoT.

			'''Action''': Compiles Python to C++ and compile C++ to assembly language for a specific chip.
	'''Action''':

2015-01-26T15:39:21Z

3.1 Requirement X.Y.Z (in Structured Natural Language)

← Older revision		Revision as of 15:39, 26 January 2015
Line 132:		Line 132:

	'''Pre-condition''':		'''Pre-condition''':

			* the use must have the required hardware (card, cable) and software (Xtensa installed)

	'''Post-condition''':		'''Post-condition''':

			* The user gets a compiled version of his program on his chip.

	'''Side-effects''':		'''Side-effects''':

2015-01-26T15:31:24Z

1.3 Definitions, acronyms and abbreviations

← Older revision		Revision as of 15:31, 26 January 2015
Line 47:		Line 47:
	==1.3 Definitions, acronyms and abbreviations==		==1.3 Definitions, acronyms and abbreviations==

	* Toolchain : set of tools that compiles a program for a given processor		* Toolchain : set of tools that compiles a program for a given processor
	* C,C++,python: Programming languages		* C,C++,python: Programming languages
	* high level language : a language alike natural language		* high level language : a language alike natural language
	* low level language : a language alike assembly language		* low level language : a language alike assembly language
	* IoT : Internet of Things		* IoT : Internet of Things

	==1.4 References==		==1.4 References==

2015-01-26T15:31:15Z

2.2 Product functions

← Older revision		Revision as of 15:31, 26 January 2015
Line 73:		Line 73:
	Functions :		Functions :

	* Compile Python files to C++ files		* Compile Python files to C++ files
	* Run executables on some processors (like ESP8266)		* Run executables on some processors (like ESP8266)


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

2015-01-26T15:31:07Z

2.3 User characteristics

← Older revision		Revision as of 15:31, 26 January 2015
Line 81:		Line 81:
	Users need to be able to :		Users need to be able to :

	* Use command line		* Use command line
	* Compile Xtensa and others toolchains		* Compile Xtensa and others toolchains
	* Connect their device to the USB port of their PC for UART		* Connect their device to the USB port of their PC for UART


	==2.4 General constraints==		==2.4 General constraints==

2015-01-26T15:30:58Z

2.4 General constraints

← Older revision		Revision as of 15:30, 26 January 2015
Line 88:		Line 88:
	==2.4 General constraints==		==2.4 General constraints==

	* Hardware limitations : On some devices like ESP8266, memory heap is limited		* Hardware limitations : On some devices like ESP8266, memory heap is limited so, we need to have a compiler that makes small executables.
		⚫	* Parallel operations : For the wifi feature, we need to have a real time system. Consequently, it's difficult to implement a garbage collector.
	so, we need to have a compiler that makes small executables.
⚫	* Parallel operations : For the wifi feature, we need to have a real time system.
	Consequently, it's difficult to implement a garbage collector.

	==2.5 Assumptions and dependencies==		==2.5 Assumptions and dependencies==

2015-01-26T15:30:47Z

2.4 General constraints

← Older revision		Revision as of 15:30, 26 January 2015
Line 88:		Line 88:
	==2.4 General constraints==		==2.4 General constraints==

	* Hardware limitations : On some devices like ESP8266, memory heap is limited		* Hardware limitations : On some devices like ESP8266, memory heap is limited
	so, we need to have a compiler that makes small executables.		so, we need to have a compiler that makes small executables.
		⚫	* Parallel operations : For the wifi feature, we need to have a real time system.

		⚫	Consequently, it's difficult to implement a garbage collector.
⚫	* Parallel operations : For the wifi feature, we need to have a real time system.
⚫	Consequently, it's difficult to implement a garbage collector.


	==2.5 Assumptions and dependencies==		==2.5 Assumptions and dependencies==

2015-01-26T15:30:34Z

2.5 Assumptions and dependencies

← Older revision		Revision as of 15:30, 26 January 2015
Line 99:		Line 99:
	We assume that :		We assume that :

	* The user has a serial cable to bind his PC and his card.		* The user has a serial cable to bind his PC and his card.

	=3.Specific requirements, covering functional, non-functional and interface requirements=		=3.Specific requirements, covering functional, non-functional and interface requirements=

2015-01-26T15:30:24Z

3.1 Requirement X.Y.Z (in Structured Natural Language)

← Older revision		Revision as of 15:30, 26 January 2015
Line 130:		Line 130:

	'''Non functional requirements''':		'''Non functional requirements''':

			* maintenance : scaleable code
			* robust : each command is correctly executed
			* useable : easy to use and get started with
			* ethic : free software and well crafted code (PEP8 tests for instance)
			* space : the memory heap limited on ESP8266 so we need a small executable file

	'''Pre-condition''':		'''Pre-condition''':

2015-01-26T15:29:34Z

3.1 Requirement X.Y.Z (in Structured Natural Language)

← Older revision		Revision as of 15:29, 26 January 2015
Line 109:		Line 109:

	==3.1 Requirement X.Y.Z (in Structured Natural Language)==		==3.1 Requirement X.Y.Z (in Structured Natural Language)==
⚫	'''~~Function~~''':

			'''Function''': Provide a way to compile python to C++ and C++ to assembly language for a specific chip.
	'''Description''':

			'''Description''': Our project consists to use a previous work at Polytech'Grenoble to implement
	'''Inputs''':
			a python-C++ translator and use the Xtensa toolchain to compile programs on ESP8266.

			'''Inputs''': Source program in python2.7 and a given microchip (here ESP8266)
	'''Source''':

			'''Source''': a compiler python-C++ (Shedskin) with a toolchain (Xtensa)
	'''Outputs''':

			'''Outputs''': a program uploaded on the card compiled from the input source program.
	'''Destination''':

			'''Destination''': All the people who is interested in the IoT.
	'''Action''':

		⚫	'''Action''':