# retrobox overlay

## cahier des charges

l'overlay permetera de :

- savoir la liste des jeux installé
- installer un jeu
- enlever un jeu
- changer la langue
- changer des paramètres divers
- récupérer la santé du client (température, CPU, RAM, Espace Disque etc)
- récupérer la mémoire restante et totale
- récupérer le uptime
- récupérer l'usage cpu et ram
- récupérer l'IP de l'utilisateur
- récupérer le nom du réseau WIFI auquel la console est connecté
- récupérer le theme installé
- rajouter un theme :+1:
- changer rapidement de thème
- rajouter des bios (se fera automatiquement lors de l'ajout d'un jeu :+1:)
- pouvoir modifier le fichier wifikeyfile.txt, a partir de l'application
- Savoir si la console est sur l'écran HDMI ou le LCD
- Savoir quel périphériques est connectés sur la console (manettes, USB etc)

Attention la console doit pouvoir rester fonctionnelle hors connexion pour cela il faut que le nodejs, en cas de déconnexion, retente toute les 1 min ou autre échelle de temps

## numéro de série

le numéro de série sera alors composé de 5 caractères possibilités 36 : `ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789` ce qui fait 36^5 possibilités soit plus de 60 millions de possibilitées

ex: A5V8D

ex: qr code


## installation

A sh script is runned to install dependency and run deamon:

- nodejs & npm
- pm2 for deamon
- npm install
- pm2 start `index.js`

## actions

pour communiquer avec le server websocket le client et le serveur utilisent des actions un peut comme des routes http
une action est caractérisé par une route et un sens
chaque action est accompagné de paramètres lors de l'envoie et d'un corps lors du retour

liste des actions:

- first_start : CONSOLE > SERVER : Permet de signaler au serveur un nouveau client
- update_status : CONSOLE > SERVER : Permet de signaler au serveur un changement de status de la console, lors d'un démarrage par exemple
- check_status : CONSOLE > SERVER : toutes les 5 min cette action permet de s'assurer que la console est toujours allumé
- get_status : SERVEUR > CONSOLE : Récupérer le status de la console
- get_uptime: SERVEUR > CONSOLE
- get_healt: SERVEUR > CONSOLE : obtenir la température
- install_game : SERVEUR > CONSOLE

### exemple

Le serveur envoie cette requête à l'overlay:

 {
     "auth": "JWT_TOKEN",
	 "type": "request",     
	 "action_name": "install_game",
	 "params": {
		 "game_id": "EPdQyyCiPs"		
	 }
 }

Le client répond:

 {
	 "type": "response",
	 "action_name": "install_game",
	 "body": {
		 "success": true
	 }
 }

## Initialisation

Quand le nodejs démarre pour la première fois, le deamon envoie une requeste avec l'action `first_start` avec l'id de la console [WIP]