RICM4 2017 2018 - robair2/ SRS: Difference between revisions
Jordan.Jean (talk | contribs) |
Jordan.Jean (talk | contribs) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 39: | Line 39: | ||
==1.3 Definitions, acronyms and abbreviations== |
==1.3 Definitions, acronyms and abbreviations== |
||
* '''WebRTC''' : Web Real-Time Communication. |
|||
* '''Ros''' : Robot Operating System. |
|||
* '''API''' : Application Programming Interface |
|||
==1.4 References== |
==1.4 References== |
||
Previous contributors are : |
Previous contributors are : |
||
{class="wikitable alternance" |
{|class="wikitable alternance" |
||
+ History |
|+ History |
||
- |
|- |
||
| |
|||
!scope="col"| Date |
!scope="col"| Date |
||
!scope="col"| Authors |
!scope="col"| Authors |
||
| Line 85: | Line 89: | ||
==2.4 General constraints== |
==2.4 General constraints== |
||
Image rights |
* Image rights |
||
Connexion |
* Connexion |
||
==2.5 Assumptions and dependencies== |
==2.5 Assumptions and dependencies== |
||
| Line 120: | Line 124: | ||
'''Action''': |
'''Action''': |
||
RobAir will be able (after a short countdown) to take a picture. This picture could be taken by users or the operator. |
RobAir will be able (after a short countdown) to take a picture. This picture could be taken by users or the operator. |
||
* 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 |
|||
'''Non functional requirements''': |
'''Non functional requirements''': |
||
| Line 136: | Line 135: | ||
'''Side-effects''': |
'''Side-effects''': |
||
Copyrights and collisions |
Copyrights, image rights and collisions |
||
==3.1 Requirement for the publication on the social network== |
==3.1 Requirement for the publication on the social network== |
||
| Line 164: | Line 163: | ||
'''Action''': |
'''Action''': |
||
A picture previously taken will be published on Twitter with short (personalized) description. For example : "The new update #RobAir" |
A picture previously taken will be published on Twitter with short (personalized) description. For example : "The new update #RobAir" |
||
* 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 |
|||
'''Non functional requirements''': |
'''Non functional requirements''': |
||
| Line 180: | Line 174: | ||
'''Side-effects''': |
'''Side-effects''': |
||
Copyrights and collisions |
Copyrights, image rights and collisions |
||
=4. Product evolution= |
=4. Product evolution= |
||
Latest revision as of 13:29, 4 April 2018
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
| Version | Date | Authors | Description | Validator | Validation Date | |
|---|---|---|---|---|---|---|
| 0.1.0 | TBC | TBC | TBC | TBC | TBC |
1. Introduction
1.1 Purpose of the requirements document
This document is a description of the software. It lays out functional and non-functional requirements, and may include a set of use cases that describe user interactions that the software must provide.
1.2 Scope of the product
This project is integraded into the RICM4 formation at Polytech Grenoble as a part of the software engineering course.
1.3 Definitions, acronyms and abbreviations
- WebRTC : Web Real-Time Communication.
- Ros : Robot Operating System.
- API : Application Programming Interface
1.4 References
Previous contributors are :
| Date | Authors | Projet | |
|---|---|---|---|
| 2012 | FOURURE Florian, BISH Simon | http://air.imag.fr/index.php/RobAIR2012 | |
| 2013 | CORSO Alexandre, GUELORGET Laurène, AFONSO Nicolas, PLANES Simon, NUNES Thomas, BIDOIS Morgan | http://air.imag.fr/index.php/RobAIR2013 | |
| 2014 | TBC | http://air.imag.fr/index.php/RobAIR2014 | |
| 2015 | KLIPFFEL Tararaina, MICHEL Vivien, HAMMERER Jérémy, VIALLET Etienne | https://air.imag.fr/index.php/Projet-2014-2015-RobAIR/SRS |
1.5 Overview of the remainder of the document
The rest of the document introduces technical aspects of the project.
2. General description
RobAIR is a telepresence robot. As its name states, its main purpose is to virtually reproduce an user presence. RobAIR finds a wide range of applications from guiding people through museums to allowing hospitalized students to keep on following courses they enrolled in. The main purpose of this project is to improve the previous work done by adding a brand new feature : the possibility of taking a picture, adding a message to it and posting it on social networks such as Twitter, or Instagram.
2.1 Product perspective
2.2 Product functions
Taking pictures and posting them on social networks.
2.3 User characteristics
Everybody can use it. There are no specific characteristics.
2.4 General constraints
- Image rights
- Connexion
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 for the photo shot
Function: Take a picture after a short delay.
Description: This robot will be able to take pictures either via the driver or users by using the tablet.
Inputs:
- Touch Pad
- Web-cam
Source: Web-cam
Outputs:
- A picture
Destination: RobAir twitter account
Action: RobAir will be able (after a short countdown) to take a picture. This picture could be taken by users or the operator.
Non functional requirements: A Twitter account and an Internet connexion (Wifi).
Pre-condition: Operational robot (RobAir).
Post-condition: The picture has been taken and stored.
Side-effects: Copyrights, image rights and collisions
3.1 Requirement for the publication on the social network
Function: Publication on the social network
Description: This robot will be able to publish a message with a picture previously taken on Twitter with its own account.
Inputs:
- Touch Pad
- Web-cam
- Proximity sensors
Source: Proximity sensors and radars.
Outputs:
- Touch Pad
- LEDs
Destination: RobAir control station.
Action: A picture previously taken will be published on Twitter with short (personalized) description. For example : "The new update #RobAir"
Non functional requirements: A Twitter account and an Internet connection (Wifi).
Pre-condition: Operational robot (RobAir).
Post-condition: The published picture can be seen by anyone on Twitter.
Side-effects: Copyrights, image rights and collisions