Project 2014-2015-CannonBall/SRS

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
 * IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998

=1.  Introduction=

1.1 Purpose of the requirements document
The purpose of this document is to present the requirements of the project CannonBall, which are functional or not. But also quality standards and project risks.

1.2 Scope of the product
This project is an important part of the engineering course RICM4.

1.3 Definitions, acronyms and abbreviations
We will have to use specific terms like :
 * OpenCV : this is a library which implements processing algorithms and image recognition
 * Mosquitto : this 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 : this is an open-source electronics platform based on easy-to-use hardware and software.
 * Servomotor : this is a rotary actuator that allows for precise control of angular position, velocity and acceleration

1.4 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

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

The main goal of this project is to take over and improve our predecessors' work to allow better feedback when using the automatic car created under the CannonBall project.

2.1 Product perspective
Our project will enable a detailed feedback on the car and driving conditions.

2.2 Product functions

 * Automatic car
 * Restitution and analysis
 * Capture and display of a video stream

2.3 User characteristics
There are two type of user :
 * Searcher
 * Geek

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: Voiture (Car)

Source: Tablette, WebCam, Arduino (tablet, webcam, arduino)

Outputs: Tablette (tablet)

Destination: Ce projet est destiné a être présenté lors de concours (This project is intended to be presented at contest)

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 (reassembling of the car)
 * Peut faire passer le code des Ensimag sur un support linux (modify the code to be compatible with linux)
 * Doit perfectionner les diffrérents modes (Rabbit, CannonBall, Map) (perfect the different modes)
 * Doit améliorer l'utilisation du mosquitto pour permettre un meilleur retour d'information (improve the use of mosquitto for better feedback)

Non functional requirements: (Embedded: The equipment used must be small to be integrated in the car) (Powerful: the material used must be efficient to be adapted to the speed of the car)
 * 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 (Recover of existing code)
 * Comprendre du code existant (Understand of existing code)
 * Réussir à remonter la voiture (Successfully rebuilt the car)

Post-condition: (Make a feedback to calibrate the car)
 * Faire un retour d'information pour calibrer la voiture

Side-effects:

=4. Product evolution=

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

=5. Appendices= =6. Index=