Difference between revisions of "RICM4 2017 2018 - RobAIRDL/ SRS"
| Line 31: | Line 31: | ||
=1. Introduction= |
=1. Introduction= |
||
==1.1 Purpose of the requirements document== |
==1.1 Purpose of the requirements document== |
||
| + | |||
| + | This Software Requirements Specification (SRS) identifies the requirements for project RobAIR 17.1. This document aims to define the different features of the project through functional and non functional requirements. |
||
==1.2 Scope of the product== |
==1.2 Scope of the product== |
||
| + | This project's aim is to developed a new functionality for RobAIR. |
||
| + | This one will can show you your way and even guide you there. This will need a new interface and to adapt RobAIR's moving code to self movement with obstacle avoidance. |
||
| + | |||
==1.3 Definitions, acronyms and abbreviations== |
==1.3 Definitions, acronyms and abbreviations== |
||
| + | RobAIR : fabMSTICLig's telepresence robot. |
||
==1.4 References== |
==1.4 References== |
||
| + | RobAIR github : https://github.com/fabMSTICLig/RobAIR |
||
| + | gmapping ROS page : http://wiki.ros.org/gmapping |
||
| + | |||
==1.5 Overview of the remainder of the document== |
==1.5 Overview of the remainder of the document== |
||
=2. General description= |
=2. General description= |
||
Revision as of 11:28, 25 March 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 Software Requirements Specification (SRS) identifies the requirements for project RobAIR 17.1. This document aims to define the different features of the project through functional and non functional requirements.
1.2 Scope of the product
This project's aim is to developed a new functionality for RobAIR. This one will can show you your way and even guide you there. This will need a new interface and to adapt RobAIR's moving code to self movement with obstacle avoidance.
1.3 Definitions, acronyms and abbreviations
RobAIR : fabMSTICLig's telepresence robot.
1.4 References
RobAIR github : https://github.com/fabMSTICLig/RobAIR gmapping ROS page : http://wiki.ros.org/gmapping
1.5 Overview of the remainder of the document
2. General description
2.1 Product perspective
2.2 Product functions
2.3 User characteristics
2.4 General constraints
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: guide people
Description: The main goal of this projetc is to develop a brand new feature allowing us to locate ourselves.
Inputs: tablet, software, and proximity sensors
Source: tablet, webcam, STM32
Outputs: tablet, software
Destination: RobAIR control system
Action:
- RobAIR must be able to guide people within the building (IMAG).
- It must be able to communicate with people by showing them the path to be taken and clearly explaining what it is doing.
- RobAIR must be able to move around autonomously and figure its path out
- Avoid obstacles.
Non functional requirements:
- WebRTC
- Ros
- Arduino
- Web server
- Custumed power supply unit
- Low cost
Pre-condition: functional RobAIR
Post-condition: People reach their destination
Side-effects:
- Bad guidance
- Collisions