FREE - Framework for Remote Experiments in Education

From wwwelab
Revision as of 04:33, 5 January 2022 by Ist187344 (talk | contribs)
Jump to navigation Jump to search

System architecture

In the defined architecture, users communicate with a central server, named FREE_Web, through web pages.

This FREE_Web server contains the database with the results of the experiments already carried out and the experimental executions and experimental time schedules requested by users through the web interface. The FREE_Web server is also responsible for mediating real-time communication between users and experiences, exchanging configuration requests, status requests and responses and generated data between users actively connected to the apparatus and apparatus.

Architecture of the new system. It is possible to observe the different layers of software that separate the users, on the left side of the image, from the experimental apparatus, on the right side of the image.


Along with the experimental apparatus, a computer, named RPi_Proxy, acts as an interface between the controller of the experimental apparatus and the FREE_Web server. Each RPi_Proxy is turned on and represents one, and only one, experimental apparatus. It is important to note that this component was named RPi_Proxy because it is, in principle, implemented through the use of a Raspberry Pi, a computer that has communication modules necessary to communicate natively with the microcontrollers usually used to control the devices. However, this component can be implemented in other ways and it is only strictly necessary that it communicates according to the protocol - e.g. a virtual experience with data generated through a numerical model can implement this component with a normal computer without specialized interfaces. The communication between all components is done over the internet, with the exception of the communication between the RPi_Proxy and the experimental apparatus, where communications are made through the protocol that the controller of the apparatus implements.

Communication protocol

To start the connection between the RPi_Proxy and the FREE_Web, when the RPi_Proxy is turned on, it tries to connect to the FREE_Web server. If not successful, it should wait 10 seconds and try again until it manages to make the connection.

  • Label
  • Label

When the connection is successfully established, the server RPi_Proxy sends to FREE_Webo its ID and Secret. These two variables are then checked on the FREE_Web server side as a simple way to authenticate that the connection is coming from an authorized machine. In case of successful verification, the FREE_Web responds to the RPi_Proxy with a message encoded in JSON format that describes the experience to be served by the RPi_Proxy. This configuration message allows the same RPi_Proxy program to be adaptable to different experiences with, for example, different numbers of actuators and sensors without changes to the source code. Based on the information contained in this message, the name of the config_file, the RPi_Proxy looks for the experiment at the indicated address and tries to establish communication with the controller of the experimental apparatus. In order to decouple the RPi_Proxy from the different communication protocols that each experimental controller may implement, the RPi_Proxy must communicate with the devices calling a set of standard methods whose implementation must be adapted to suit the target controller.


(TODO)


After this initial configuration, the connection of the RPi_Proxyao FREE_Weband the RPi_Proxyto the controller of the experiment, the system is ready for the exchange of messages between the components. The messages exchanged between components were defined following an everything is a string philosophy. Thus, the messages exchanged are JSON-formatted strings in which the JSON fields encode the message to be transmitted. The type of each message is identified by the msg_id field of the message JSON, and for the message sent, the reply, if any, must have reply_id with the same value. In order to be adaptable to various types of experimental apparatus, the system does not store apparatus status information so it is possible to send any of the defined messages at any time. The correct sequencing of messages for the successful operation of the apparatus is the responsibility of other user-controlled software layers.


Functions documentation

FREE_Web

RPi_Proxy

interface.py(RPi_Proxy)

How to install

Pre-requisites

Build environment

  • Git (2.30.2+)
  • Python (3.7.0+)

Raspberry PI (RPI_Proxy)

First checkout the project from github (https://github.com/e-lab-FREE/RPi_Proxy-PG), and you can get the code using:

   $ git clone https://github.com/e-lab-FREE/RPi_Proxy-PG

then edit the "main.py" file and change the following global variables:

   SERVER = "FREE_Web_IP"
   MY_IP = "RPi_IP"
   SEGREDO = "password"
   PORT = Port_to_comunication
   BINARY_DATA_PORT = Port_to_transfer_Binary_data

After this changes the RPi_Proxy is ready to run by typing:

   $ pyhton3 main.py

This will try to connect to the IP defined as SERVER every 10 sec.

Main Server (FREE_Web)

This software is the dispatcher of the information. By allowing the communications form the frontend and each RPi_Proxy responsable for a experience. To install this you need to install at least Python 3.7 and the lib Flask (https://pypi.org/project/Flask/).

Then go to the project from github:

   $ git clone https://github.com/e-lab-FREE/FREE_Web

Edit the "main.py" file and change the following global variables:

   SERVER = "FREE_Web_IP"
   MY_IP = "RPi_IP"
   SEGREDO = "password"
   PORT = Port_to_comunication
   BINARY_DATA_PORT = Port_to_transfer_Binary_data

After that you need to change or edit this last one variable "segredos",

ADD the new experiment.jpg

the struct of it's the following:

{ 
    "RPi_IP" :
    {
        "segredo": "password",
        "nome": "Name_of_the_exp"
    },
    ...
}

Config File (JSON)

In the project of the FREE_Web there is a folder called Configs, in there are all the configuration files of the experience linked to the FREE_Web. To add a new experiment you just have to copy one of the existing files and change its name to the experiment's and change the parameters in the config file:

Config JSON.jpg

After this changes done you can run the FREE_Web, typing the cmd:

   $ start.bat

Video Streaming

Intro

Video capture and stream

On the raspberry it is running ....

Janus stream server

Accessing the stream

The experiment stream can be access by a html ....

or by using VLC, allowing to grab the video