Difference between revisions of "Projet-2014-2015-RobAIR/SRS"

From air
Jump to navigation Jump to search
(Created page with "The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard. '''Read first:''' * http://www.cs.st-an...")
 
Line 1: Line 1:
−
The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.
  
−  
−  
⚫
'''Read first:'''
  
⚫
* 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]
  
−  
 
{|class="wikitable alternance"
  
{|class="wikitable alternance"
 
|+ Document History
  
|+ Document History
Line 21: Line 13:
 
| 0.1.0
  
| 0.1.0
 
| janvier 2015
  
| janvier 2015
  +
| KLIPFFEL Tararaina, MICHEL Vivien, HAMERERE Jérémie, VIALLET Etienne
−
| MAMMAR Malek, PELLOUX-PRAYER Ophélie
  
 
| TBC
  
| TBC
 
| TBC
  
| TBC
Line 28: Line 20:
 
|}
  
|}
   
−
=1. Introduction=
 +
=Introduction=
−
==1.1 Purpose of the requirements document==
 +
==Purpose of the requirements document==
   
 
L'objectif de ce document est de présenter les exigences du projet CannonBall, quelles soient fonctionnelle ou non fonctionelles. Mais également les critères de qualité et les risques du projet.
  
L'objectif de ce document est de présenter les exigences du projet CannonBall, quelles soient fonctionnelle ou non fonctionelles. Mais également les critères de qualité et les risques du projet.
   
−
==1.2 Scope of the product==
+
==Scope of the product==
   
 
Ce projet est une part importante de la formation d'ingénieur RICM4. Il est d'une durée de 7 semaines et sera mené en équipe.
  
Ce projet est une part importante de la formation d'ingénieur RICM4. Il est d'une durée de 7 semaines et sera mené en équipe.
   
−
==1.3 Definitions, acronyms and abbreviations==
 +
==Definitions, acronyms and abbreviations==
   
 
Nous devrons utiliser des termes spécifiques comme :
  
Nous devrons utiliser des termes spécifiques comme :
Line 45: Line 37:
 
* Servo-Moteur
  
* Servo-Moteur
   
−
==1.4 References==
 +
==References==
   
 
This project is based on the work of :
  
This project is based on the work of :
Line 53: Line 45:
 
'''From may 26th 2014 to june 16th 2014''' : Thibaut Coutelou, Benjamin Mugnier and Guillaume Perrin from Ensimag. [http://fablab.ensimag.fr/index.php/Cannonball_de_voitures_RC/FicheSuivi Link]
  
'''From may 26th 2014 to june 16th 2014''' : Thibaut Coutelou, Benjamin Mugnier and Guillaume Perrin from Ensimag. [http://fablab.ensimag.fr/index.php/Cannonball_de_voitures_RC/FicheSuivi Link]
   
−
==1.5 Overview of the remainder of the document==
 +
==Overview of the remainder of the document==
−
=2. General description=
 +
=General description=
 
Le but principal de ce projet est de reprendre et d'améliorer les projets de l'année dernière pour permettre un meilleur retour d'information lors de l'utilisation de la voiture automatique créé dans le cadre du projet CannonBall
 
Le but principal de ce projet est de reprendre et d'améliorer les projets de l'année dernière pour permettre un meilleur retour d'information lors de l'utilisation de la voiture automatique créé dans le cadre du projet CannonBall
−
==2.1 Product perspective==
 +
==Product perspective==
   
 
Notre projet doit permettre un retour d'information détaillé sur la voiture et les conditions de conduite.
  
Notre projet doit permettre un retour d'information détaillé sur la voiture et les conditions de conduite.
   
−
==2.2 Product functions==
 +
==Product functions==
   
 
* Voiture automatique
  
* Voiture automatique
Line 66: Line 58:
 
* Capture et affichage d'un flux vidéo
  
* Capture et affichage d'un flux vidéo
   
−
==2.3 User characteristics==
 +
==User characteristics==
   
 
There are two type of user :
  
There are two type of user :
Line 72: Line 64:
 
* Geek
  
* Geek
   
−
==2.4 General constraints==
 +
==General constraints==
−
==2.5 Assumptions and dependencies==
 +
==Assumptions and dependencies==
   
−
=3.Specific requirements, covering functional, non-functional and interface requirements=
 +
=Specific requirements, covering functional, non-functional and interface requirements=
 
* document external interfaces,
  
* document external interfaces,
 
* describe system functionality and performance
  
* describe system functionality and performance
Line 82: Line 74:
 
* emergent system properties and quality characteristics.
  
* emergent system properties and quality characteristics.
   
−
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
 +
==Requirement X.Y.Z (in Structured Natural Language)==
 
'''Function''':
  
'''Function''':
   
Line 123: Line 115:
 
'''Side-effects''':
  
'''Side-effects''':
   
−
=4. Product evolution=
 +
=Product evolution=
   
 
On pourrait, dans un objectif futur, mettre en place l'utilisation d'un oculus
  
On pourrait, dans un objectif futur, mettre en place l'utilisation d'un oculus
  ⚫
=Appendices=
−  
  +
=Références=
⚫
=5. Appendices=
  
  ⚫
'''Read first:'''
−
=6. Index=
  
  ⚫
* 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]
  +
* http://imag-moodle.e.ujf-grenoble.fr/mod/resource/view.php?id=8670

Revision as of 12:44, 26 January 2015

Document History
Version Date Authors Description Validator Validation Date
0.1.0 janvier 2015 KLIPFFEL Tararaina, MICHEL Vivien, HAMERERE Jérémie, VIALLET Etienne TBC TBC TBC

Introduction

Purpose of the requirements document

L'objectif de ce document est de présenter les exigences du projet CannonBall, quelles soient fonctionnelle ou non fonctionelles. Mais également les critères de qualité et les risques du projet.

Scope of the product

Ce projet est une part importante de la formation d'ingénieur RICM4. Il est d'une durée de 7 semaines et sera mené en équipe.

Definitions, acronyms and abbreviations

Nous devrons utiliser des termes spécifiques comme :

  • OpenCV (C'est une librairie implémentant des algorithmes de traitement et de reconnaissance d'image)
  • Mosquitto (That is an open source (BSD licensed) message broker that implements the MQ Telemetry Transport protocol versions 3.1 and 3.1.1. MQTT provides a lightweight method of carrying out messaging using a publish/subscribe model)
  • Arduino (That is an open-source electronics platform based on easy-to-use hardware and software.)
  • Servo-Moteur

References

This project is based on the work of :

From january 13th 2014 to march 2nd 2014 : Jules Legros and Benoit Perruche from Polytech'Grenoble. Link Wiki Air

From may 26th 2014 to june 16th 2014 : Thibaut Coutelou, Benjamin Mugnier and Guillaume Perrin from Ensimag. Link

Overview of the remainder of the document

General description

Le but principal de ce projet est de reprendre et d'améliorer les projets de l'année dernière pour permettre un meilleur retour d'information lors de l'utilisation de la voiture automatique créé dans le cadre du projet CannonBall

Product perspective

Notre projet doit permettre un retour d'information détaillé sur la voiture et les conditions de conduite.

Product functions

  • Voiture automatique
  • Restitution et analyse des données
  • Capture et affichage d'un flux vidéo

User characteristics

There are two type of user :

  • Searcher
  • Geek

General constraints

Assumptions and dependencies

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.

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

Function:

Description:

Inputs: Voiture

Source: Tablette, WebCam, Arduino

Outputs: Tablette

Destination: Ce projet est destiné a être présenté lors de concours

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

Fonctionnelles :

  • Doit remonter la voiture
  • Peut faire passer le code des Ensimag sur un support linux
  • Doit perfectionner les diffrérents modes (Rabbit, CannonBall, Map)
  • Doit améliorer l'utilisation du mosquitto pour permettre un meilleur retour d'information


Non functional requirements:

  • Embarqué : le matériel utilisé doit être petit pour pouvoir être intégré dans la voiture
  • Performant : le matériel utilisé doit être performant pour être adapté à la vitesse de la voiture

Pre-condition:

  • Réussir la récupération du code existant
  • Comprendre du code existant
  • Réussir à remontrer la voiture et donc faire preuve d'une grande prudence lors du montage

Post-condition:

  • Faire un retour d'information pour recalibrer la voiture

Side-effects:

Product evolution

On pourrait, dans un objectif futur, mettre en place l'utilisation d'un oculus

Appendices

Références

Read first:

Retrieved from "https://air.imag.fr/index.php?title=Projet-2014-2015-RobAIR/SRS&oldid=20269"