Started to write the User Manual

docs/ManuelUtilisateur.md

@@ -0,0 +1,129 @@
+# Manuel utilisateur
+
+## Installation
+
+Pour Installer le projet, il faut aller sur le [repo](https://gitea.parano.ch/Maxluli/TrackTrends) qui contient le projet et suivre les étapes indiquées dans le ReadMe. Les étapes ne sont pas répètées ici pour éviter de la redondance et pour éviter de devoir changer cette documentation si les versions ou les dépendances à installer changent.
+
+## A quoi sert l'app ?
+
+Track Trends est une application Windows qui sert d'outil pour des abonnés de la F1TV qui veulent exploiter le potentiel de la page DATA de la F1TV.
+
+L'application est faite pour un seul cas d'utilisation :
+
+Récupèrer les infos d'un Grand Prix en cour ou d'une rediffusion et les afficher de manière plus intéressante (en mettant en valeur des infos, en construisant un historique et en en interpêtant d'autres).
+
+L'application est faite pour que l'utilisateur aie le moins de choses à faire pour que tout fonctionne. Cela ne veut pas dire que l'utilisateur n'a rien à faire et le but de ce document est d'expliquer les différentes étapes nescessaires à l'utilisation de l'application
+
+## Utilisation "Simple"
+
+Le but de cette section est de vous permettre d'apprendre à lancer, stopper et modifier les variables de fonctionnement de l'application. Vous serez donc en mesure d'utiliser le programme correctement.
+
+Vous devez commencer par lancer le programme.
+
+!["Page de lancement"](./Images/Manual/StartPage.png)
+
+Au lancement de l'app, vous devriez avoir une page comme ci dessus. Il y a beaucoup d'infos mais pour le moment ce qui nous intéresse c'est le menu en haut à gauche.
+
+!["Contrôles"](./Images/Manual/Controls.png)
+
+Si c'est la première fois que vous utilisez l'application il est possible qu'il n'y aie qu'un seul preset au lieu des quatres ci dessous voire même 0 si vous n'avez pas mis le preset inclus dans l'installation. Si vous n'avez aucun preset, passez directement à l'étape calibration avant de revenir ici.
+
+Comme vous pouvez le voir, en plus des presets slectionnables, il y a quatre boutons (dont deux grisés) et une boite de texte avec un lien.
+
+Le lien est la chose la plus simple. C'est le lien du Grand Prix que vous voulez analyser.
+
+### Récupèrer le lien vers le flux
+
+Pour remplir la boite de texte précitée il nous faut un lien et ce lien on le trouve sur la [F1TV](https://f1tv.formula1.com/).
+
+Quand vous vous rendez sur la F1TV la page principale devrait ressembler à quelque chose comme ca (évidemment le contenu ne sera pas le même):
+
+!["Page principale de la F1TV"](./Images/Manual/F1TvMainPage.png)
+
+Si vous ne vous êtes pas déja connecté, connectez vous et ensuite allez sur la page du Grand Prix qui vous intéresse.
+
+Pour un Grand Prix en direct, normalement, il y a un endroit ou vous pouvez cliquer pour accèder au flux directement, et si vous voulez utiliser un Grand Prix en différé vous pouvez aller dans "202x Season" ou x est l'année en cour, en l'occurence 2023. Et la vous pourrez selectionner un Grand Prix.
+
+Dans tous les cas, quand vous avez selectionné votre Grand Prix vous devriez vous retrouver sur une page de ce style :
+
+!["Page d'un Grand Prix sur la F1TV"](./Images/Manual/F1TvGpPage.png)
+
+Et ici si vous êtes sur un Grand Prix en direct, vous pouvez directement copier l'URL de la page et si c'est un Grand Prix en diffèré, vous pouvez directement naviguer avec la barre de progression vidéo du lecteur de la F1TV, Je conseille de la placer juste après le départ. Vous pouvez prendre le lien avant ou après avoir changé le timecode de la vidéo cela ne change rien, le lien ne contient pas votre progression dans la vidéo.
+
+Ensuite vous pourrez juste mettre le lien que vous avez récupéré dans la boite de texte que l'on a vu précédemment. Il faut simplement s'assurer que le lien contient bien le terme `?action=play` à la fin.
+
+### Boutons
+
+Vous n'avez accès qu'à deux boutons au lancement de l'application. Le premier nommé 'Config' et le second 'Launch'
+
+Le bouton 'Config' permet d'ouvrir la page de calibration (voir section Calibration)
+
+Le bouton Launch permet de lancer le programme. Le texte peut changer (Par exemple en 'Retry' si le lancement a raté) mais son utilité reste la même : Lancer le navigateur virtuel qui sera requis pour trater les données.
+
+Si vous cliquez sur Launch tous les boutons devraient être grisés, c'est normal. Pendant le lancement du navigateur l'application ne peut pas être utilisée pour éviter des conflits. Il faut simplement attendre. Vous aurez également des fenêtres d'invite de commande qui vont s'ouvrir et se fermer c'est tout à fait normal et il ne faut pas interragir avec tant que tout ne s'est pas stabilisé.
+
+Vous devriez voir enfin une fenêtre comme celle ci :
+
+!["Page suspecte (Pas de panique elle ne l'est pas)"](./Images/Manual/SuspectCmd.png)
+
+Il ne faut pas fermer cette fenêtre. C'est la seule chose qui nous relie au navigateur virtuel qu'utilise l'application. Il ne faut pas la fermer par contre vous pouvez la réduire et la laisser en background c'est d'ailleur ce que je vous recommande de faire.
+
+Peu après l'ouverture de cette fenêtre vous devriez avoir accès à trois boutons.
+
+- Bouton 'Config' qui fait la même chose qu'avant
+- Bouton 'Re Launch' qui remplace le bouton 'Launch' qui permet de relancer le processus dans le cas ou vous auriez envie de changer de lien ou de preset.
+- Bouton 'Start' démarre le processus de récupèration de données.
+
+Si vous cliquez sur ce dernier, vous lancerez le programme. Cela peut prendre quelque secondes à s'actualiser mais très vite vous devriez vous trouver devant une page comme celle ci :
+
+!["Début du programme"](./Images/Manual/StartOfSimulation.png)
+
+Vous n'aurez alors qu'un seul bouton disponible : le bouton 'Stop'.
+
+Vous pouvez arrêter le programme quand vous le voulez. ATTENTION : Avant de fermer le programme, merci de stopper dabord le processus.
+
+Si vous stoppez le processus vous devriez vous retrouver dans la même situation que juste après avoir lancé le navigateur virtuel :
+
+!["Arrêt du programme"](./Images/Manual/Stopeed.png)
+
+Vous pouvez voir en dessous la dernière image que le programme a décodé et vous avez de nouveau accès aux trois boutons expliqués précédemment.
+
+Quand l'application a été lancée vous pouvez aussi cliquer sur les données affichées mais ces comportements sont expliqués dans la section "Comprendre les données"
+
+Voila ! Vous savez comment lancer, stopper et modifier les variables de fonctionnement de l'application. Maintenant vous pouvez passer directement à la section "Comprendre les données" si vous voulez apprendre comment utiliser ce que propose le programme ou passer à la section "Calibration" si vous voulez apprendre à configuer l'application et créer des Presets.
+
+## Calibration
+
+Ici vous apprendrez à configurer l'application pour créer vos propres presets et surtout pourquoi vous auriez besoin de le faire et à quoi servent ces fameux "Preset". Vous serez en mesure d'adapter le fonctionnement de l'application qu'elle soit conforme aux différents changements d'interface et de pilotes présents.
+
+### Pourquoi calibrer l'application et créer un Preset ?
+
+Le programme que vous allez utiliser utilise de l'OCR (Optical Character Recognition). Cela veut dire que le programme va aller regarder chaque image de la F1TV et convertir ce qu'il y a marqué dessus en données que l'on peut récupèrer automatiquement.
+
+Sauf que pour y arriver, le programme a besoin de savoir ou se trouve le texte important et surtout quel type de donnée il est scensé trouver à tel ou tel endroit.
+
+Pour être plus précis il a également besoin de savoir quels pilotes peuvent se trouver dans la course actuelle.
+
+Et pour qu'il sache tout cela, il y a des fichiers de configuration nommés "Presets" qui doivent contenir toutes ces informations. Et pour les créer, il existe la page de calibration qui va demander à un humain de lui fournir les infos qu'il ne peut pas trouver par lui même.
+
+Normalement il devrait y avoir un Preset fournis par l'application quand vous la téléchargez depuis le [repo](https://gitea.parano.ch/Maxluli/TrackTrends) mais vous pouvez avoir besoin de faire votre propre "Preset" dans deux cas :
+
+- Quand les pilotes présents ne sont pas les mêmes (Ex: Si un pilote doit être remplacé ou si de nouveaux pilotes sont arrivés ou bien que d'autres aient pris leur retraite)
+- Quand vous voulez utiliser des Grand Prix faits d'une autre année que celle pour laquelle le "Preset" original a été prévu. (L'année devrait être mentionnée dans le nom du preset)
+
+Il est déconseillé d'utiliser ce projet pour des Grand Prix courus avant 2022 car l'interface de la page Data de la F1TV peut avoir trop changé mais vous pouvez toujours essayer pour voir en faisant votre propre Preset pour des années comme 2021 ou 2020.
+
+### Comment créer son Preset
+
+Pour créer son Preset, il faut utiliser la page Settings ou Config de l'application.
+
+Pour y accèder il faut simplement cliquer sur le bouton "Config" de la page principale et vous serez acceuilli par une page qui devrait ressembler à celle ci dessous:
+
+!["Page de config vide"](./Images/Manual/EmptySettingsPage.png)
+
+La seule différence est que vous aurez sûrement moins de Presets dans la liste des Presets voir vous pouvez n'en avoir aucuns.
+
+
+## Comprendre les données
+
+## Erreurs

docs/jdb.md

@@ -3083,4 +3083,23 @@ J'ai pris pas mal de temps aussi à faire ces trois autre diagrammes un peu plus
 
 !["Diagramme Traitement"](./Images/Figma/DiagrammeTraitement.png)
 
-Je pense qu'ils sont un peu plus faciles à comprendre que le gros diagramme général. Ce que je me dis c'est que je vais faire une section fonctionnement général ou je vais expliquer les trois parties avec les petits diagramme et résumer avec le grand diagramme.
+Je pense qu'ils sont un peu plus faciles à comprendre que le gros diagramme général. Ce que je me dis c'est que je vais faire une section fonctionnement général ou je vais expliquer les trois parties avec les petits diagramme et résumer avec le grand diagramme.
+
+## Lundi 5 Juin 2023
+
+Ce weekend j'ai voulu essayer le projet pour le Grand Prix de Barcelone qui s'est soldé en un échec cuisant...
+
+J'ai eu trois soucis pour l'utilisation du programme. Les voici dans l'ordre croissant d'importance et de difficulté à règler :
+
+- Mon Laptop est incapable de rester plus d'une heure allumé même complêtement chargé à 100%
+- Le WIFI de chez moi a du mal à gèrer plusieurs flux 1080p en même temps et donc le temps de chargement est trop long ce qui me fait des erreurs 105
+
+!["Ce que voyait le programme pendant les erreurs 105 ce dimanche"](./Images/Screens/BadWifi105.png)
+
+- Le fait que quand un flux est en live, quand on clique dessus, un nouveau bouton apparâit qui n'était pas prévu et qui nous propose de regarder depuis le début ou en live. Le soucis avec ce bouton c'est qu'il n'est présent que pour les sessions live... Il va donc falloir attendre le prochain GP (Canada 18 Juin) pour faire un test en conditions réelles.
+
+!["Ce que voyait le programme avant que j'essaie d'implémenter le click auto"](./Images/Screens/BadLiveHandling.png)
+
+J'ai essayé de règler le problème en Live, le soucis c'est que j'ai un commentaire à fournir pendant la course et donc je n'ai pas eu le temps de plus me pencher sur le cas. Le weekend du prochain Grand Prix je vais essayer de tester sur les scéances d'essais libres.le click du bouton et j'amenerai mon cable chez moi.
+
+Bon sinon aujourd'hui, comme d'hab, Doc... Je vais faire le manuel utilisateur.