Revision as of 23:06, 17 February 2013

Document History
	Version	Date	Authors	Description	Validator	Validation Date
	1.0	Feb. 11, 2013	GU Minyi, FENG Xu, GUO Tianming	SRS of the project	-	-

1 Introduction

1.1 Purpose

The purpose of this document is to present a detailed description of Arduino STM32 Discovery. It will explain the purpose and features of the system Arduino, what the system will do,how we use the carte STM32 in the environment Arduino, the constraints under which it must operate ,how the system will react to external stimuli. This document is intended for both the stakeholders and the developers of the system.

1.2 Scope of the project

Our objective is to use the STM32 Discovery cards, especially F3 and F0, with the same simplicity and an environment comparable to Arduino. So our system is based on Arduino, we added the library of STM32 and the Board of STM32 into it . We use this system to put some programmes into the cards of the arms, in order to realize some functions.

We hope that these cards can be used for TPs and project initiation technology embedded.

1.3 Definitions, acronyms and abbreviations


	Term	Definition
	Arduino	This is an open-source electronics prototyping platform based on flexible, easy-to-use hardware and software. It's intended for artists, designers, hobbyists, and anyone interested in creating interactive objects or environments.
	STM32 Discovery	It is an ultra-low-cost and convenient starter platform, the STM32 Discovery Kit is particularly suited to the STM32 Value Line microcontrollers.
	F0, F3	They are the different types of STM32.
	TP	It’s ‘Des Traveaux Pratiques’ in French. They are prepared for students to practice.
	Stakeholder	Any person with an interest in the project who is not a developer.
	Software Requirements Specification	A document that completely describes all of the functions of a proposed system and the constraints under which it must operate. For example, this document.

1.4 References

1.5 Overview of the document

The next chapter, the General Description section, of this document gives an overview of the functionality of the product. It describes the informal requirements and is used to establish a context for the technical requirements specification in the next chapter.

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

Both sections of the document describe the same software product in its entirety, but are intended for different audiences and thus use different language.

2 General description

2.1 Product perspective

We should know how to use the card Arduino and the environment Arduino, before we begin work on STM32. Then , we need to know how to use the card STM32 with OpenOCD.

2.2 Product functions

There are the functions of our system, as follows:

The environment Arduino can discriminate the card STM32.
When the user chooses whichever example in Arduino , it can be verified.
After being verified, we can upload the example which was verified into the card STM32.

2.3 User characteristics

The user characteristics are as follows:

educational level: certificate with computer and software
experience: no require
technical expertise: know some basic operates with the assembler language

2.4 General constraints

There are some general constraints as follows:

Hardware limitations:

Operating System: Windows, Mac OS X,Linux

USB port: 2.0

Higher-order language requirements : Java and C++

2.5 Assumptions and dependencies

Assumptions:

A specific operating system will be available on the hardware designated for the software product. If, in fact, the operating system is not available, the SRS would then have to change accordingly.

3 Specific requirements

3.1 External interfaces

The only link to an external software is the link to the cards STM32 to upload the programmes in it. The environment Arduino use this link to discriminate the card is belong to which board. The user chooses the board and upload a programme in a card to realize some functions.

3.2 Functions

Funciton: Verify the code
	Description	The programme which we choose should be verified before upload.
	Inputs	A programme in the examples.
	Source	They are in the document of the examples.
	Outputs	It is succeeded or not.
	Destination	The code must be verified if there are the errors.
	Action	Verification

Funciton: Upload
	Description	To put the programme which is verified into the card.
	Inputs	The programme which is verified.
	Source	In the software.
	Outputs	It is succeeded or not.
	Destination	To put the programme into the card.
	Action	Upload

3.3 Performance requirements

Dynamic numerical requirements:

90% of the operations shall be processed in less than 15s.
There should be 2 programmes which are verifying at the same time.

Static numerical requirements:

The number of terminals to supported : 1
The number of simultaneous users : 1
There are more than 1 programme to be handled.

3.4 Design constraints

We suppose to use Linux for installing the environment Arduino. And USB port should more than 2.0.

3.5 Non-Functional requirements

The software developed here assumes the use of a tool such as USB for connection between the card STM32 and the environment Arduino. The environment Arduino will run on the editor’s PC and will contain a library of STM32 which is already added into this software.

4 Product evolution

When the software has been modified, it should be used by the card of STM32 F3. We can use it to upload some programmes in STM32 F3 to realize some functions.

5 Appendices

There are some schemes of UML for the functions of the project in the document of UML.

6 Index

[1] Ian Sommerville, Software Engineering 9th edition,[M] Pub. Pearson.

[2] Software Engineering Standards Committee of the IEEE Computer Society,IEEE Recommended Practice for Software Requirements Specifications[EB/OL], http://www.cse.msu.edu/~chengb/RE-491/Papers/IEEE-SRS-practice.pdf

Difference between revisions of "Proj-2012-2013-arduino-stm32disco:SRS"