README

Dans tout ce README nous concéderons que le terminal est placé au niveau du dossier du projet.

cd path/vers/le/dossier/du/projet

Auteurs

• BRIENT Nathan
• GAUTIER Pierre-Louis
• LECENNE Gabriel
• MOLARD Simon

Copyright

Voir LICENCE.md.

Description Générale

Un client aimerait compléter son prototype de robot autonome avec un mécanisme robuste de indoor-positioning. Une étude de positionnement basée sur la technologie Wifi a démontré que cette technologie était trop imprécise et instable pour répondre à la demande. Cette année, le client cherche à implémenter et à qualifier une solution basée sur l’utilisation de balises bluetooth afin qu’elle soit dans un second temps intégrée dans sa solution de robot autonome.

Notre projet est de créer une application permettant de tester la fiabilité de la technologie bluetooth. Elle n’est en aucun cas une technologie de positionnement.

Pour pallier l’incapacité du robot à se situer dans un espace fermé, en récupérant sa position dans son environnement pour être en mesure d’interagir avec le robot en prenant compte de sa localisation.

Installation

Après le clonage du dépot, executer cette commande:

git config core.hooksPath .githooks

Et ce afin que tout le monde utilise les même git hook.

Pour la suite, dans le dossier Geologie entrer la commande :

make help

Logiciel nécessaire

Afin de pouvoir developer, certains logiciels sont nécessaire. Référer vous à la documentation de votre distribution (ou OS) pour savoir comment les installer.

• arm-ostl-linux-gnueabi-gcc : ensemble des paquets utilisés dans le processus de compilation d'un programme, pour OpenSt8Linux
• CMocka : framework de test unitaire, son installation peut nécessiter CMake (dépends de votre distribution / OS), de plus, il faut installer les librairies statiques
• CppCheck : outil d'analyse statique pour le C et le C++
• Doxygen : outil permettant de générer la documentation des annotations dans le code source.
• GCC : ensemble de compilateur pour le C, C++, Objectif-C ...
• GCovr : utilitaire pour générer les rapport de couverture de code
• libbluetooth-dev : Fichiers de développement pour utiliser la bibliothèque BlueZ (Bluetooth) sous Linux
• Make : outil permettant de controller la génération des éxécutables et d'autres type de génération

Il est fortement recommandé d'utiliser les dernières versions des ces logiciels et librairies.

Architecture du projet

Dans ce projet, le framework CMocka est utilisé. Celui-ci doit se trouver dans un dossier nommé cmocka-1.1.5_x86_64. La chaîne de compilation arm-ostl-linux-gnueabi-gcc est aussi utilisée. Celle-ci doit être dans un dossier nommé SDK. La structure du projet doit donc être (en se plaçant les dossiers au dessus de la racine du projet (cd ..)):

.
├──cmocka-1.1.5_x86_64
|  └── ...
├── SDK
|  └── ...
└── Geologie
   ├── explorations
   ├── production
   |  ├── Geobalise
   |  └── Geologie
   ├── template
   └── README.md

exploration

Ce dossier contient les codes élaborés lors d'exploration, ceux-ci peuvent être réutilisé pour le code de production.

production

Ce dossier contient le code de production, celui composant l'exécutable finale.

template

Ce dossier contient deux fichiers d'exemples et un dossier de configuration:

.
├── code template
│  ├── C_Header_File.xml
│  ├── C_Source_File.xml
│  ├── File_Comment.xml
│  └── Formater.xml
├── example.c
└── example.h

Les fichiers exemple.h et exemple.c décrivent rapidement les règles de codage pour le dossiers de production.

Le dossier code template contient des fichiers de configuration de l'environnement de développement.

C_Header_File.xml_ et C_Source_File.xml sont des fichiers de configuration des templates des fichiers sources et headers. Formater.xml est le fichier de configuration du formater des fichiers.

ST CUBE IDE

Pour l'installation de l'environnement de développement référer vous à la documentation du IDE fourni par ST.

Après l'installation il faut adapter certains paramètres (template des fichiers sources et headers ainsi que celui du formateurs, voir dossier template). Voir la page Code Templates Preferences et Import XML file for path and symbols programmatically

Cross-compilation

Compilation

La cible du projet est une STM32MP1 utilisant comme OS OpenStLinux 5.10. Cet OS utilise un compilateur spécifique ostl-linux-gnueabi. Afin de pouvoir facilement il faut changer la valeur de la variable CC (on considère ici que le dossier contenant le compilateur ce trouve au-dessus de la racine du projet, voir section Architecture du projet).

source ../SDK/environment-setup-cortexa7t2hf-neon-vfpv4-ostl-linux-gnueabi

Pour tester le bon changement il faut utiliser la commande:

$CC --version

et doit retourner (peut varier):

arm-ostl-linux-gnueabi-gcc (GCC) 9.3.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Copie du fichier vers la cible

Pour partager une copie de l'executable générer à l'aide de la commande précédente, il faut utiliser la commande scp :

scp <fichierACopier> <utilisateurCible>@<adresseIP>:<cheminOuCopierLeFichier>