air - User contributions [en]

File:Rapport-BARBIER-HUSSON.pdf

2014-04-09T00:32:06Z

RICM4-prj14-grp2:

File:RapportBARBIER-HUSSON.pdf

2014-04-09T00:30:41Z

RICM4-prj14-grp2:

Proj-2013-2014-RobAIR-1-SRS

2014-04-08T12:54:36Z

RICM4-prj14-grp2: /* 1.4 References */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* The global project's page can be found [[RobAIR2014|here]].
* The last RICM4 groups are working on this project. Here are their wiki page:
:- [[RobAIR2013-RICM4-Groupe1-Suivi | Group 1]]
:- [[RobAIR2013-RICM4-Groupe2-Suivi | Group 2]]
:- [[RobAIR2013-RICM4-Groupe3-Suivi | Group 3]]
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=
::- add other project like '''COQP''' to selected whitch ROBAIR you want.
::- Switch between different robots.
::- Control the robot thanks to a neuronal device.
::- Thanks to a lidar, the robot makes its own map. (in progress...)
::- Ability to read QRcodes and display related contents on the tablet.
::- able to do as we want talk and not with previously saved text

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==5.3 Licensing Requirements==
RobAIR will be released under a GPL license and will be open-source.

Proj-2013-2014-RobAIR-1-SRS

2014-04-08T12:54:21Z

RICM4-prj14-grp2: /* 4. Product evolution */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* The global project's page can be found [[RobAIR2014|here]].
* The last RICM4 groups are working on this project. Here are their wiki page:
:- [[RobAIR2013-RICM4-Groupe1-Suivi | Group 1]]
:- [[RobAIR2013-RICM4-Groupe2-Suivi | Group 2]]
:- [[RobAIR2013-RICM4-Groupe3-Suivi | Group 3]]
* The other group who work on robair : [[http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2|here]]
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=
::- add other project like '''COQP''' to selected whitch ROBAIR you want.
::- Switch between different robots.
::- Control the robot thanks to a neuronal device.
::- Thanks to a lidar, the robot makes its own map. (in progress...)
::- Ability to read QRcodes and display related contents on the tablet.
::- able to do as we want talk and not with previously saved text

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==5.3 Licensing Requirements==
RobAIR will be released under a GPL license and will be open-source.

Proj-2013-2014-RobAIR-1

2014-04-05T08:19:40Z

RICM4-prj14-grp2:

= Introduction =
Project [[RobAIR]]

= Team =

*Tutors : Didier Donsez,Amr Alyafi

*Members : Augustin Husson, Jérôme Barbier

*Departement : [http://www.polytech-grenoble.fr/ricm.html RICM 4], [[Polytech Grenoble]]

= Project objectives =
* transit command message beetween two devices by webRTC protocol
* use webRTC to etablish connection and send/receive message
* create graphic interface to control the robot

== Related documents ==
How to prepare your project before starting coding like whale : [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted here]

= Progress of the project =

The project started January 14th, 2013.

== Week 1 (January 13th - Janurary 19th) ==
* Project discovery
* Research of related projects

== Week 2 (January 20th - Janurary 26th) ==
* Development of team goals
* Get a kit to assemble Air-Rob
* Initialize the assembly phase of the robot in partnership with the team of David Levayer and Paul Marriage
* Search on "how to make a skype plugin"
* First attempt to run via java skype: skype must currently be run with a graphical interface for the java code works.
* Search how Skype is used to

== Week 3 (January 27th - February 2nd) ==
* Assembly of two new RobAIRs --> just one for the moment
* Beginning of the redaction of Software Requirements Specification
* ROS environment installed on Ubuntu and work
* RobAIR can now move by itself ! (debug in progress)
* Meeting with Amr Alyafi (effective code obtained)

== Week 4 (February 3th - February 7th) ==
* Fixe Skype objectif with M. Donsez
* We try to run the code from previous years (we can't understand how their project could work with so many mistakes...)
* Now robair can speak with keyboards press
* Graphique interface is working but we can't control robair with this. (Debug in progress)

== Week 5 (February 10th - February 14th) ==
* Bug with control and webcam connexion (client try to connect himself but he can't be connected to the server)
* Meeting with M. Donsez because we are so in late to realized this project : Finaly we modify us subject --> skype can't worked because code is closed so we are going to use "WebRTC".
* RobAIR works! http://www.youtube.com/watch?v=g5XhrDY0tFI&feature=youtu.be

== Week 6 (February 17th - February 21th) ==
* Change ROS version, from Hydro to Fuerte cause of new udpate of some packages and with these new packages we can't use some library.
* Correct so many bug of the last project, see http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted
* WebRTC is a new technology so we don't have any documentations : if you want to used webRTC in C++ follow these instructions : [http://www.webrtc.org/reference/getting-started/ http://www.webrtc.org/reference/getting-started/] (in progress)

== Week 7 (February 24th - February 28th) ==
* We try to understand how webRTC works.
* Native api in chrome and mozilla
* Realization of little application using webRTC : we can catch the webcam of use browser (here mozilla, but it can works on chrome)
* We begin to understand how connection between two browser works (the connection is not realized, not yet !)

== Week 8 (March 3rd - march 7th) ==
* We realize connection beetween two browers with webRTC
* Install robair simulator (turtle) and change the source code to move the robot with w,s,a,d
* We try to send some data (data, audio or video) by webRTC but it fail (debug in progress)

== Week 9 (March 10th- march 14th) ==
* Create git account
* Performed our first application
* Continue to try to understand how webRTC connection work

== Week 10 (March 17th- march 21th) ==
* webRTC connection success !! we can exchange data (for the moment only text data) beetween two browsers
* We are in late so we decided to separate our works : Augustin work on webRTC and Jerome work on ROS node
* Add a little css for our website
* Add video stream exchange !! and it's work so good !! --> BIG PROBLEM : IT'S DON'T WORK WHEN ROS IS LAUCH... (debug in progress)

== Week 11 (March 24th- march 28th) ==
* We can shutdown the video stream but can't reload it (debug in progress...)
* Add ROS folder
* Add pyton server to communicate with ROBAIR and our website : it's work so good !!
* Add all buttons for voices actions

== Week 12 (March 31th- April 4th) ==
* Try to do a multiple client connetion in the same conversation (debug in progress...)
* Improve design of webSite
* Add joystick buttons to control ROBAIR.
* All work good! We can create a channel with video stream, lauch ros (the video is good now), control robair, dialog...
* Complete this web page and SRS

== Week 13 (March 7th- April 11th) ==
* in progress

Proj-2013-2014-RobAIR-1

2014-04-05T08:02:58Z

RICM4-prj14-grp2:

= Introduction =
Project [[RobAIR]]

= Team =

*Tutors : Didier Donsez,Amr Alyafi

*Members : Augustin Husson, Jérôme Barbier

*Departement : [http://www.polytech-grenoble.fr/ricm.html RICM 4], [[Polytech Grenoble]]

= Project objectives =
* transit command message beetween two devices by a browers
* use webRTC to etablish connection and send/receive message
* create graphic interface to control the robot

== Related documents ==
How to prepare your project before starting coding like whale : [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted here]

= Progress of the project =

The project started January 14th, 2013.

== Week 1 (January 13th - Janurary 19th) ==
*Project discovery
*Research of related projects

== Week 2 (January 20th - Janurary 26th) ==
* Development of team goals
* Get a kit to assemble Air-Rob
* Initialize the assembly phase of the robot in partnership with the team of David Levayer and Paul Marriage
* Search on "how to make a skype plugin"
* First attempt to run via java skype: skype must currently be run with a graphical interface for the java code works.
* Search how Skype is used to

== Week 3 (January 27th - February 2nd) ==
* Assembly of two new RobAIRs --> just one for the moment
* Beginning of the redaction of Software Requirements Specification
* ROS environment installed on Ubuntu and work
* RobAIR can now move by itself ! (debug in progress)
* Meeting with Amr Alyafi (effective code obtained)

== Week 4 (February 3th - February 7th) ==
* fixe Skype objectif with M. Donsez
* we try to run the code from previous years (we can't understand how their project could work with so many mistakes...)
* Now robair can speak with keyboards press
* Graphique interface is working but we can't control robair with this. (Debug in progress)

== Week 5 (February 10th - February 14th) ==
* Bug with control and webcam connexion (client try to connect himself but he can't be connected to the server)
* Meeting with M. Donsez because we are so in late to realized this project : Finaly we modify us subject --> skype can't worked because code is closed so we are going to use "WebRTC".
* RobAIR works! http://www.youtube.com/watch?v=g5XhrDY0tFI&feature=youtu.be

== Week 6 (February 17th - February 21th) ==
* Change ROS version, from Hydro to Fuerte cause of new udpate of some packages and with these new packages we can't use some library.
* Correct so many bug of the last project, see http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted
* WebRTC is a new technology so we don't have any documentations : if you want to used webRTC in C++ follow these instructions : [http://www.webrtc.org/reference/getting-started/ http://www.webrtc.org/reference/getting-started/] (in progress)

== Week 7 (February 24th - February 28th) ==
* We try to understand how webRTC works.
* Native api in chrome and mozilla
* Realization of little application using webRTC : we can catch the webcam of use browser (here mozilla, but it can works on chrome)
* We begin to understand how connection between two browser works (the connection is not realized, not yet !)

== Week 8 (March 3rd - march 7th) ==
* we realize connection beetween two browers with webRTC
* install robair simulator (turtle) and change the source code to move the robot with w,s,a,d
* we try to send some data (data, audio or video) by webRTC but it fail (debug in progress)

== Week 9 (March 10th- march 14th) ==

== Week 10 (March 17th- march 21th) ==

== Week 11 (March 24th- march 28th) ==

== Week 12 (March 31th- April 4th) ==

== Week 13 (March 7th- April 11th) ==

Proj-2013-2014-RobAIR-1

2014-04-04T16:40:17Z

RICM4-prj14-grp2:

= Introduction =
Project [[RobAIR]]

= Team =

*Tutors : Didier Donsez,Amr Alyafi

*Members : Augustin Husson, Jérôme Barbier

*Departement : [http://www.polytech-grenoble.fr/ricm.html RICM 4], [[Polytech Grenoble]]

= Project objectives =
* transit command message beetween two devices by a browers
* use webRTC to etablish connection and send/receive message
* create graphic interface to control the robot

== Related documents ==
How to prepare your project before starting coding like whale : [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted here]

= Progress of the project =

The project started January 14th, 2013.

== Week 1 (January 13th - Janurary 19th) ==
*Project discovery
*Research of related projects

== Week 2 (January 20th - Janurary 26th) ==
* Development of team goals
* Get a kit to assemble Air-Rob
* Initialize the assembly phase of the robot in partnership with the team of David Levayer and Paul Marriage
* Search on "how to make a skype plugin"
* First attempt to run via java skype: skype must currently be run with a graphical interface for the java code works.
* Search how Skype is used to

== Week 3 (January 27th - February 2nd) ==
* Assembly of two new RobAIRs --> just one for the moment
* Beginning of the redaction of Software Requirements Specification
* ROS environment installed on Ubuntu and work
* RobAIR can now move by itself ! (debug in progress)
* Meeting with Amr Alyafi (effective code obtained)

== Week 4 (February 3th - February 7th) ==
* fixe Skype objectif with M. Donsez
* we try to run the code from previous years (we can't understand how their project could work with so many mistakes...)
* Now robair can speak with keyboards press
* Graphique interface is working but we can't control robair with this. (Debug in progress)

== Week 5 (February 10th - February 14th) ==
* Bug with control and webcam connexion (client try to connect himself but he can't be connected to the server)
* Meeting with M. Donsez because we are so in late to realized this project : Finaly we modify us subject --> skype can't worked because code is closed so we are going to use "WebRTC".
* RobAIR works! http://www.youtube.com/watch?v=g5XhrDY0tFI&feature=youtu.be

== Week 6 (February 17th - February 21th) ==
* Change ROS version, from Hydro to Fuerte cause of new udpate of some packages and with these new packages we can't use some library.
* Correct so many bug of the last project, see http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-1/getStarted
* WebRTC is a new technology so we don't have any documentations : if you want to used webRTC in C++ follow these instructions : [http://www.webrtc.org/reference/getting-started/ http://www.webrtc.org/reference/getting-started/] (in progress)

== Week 7 (February 24th - February 28th) ==
* We try to understand how webRTC works.
* Native api in chrome and mozilla
* Realization of little application using webRTC : we can catch the webcam of use browser (here mozilla, but it can works on chrome)
* We begin to understand how connection between two browser works (the connection is not realized, not yet !)

== Week 8 (February 3rd - February 7th) ==
* we realize connection beetween two browers with webRTC
* install robair simulator (turtle) and change the source code to move the robot with w,s,a,d
* we try to send some data (data, audio or video) by webRTC but it fail (debug in progress)

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T16:29:57Z

RICM4-prj14-grp2: /* 4. Product evolution */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* The global project's page can be found [[RobAIR2014|here]].
* The last RICM4 groups are working on this project. Here are their wiki page:
:- [[RobAIR2013-RICM4-Groupe1-Suivi | Group 1]]
:- [[RobAIR2013-RICM4-Groupe2-Suivi | Group 2]]
:- [[RobAIR2013-RICM4-Groupe3-Suivi | Group 3]]
* The other group who work on robair : [[http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2|here]]
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=
::- add other project like '''QOS''' to selected whitch ROBAIR you want.
::- Switch between different robots.
::- Control the robot thanks to a neuronal device.
::- Thanks to a lidar, the robot makes its own map. (in progress...)
::- Ability to read QRcodes and display related contents on the tablet.
::- able to do as we want talk and not with previously saved text

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==5.3 Licensing Requirements==
RobAIR will be released under a GPL license and will be open-source.

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T16:25:44Z

RICM4-prj14-grp2: /* 1.4 References */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* The global project's page can be found [[RobAIR2014|here]].
* The last RICM4 groups are working on this project. Here are their wiki page:
:- [[RobAIR2013-RICM4-Groupe1-Suivi | Group 1]]
:- [[RobAIR2013-RICM4-Groupe2-Suivi | Group 2]]
:- [[RobAIR2013-RICM4-Groupe3-Suivi | Group 3]]
* The other group who work on robair : [[http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2|here]]
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==5.3 Licensing Requirements==
RobAIR will be released under a GPL license and will be open-source.

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T16:22:48Z

RICM4-prj14-grp2:

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* The global project's page can be found [[RobAIR2014|here]].
* The last RICM4 groups are working on this project. Here are their wiki page:
:- [[RobAIR2013-RICM4-Groupe1-Suivi | Group 1]]
:- [[RobAIR2013-RICM4-Groupe2-Suivi | Group 2]]
:- [[RobAIR2013-RICM4-Groupe3-Suivi | Group 3]]
* The other group who work on robair :
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==5.3 Licensing Requirements==
RobAIR will be released under a GPL license and will be open-source.

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T16:21:10Z

RICM4-prj14-grp2: /* 5. Appendices */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

==5.2 Sources==
::- The other groups who work on ROBAIR :
::- [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T16:14:30Z

RICM4-prj14-grp2: /* 3.1 Requirement X.Y.Z (in Structured Natural Language) */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : chrome/mozilla browser must be installed, internet connection between our application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems.

'''Function''': receive video trafic, put it on our interface and add directional buttun for control robair remotely via webRTC encoding

'''Description''': use browser interface for video-conference to allow us to control robair

'''Inputs''': webcam, directionnal buttons, voice buttons, create and join channel.

'''Source''': directional button, webcam, webrtc

'''Outputs''': webcam, directions information, voices information

'''Destination''': robair for the direction, robair and us application for the video

'''Action''':
* Etablished connection between many user
* Send/receive video stream
* Controle ROBAIR with our interface
* Send data (text, sound, directionnal command)

'''Non functional requirements''':
::- beautiful HMI.
::- We can't restart video after shut down the stream.
::- we can't redirect the video stream to a other device.
::- All users have the directionnal buttons in their interface. We want only one (in progress...)

'''Pre-condition''':
*materials conditions:
::- A RobAIR must be connected in the selected place.
::- A server to log our website connection.
::- A equipments with chrome or mozilla browsers.

*Software conditions:
::- Install the RobAIR2014-Server software on the ubuntu server on ROBAIR.
::- Just need lastest chrome/mozilla version.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface.
::- The user can send voices data to robair speak.

'''Side-effects''':
::- bit latency of the stream (in general the quality is nice).
::- sometimes we have a fail of connection, just restart the connection and all will be functional.

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:53:08Z

RICM4-prj14-grp2: /* 2. General description */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]|It's was how webRTC connection works 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==2.5 Assumptions and dependencies==
::- The robot site has wifi access in all the visit area.
::- The robot base can be accessed at any time.
::- The robot can be connected with many users
::- The robot can be control by one user.

=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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:50:01Z

RICM4-prj14-grp2: /* 2.2 Product functions */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px|It's was how webRTC connection works]] 
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:46:22Z

RICM4-prj14-grp2: /* 2.2 Product functions */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png|400px]]
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

File:Connection.png

2014-04-04T15:46:05Z

RICM4-prj14-grp2: RICM4-prj14-grp2 uploaded a new version of "File:Connection.png"

File:Connection.png

2014-04-04T15:42:32Z

RICM4-prj14-grp2:

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:42:16Z

RICM4-prj14-grp2: /* 2.2 Product functions */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:connection.png]]
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

File:WebRTCConnection.png

2014-04-04T15:26:05Z

RICM4-prj14-grp2:

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:25:38Z

RICM4-prj14-grp2: /* 2.2 Product functions */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
[[File:webRTCConnection.png]]
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:22:32Z

RICM4-prj14-grp2: /* 2. General description */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
If a user want to join ROBAIR, he will click on "JoinRobair" button. If he want to shut down his stream video, he will click on "stop Video Stream" button.
We need a ROS node to convert webrtc instructions to ROS.

The robot interface functions:
::- Control the robot
::- close/add stream video
::- join/close channel to communicate with ROBAIR

==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television

==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:14:30Z

RICM4-prj14-grp2: /* 2.1 Product perspective */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ROS to do some actions (except stream).

==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:13:43Z

RICM4-prj14-grp2: /* 2.1 Product perspective */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface. 
How will work our project ? The user will be connected by websocket to ROBAIR. Next, he will send/receive data (like move commande or video stream) by webrtc channel. When Robair receive the command, he will send it to ros to do some actions (except stream).

==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:06:56Z

RICM4-prj14-grp2: /* 1.4 References */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
::- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
::- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
::- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface
==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:06:34Z

RICM4-prj14-grp2: /* 2.4 General constraints */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface
==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
::- ROS must operate on an Ubuntu platform.
::- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
::- Wifi with Internet access for the robot and for the controller.
::- The robot can’t climb up steep slopes.

==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:06:08Z

RICM4-prj14-grp2: /* 2. General description */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface
==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
- ROS must operate on an Ubuntu platform.
- The Platform need some of this two browsers : chrome/mozilla
*Environemental constraints:
- Wifi with Internet access for the robot and for the controller.
- The robot can’t climb up steep slopes.
==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T15:05:24Z

RICM4-prj14-grp2: /* 2. General description */

=1. Introduction=
==1.1 Purpose of the requirements document==
This Software Requirements Specification (SRS) identifies the requirements for the [[RobAIR2013 | RobAIR]] project. The purpose of the present document is to explain how we organize our project, the different steps of the conception and the project achievement.
==1.2 Scope of the product==
* The purpose of this project is to send and receive video by webRTC protocol. Moreover, we need to control ROBAIR with our graphic interface.
* 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==
* '''WebRTC''' : Web Real-Time Communication is an API definition drafted by the World Wide Web Consortium (W3C) that supports browser-to-browser applications for voice calling, video chat, and P2P file sharing without plugins.
* '''Arduino''' : It is a open-source board with a microcontroller, intended to make the application of interactive objects or environments more accessible.
* '''ROS''' : Robot Operating System is a software framework for robot software development, (see also Robotics middleware) providing operating system-like functionality on a heterogeneous computer cluster.
* '''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.
* '''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.
* '''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.

==1.4 References==
* official website[http://www.webrtc.org/ webrtc.org]
* all old projects already done on [http://air.imag.fr/index.php/RobAIR RobAIR]
* the second group work on robair [http://air.imag.fr/index.php/Proj-2013-2014-RobAIR-2 Proj-2013-2014-RobAIR-]
* so much git on webrtc. The most importante are : - [https://developer.mozilla.org/fr/docs/WebRTC developer.mozilla.org] 
- [http://www.html5rocks.com/en/tutorials/webrtc/basics/ www.html5rocks.com] 
- [http://www.w3.org/TR/2013/WD-webrtc-20130910/ www.w3.org] (official documentation) 
- [http://www.simpl.info/index.html www.simpl.info] 

==1.5 Overview of the remainder of the document==
The rest of the SRS examines the specifications of the [[robAIR2014 | robAIR2014]] project in details. Section two of the SRS presents the general factors that affect the robAIR and its requirements, such as user characteristics and project constraints. Section three outlines the detailed, specific and functional requirements, performance, system and other related requirements of the project. Supporting information about appendices is provided in Section three.

=2. General description=
==2.1 Product perspective==
At first, the user goal is very simple. In fact, he just need to log on our website on join robair connection. After that, he will be able to send/receive video conferance, control the robot with our graphic interface
==2.2 Product functions==
==2.3 User characteristics==
The user doesn’t need to be familiar with programming and doesn't need a specific formation. 
He just needs to know how to use a tablet and a television
==2.4 General constraints==
*Platform constraints:
- ROS must operate on an Ubuntu platform.
- The Platform need some of this two browsers : chrome/mozilla

*Environemental constraints:
- Wifi with Internet access for the robot and for the controller.
- The robot can’t climb up steep slopes.
==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)==

Requirement : skype must be installed, internet connection between us application and robair, battery charged, access to steering commands the robot, all requirements of last years projects, ROS is used only on Linux systems

'''Function''': receive video trafic, put it on us interface and add directional buttun for control robair remotely via skype encoding (for VoIP)

'''Description''': use skype interface for video-conference to allow us to control robair

'''Inputs''': webcam, press buttun

'''Source''': directional button, webcam, skype

'''Outputs''': webcam, directions information

'''Destination''': robair for the direction, robair and us application for the video

'''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''':
*materials conditions:
::- A RobAIR 2013 connected in the selected place.
::- A ubuntu server connected to a display device and a camera.
::- A android/windows/Linux tablet.

*Software conditions:
::- Install the RobAIR2013-Server software on the ubuntu server.
::- Install the RobAIR2013 android application.
::- skype must be used in the server and client.

'''Post-condition''':
::- The user can do videoconferencing with people who met the robot.
::- The user can control the robot by us interface

'''Side-effects''': latency? used a new interface and not skype interface

=4. Product evolution=

=5. Appendices=

==5.1. SRS structure==
The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

'''References:'''
* 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]

=6. Index=

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T14:45:35Z

RICM4-prj14-grp2: /* 1.4 References */

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T14:44:47Z

RICM4-prj14-grp2: /* 1.4 References */

Proj-2013-2014-RobAIR-1-SRS

2014-04-04T14:44:23Z