User Guide of RobHub - RoboboUPMC2016/RobDoc GitHub Wiki
RobHub, Social Network to share behaviors
Summary
1. Introduction
2. Connection interface
A. Sign in
B. Sign up
3. Home Page
4. Description of behavior
A. Java code of behavior
B. Video of behavior
C. The QR code of behavior
5. Add behavior
1. Introduction
This manual is intended to provide a detailed description of the users / machine interface to the different users of RobHub. This manual can be effective when using RobHub to quickly find the features of the site you are looking for. The purpose of the RobHub project is to create a web application to share the behaviors of the Robobo (Java code, Video, QR code), allowing users to rate and download these behaviors. The user creates behaviors for his robot through a framework, and then using RobHub he can publish the Java code of the behavior. This social network is important because it allows a quick evolution to the creation of the behaviors of Robobo in meeting a committee of developers interested in the idea. This project works in parallel with three other projects, the first is the behavior framework [RobDev] (https://github.com/RoboboUPMC2016/RobDev). It is by using this framework that behaviors must be created. The second project is the Android application [RobApp] (https://github.com/RoboboUPMC2016/RobApp/wiki). RobApp allows to use its behaviors on smartphones to test them with the Robobo. The last project is [RobDex] (https://github.com/RoboboUPMC2016/RobDex), this project is more internal than others and its use is hidden to users. RobDex allows compiling the behaviors to have Dex file and that can be loaded dynamically from the RobApp application.
1. Connection interface
The connection interfaces are the different HMIs of our authentication system, which allows registration for new users or the connection if we have already an account.
A. Sign in
This interface allows the various users already registered with RobHub to access the RobHub homepage.
B. Sign up
This interface allows users to register for the first time on the social network RobHub by indicating their username, first name, last name and password which will be used to authenticate each user of RobHub.
3. Home page
This graphical interface contains a list of the behaviors of ROBOBO already ready to be downloaded. A description of the various projects related to RobHub (RobApp, RobDex, RobDev). For the various buttons at the top of the page:
-
Add behavior: Allows redirection to the Addbehavior page which allows to add a new behavior and publish it in the home page.
-
Loug out: Allows the disconnection of a user from his private space in the site.
-
OkOk: Is the example of a behavior already developed, a click on this icon will redirect you to a page that contains the details of the behavior.
4. Description of behavior
After clicking on the icon of a behavior of choice, one finds a detailed description on this behavior:
A. Java code of behavior
This interface gives the Java code that can be downloaded (Download .javabutton). The compiled file can also be downloaded (Download .java button).
B. Video of behavior
This interface allows to see the videos relative to the behavior.
C. The QR code of behavior
This interface allows to have the behavior QR code.
5. Add behavior
This interface is made to allow the user of RobHub to add theirs developed behaviors to the social network.
1.Label: This is the name of the behavior.
2.Description: This is the description of the behavior.
3.Behavourfile.java: Indicates that the behavior to upload must have the .java extension.
4.Browse: Button to find the behavior file you want to upload.
5.Add: Button to add the behavior to RobHub