Difference between revisions of "SRS RobAir RICM Group"
Thomas.Nunes (talk | contribs) |
Thomas.Nunes (talk | contribs) |
||
Line 88: | Line 88: | ||
=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 the robot [[RobAIR2013 | RobAIR]]. |
+ | This Software Requirements Specification (SRS) identifies the requirements for the robot [[RobAIR2013 | RobAIR]].<br/> |
+ | In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities performed and the problems that the system solves. |
||
+ | |||
==1.2 Scope of the product== |
==1.2 Scope of the product== |
||
* The product we are developing is a telepresence robot that can be used for museum tours and the user will be able to guide the robot with an Android tablet. |
* The product we are developing is a telepresence robot that can be used for museum tours and the user will be able to guide the robot with an Android tablet. |
||
Line 95: | Line 97: | ||
==1.3 Definitions, acronyms and abbreviations== |
==1.3 Definitions, acronyms and abbreviations== |
||
+ | |||
⚫ | |||
− | * Roaming: It ensures that a wireless device is kept connected to the network, without losing the connection. |
+ | * '''Roaming''': It ensures that a wireless device is kept connected to the network, without losing the connection. |
+ | |||
− | * ... (à compléter) |
||
+ | *'''XML''': (Extensible Markup Language) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. |
||
+ | |||
+ | * '''XMPP''': (Extensible Messaging and Presence Protocol) is a communications protocol for message-oriented middleware. |
||
+ | |||
+ | * '''P2P''': Peer-to-Peer Protocol is an Application-layer protocol that can be used to form and maintain an overlay among participant nodes. It provides mechanisms for nodes to join, leave, publish, or search for a resource-object in the overlay. |
||
+ | |||
+ | * '''Jingle''': Jingle is an extension to XMPP which adds peer-to-peer (P2P) session control for multimedia interactions like videoconferencing communication. |
||
+ | |||
⚫ | |||
+ | |||
+ | *''' Jitsi''': It is a videoconferencing and instant messaging application developed in JAVA and using XMPP/Jingle. |
||
+ | |||
+ | *'''telepresence''': It is refers to a set of technologies which allow a person to feel as if they were present, to give the appearance of being present. |
||
+ | |||
+ | * '''Wiimote''': It is the primary controller for Nintendo's Wii console. A main feature of the Wii Remote is its motion sensing capability,which allows the user to interact with and manipulate items on screen. |
||
+ | |||
+ | *'''Ubuntu''': is a computer operating system based on the Debian Linux distribution and distributed as free and open source software, using its own desktop environment. |
||
+ | |||
+ | |||
==1.4 References== |
==1.4 References== |
||
+ | ::-Our progress[[RobAIR2013-RICM4-Groupe3-Suivi| page.]]<br\> |
||
+ | ::-The main page of the project: [[RobAIR2013]]<br\> |
||
+ | ::-Wikipedia [http://en.wikipedia.org] for definitions. |
||
+ | |||
==1.5 Overview of the remainder of the document== |
==1.5 Overview of the remainder of the document== |
||
+ | |||
=2. General description= |
=2. General description= |
||
+ | |||
==2.1 Product perspective== |
==2.1 Product perspective== |
||
+ | The product is a part of the RobAIR platform and interact with others component throws ROS. |
||
+ | |||
==2.2 Product functions== |
==2.2 Product functions== |
||
+ | The robot interface functions: |
||
+ | ::- Control the robot. |
||
+ | ::- See where the robot go. |
||
+ | ::- Know where are the robot. |
||
+ | ::- Have a feedback on the robot state (battery level, problems encountered). |
||
+ | ::- Display data about the robot environement to get a feedback (robot velocity, position on the map). |
||
+ | |||
==2.3 User characteristics== |
==2.3 User characteristics== |
||
+ | The User don’t need a to familiar with programming and don't need a specific formation. <br\> |
||
+ | The interface must be simple and intuitive. |
||
+ | |||
==2.4 General constraints== |
==2.4 General constraints== |
||
+ | *Platform constraints: |
||
+ | ::- ROS must turn on a Ubuntu platform. |
||
+ | ::- Tablets controller interface are devlop for the Android platform. |
||
+ | |||
+ | *Environemental constraints: |
||
+ | ::-Wifi with Internet access for the robot and for the controller. |
||
+ | |||
==2.5 Assumptions and dependencies== |
==2.5 Assumptions and dependencies== |
||
+ | |||
=3.Specific requirements, covering functional, non-functional and interface requirements= |
=3.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 141: | Line 189: | ||
=4. Product evolution= |
=4. Product evolution= |
||
+ | ::-Using some Tablets with one main which control the robot. |
||
+ | ::-The robot can read QRcodes and display the contain refered on tablets. |
||
+ | ::-A vocal interface like a GPS. |
||
=5. Appendices= |
=5. Appendices= |
||
+ | ==Specification == |
||
+ | *[[RobAIR2013-RICM4-Groupe3-UML| UML]]. |
||
+ | |||
+ | ==Sources == |
||
+ | * An exemple of JAVA node to communicate with ROS by Rémi Barraquand. |
||
+ | [https://github.com/PALGate/palgate-trial/blob/master/prima/knx_control/] |
||
+ | <br/> |
||
+ | *The RobAIR 2012 project by Thomas Calmant: |
||
+ | [https://github.com/tcalmant/robair/blob/master/trunk/platforms/wifibot] |
||
+ | |||
=6. Index= |
=6. Index= |
||
+ | |||
+ | (What is this?) |
Revision as of 22:15, 11 February 2013
This document describe the software requirements specifications of the project RobAIR2013.
Version | Date | Authors | Description | Validator | Validation Date | |
---|---|---|---|---|---|---|
0.1.0 | January 27th, 2013 | Laurène Guelorget | First draft | TBC | TBC | |
1.1.0 | January 29th, 2013 | Morgan bidois | First draft | January 29th, 2013 | Thomas Nunes | |
1.2.0 | January 31th, 2013 | Morgan bidois | Definitions 1.3 & some reference 1.4 | January 1st, 2013 | Thomas Nunes | |
1.3.0 | January 1st, 2013 | Thomas Nunes | General description 2.1 to 2.5 | January 4th, 2013 | Morgan bidois | |
1.3.0 | January 4th, 2013 | Morgan bidois | Evolution 4 & specific requieremnt 3 | January 4th, 2013 | Thomas Nunes | |
0.1.1 | February 7th, 2013 | Laurène Guelorget | Scope | TBC | TBC | |
1.4.0 | January 7th, 2013 | Thomas Nunes | 3.1 requierement | January 7th, 2013 | Morgan bidois | |
1.5.0 | January 8th, 2013 | Morgan bidois | appendices 5 & complete part 2 | January 8th, 2013 | Thomas Nunes | |
2.0.0 | January 11th, 2013 | Thomas Nunes | Merge of two SRS for a group of 6. | TBC | TBC |
1. Introduction
1.1 Purpose of the requirements document
This Software Requirements Specification (SRS) identifies the requirements for the robot RobAIR.
In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities performed and the problems that the system solves.
1.2 Scope of the product
- The product we are developing is a telepresence robot that can be used for museum tours and the user will be able to guide the robot with an Android tablet.
- It is a low cost robot (well below the maket price).
- The platform and software used for this robot are extensible and open-source.
1.3 Definitions, acronyms and abbreviations
- Roaming: It ensures that a wireless device is kept connected to the network, without losing the connection.
- XML: (Extensible Markup Language) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.
- XMPP: (Extensible Messaging and Presence Protocol) is a communications protocol for message-oriented middleware.
- P2P: Peer-to-Peer Protocol is an Application-layer protocol that can be used to form and maintain an overlay among participant nodes. It provides mechanisms for nodes to join, leave, publish, or search for a resource-object in the overlay.
- Jingle: Jingle is an extension to XMPP which adds peer-to-peer (P2P) session control for multimedia interactions like videoconferencing communication.
- ROS: (Robot Operating System) It is a software framework for robot software development.
- Jitsi: It is a videoconferencing and instant messaging application developed in JAVA and using XMPP/Jingle.
- telepresence: It is refers to a set of technologies which allow a person to feel as if they were present, to give the appearance of being present.
- Wiimote: It is the primary controller for Nintendo's Wii console. A main feature of the Wii Remote is its motion sensing capability,which allows the user to interact with and manipulate items on screen.
- Ubuntu: is a computer operating system based on the Debian Linux distribution and distributed as free and open source software, using its own desktop environment.
1.4 References
- -Our progress page.<br\>
- -The main page of the project: RobAIR2013<br\>
- -Wikipedia [1] for definitions.
1.5 Overview of the remainder of the document
2. General description
2.1 Product perspective
The product is a part of the RobAIR platform and interact with others component throws ROS.
2.2 Product functions
The robot interface functions:
- - Control the robot.
- - See where the robot go.
- - Know where are the robot.
- - Have a feedback on the robot state (battery level, problems encountered).
- - Display data about the robot environement to get a feedback (robot velocity, position on the map).
2.3 User characteristics
The User don’t need a to familiar with programming and don't need a specific formation. <br\> The interface must be simple and intuitive.
2.4 General constraints
- Platform constraints:
- - ROS must turn on a Ubuntu platform.
- - Tablets controller interface are devlop for the Android platform.
- Environemental constraints:
- -Wifi with Internet access for the robot and for the controller.
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:
Source:
Outputs:
Destination:
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
Non functional requirements:
Pre-condition:
Post-condition:
Side-effects:
4. Product evolution
- -Using some Tablets with one main which control the robot.
- -The robot can read QRcodes and display the contain refered on tablets.
- -A vocal interface like a GPS.
5. Appendices
Specification
- UML.
Sources
- An exemple of JAVA node to communicate with ROS by Rémi Barraquand.
- The RobAIR 2012 project by Thomas Calmant:
6. Index
(What is this?)