Open Bidouille Robot
Sommaire
- 1 Qu'est-ce qu'Open Bidouille Robot (OBR) ?
- 2 Pourquoi ce projet ?
- 3 Communication avec OBR
- 4 Ce qu'OBR sait faire pour le moment
- 5 Ce qu'il sera sensé faire plus tard
- 6 TeC'OBiR (Terminal Configuration pour Open Bidouille Robot), un programme PC pour configurer OBR
- 7 Code Arduino
- 8 Code C de TeC'OBiR
- 9 Changelog
- 10 Liens de téléchargements
Qu'est-ce qu'Open Bidouille Robot (OBR) ?
Open Bidouille Robot est un micrologiciel pour arduino, permettant la gestion de moteurs, capteurs, servomoteurs, entrée numériques et sorties numériques. En d'autres termes, OBR sert à la création de robot, via un arduino. Une fois compilé et installé sur la carte, il faut configurer OBR (via le PC par exemple) en envoyant une série de commandes. Une fois configuré, on peut toujours le reconfigurer (ajouter/enlever des servomoteurs, changer la vitesse maximum d'un moteur, etc...), mais aussi le piloter. Lorsqu'on demande à un moteur de tourner, OBR va vérifier dans la configuration s'il est lié à d'autres objets (capteurs, entrées, sorties...), et verrouiller ou non le moteur (de même pour une sortie tout ou rien, et un servomoteur). De cette manière, nous pouvons créer des systèmes de fin de courses, en liant plusieurs choses (ex : le moteur ne peut tourner que si le capteur vaut moins que x, et que l'entrée n°y est à 0).
Pourquoi ce projet ?
A la base, j'ai été à l'Open Bidouille Camp (d'où le choix de reprendre ce nom pour le projet) de 2012, où j'ai rencontré une connaissance qui voulait faire un robot démineur sans savoir programmer. Je partais donc avec un engin sur roues, avec un bras motorisé au dessus, mais non pilotable. De base, je devais donc coder un programme sur un arduino Mega2560, permettant de piloter les moteurs inclus dans l'engin. il y a peu, j'ai mis de côté le robot démineur pour me concentrer sur les robots en général. C'est donc de là que m'est venu l'idée de coder un système modulable, et adaptable à tous types de robots.
Communication avec OBR
La communication avec OBR suit une norme qui lui est propre, sous la forme : "[AdresseEnvoyeur|AdresseDestinataire]OBR_COMMANDE-PARAMETRES\n" Le protocole est assez strict, mais simple :
- La communication se fait via les ports séries, en 57600 bauds.
- Le dialogue se fait via des commandes, avec (au max) trois paramètres, et deux adresses (envoyeur et destinataire)
- Toutes les commandes ont un retour, même si ce n'est qu'un "OK"
- Il n'y a aucun espace dans une ligne
- La commande se termine toujours par un retour à la ligne ('\n')
- Les paramètres sont séparés par des tirets ('-')
- Un message peut passer par plusieurs cartes, il y a un système de routage, d'où l'obligation des adresses
- Seul la commande de demande de connexion n'a pas d'adresse, mais la réponse en a une (On ne sais pas à qui on se connecte, mais on sait qui nous répond)
- Le réseau peut se constituer d'un maître, épaulé par deux esclaves (pour augmenter le nombre de PIN), une télécommande, et un PC.
- Il y a donc 5 adresses : 1=PC, 2=Télécommande, 3=Maître, 4=Esclave1 et 5=Esclave2.
- Il ne peut pas y avoir deux périphériques du même type, comme deux PC, ou deux télécommandes.
- Le maître, l'esclave1 et l'esclave2 sont distincts, et ne peuvent pas changer (définit à la compilation). De ce fait, les adresses des PIN allant jusqu'à 255, on peut déterminer le N° du PIN (pour 234, c'est 34) et le N° de la carte (pour 234, c'est l'eclave2).
- Les connexions peuvent se faire en série, les commandes seront routées pour arriver à bon port.
Exemple de connexion entre le PC et le maître : PC <===========> {Esclave2 <=> esclave1 <=> Maître} : L'esclave2 recevra le message, le transmettra à l'esclave1, qui le transmettra au maître. c'est le chemin inverse que fera la réponse.
Ce qu'OBR sait faire pour le moment
Pour le moment (version 0.4), OBR ne sait pas faire grand chose, si ce n'est gérer les connexions entre arduinos, télécommandes et PC. Les commandes sont fonctionnelles, et on peut connaître le nom du robot, ainsi que sa version d'OBR installé. Une session administrateur est gérée, on peut l'utiliser (mot de passe par défaut : 2560) pour configurer le robot. Lorsque l'administrateur se connecte, la LED 13 s'allume pour dire que la configuration est susceptible d'être modifiée.
Ce qu'il sera sensé faire plus tard
Dans le futur (version 1.0), OBR devra toujours gérer les connexions automatiquement et à chaud, mais aussi enregistrer les configurations dans l'EEPROM, pour s'en servir lors du pilotage (l'EEPROM sera copié dans différents tableaux en RAM au démarrage). Le maître saura gérer les deux esclaves (si présents), pour piloter ses entrées/sorties. OBR devra gérer les batteries, et se désactiver si nécessaire. Un système de WatchDog fonctionnera sur les ports séries, pour détecter la déconnexion d'un périphérique.
TeC'OBiR (Terminal Configuration pour Open Bidouille Robot), un programme PC pour configurer OBR
Le Terminal TeC'OBiR est codé en C, en console, et permet de communiquer aisément avec un arduino tournant sous OBR. TeC'OBiR intègre la bibliothèque de communication OBR, ce qui lui permet de dialoguer avec OBR (un maître, un esclave ou une télécommande) facilement. Lorsqu'on lance TeC'OBiR, les 10 premiers ports séries sont scannés en boucle, tant qu'une carte sous OBR n'est pas connectée. Les avantages d'utiliser TeC'OBiR plutôt qu'un terminal série quelconque, sont multiples :
- La connexion se fait toute seule en arrière plan, aucune commande n'est à taper - Une fois connectée, on a le nom du robot, et la version d'OBR installée. - Les commandes que l'on tape sont mises en norme : Toutes les lettres sont mises en majuscule, les espaces sont remplacées par des tirets, les adresses sont automatiquement ajoutées, ainsi que le "OBR_" au début de la commande. - L'adresse est automatiquement définie selon la carte sur laquelle nous sommes connectés (maître, esclave, télécommande). - Il est possible de choisir sont destinataire en ajoutant 'x:' avant la commande, x étant variable (p: pour le PC, t: pour la télécommande, m: pour le maître, e1: pour l'esclave1 et e2 pour l'esclave2). - Si le mot de passe est 2560, la connexion en tant qu'administrateur se fait automatiquement, sinon, le mot de passe est demandée, pour une connexion automatique. - Entre chaque commande envoyée, le programme vérifie la connexion avec OBR, et se déconnecte si la carte est débranchée.
Exemple de commandes qu'on peut écrire avec TeC'OBiR, pour connaître le nom du maitre :
- "[1|3]OBR_NOM\n" - "OBR_nOm" - "nom" - "m:nom"
Code Arduino
Le code de la version en développement, sur GitHub : ici.
Code C de TeC'OBiR
Bibliothèque de communication OBR en C
Une bibliothèque a été créée pour faciliter la communication entre un programme codé en C, et un arduino tournant sous OBR. Cette bibliothèque est dépendant d'une autre, qui gère les connexions séries. Les deux bibliothèques (OBR.h et Serial.h) sont disponible au téléchargement, [github.com/Aglesia/OBR/blob/master/Dev/Bibliotheque_C ici].
Code OBR.h, sur GitHub
Le code de OBR.c, sur GitHub
Des suggestions ? Des conseils ? Je suis preneur ;)
Code de TeC'OBiR
TeC'OBiR utilise la bibliothèque OBR pour fonctionner...
Code : main.c
/**
Copyright (C) 2014 Fragni Dorian
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/// Bibliothèque de gestion des ports séries
#include "../Bibliotheques/Serial.h"
/// Bibliothèque de communication OBR
#include "../Bibliotheques/OBR.h"
/// Liste des fonctions
void AfficherAide();
int main()
{
Commande_OBR *Commande = 0;
int NoPort = 0, temp = 0;
char Buffer[130] = "";
#ifdef WIN32
system("Title Tec'OBir");
system("COLOR 09");
#endif
/// Message de bienvenue
printf("Bienvenue dans TeC'OBiR (Terminal Configuration for Open Bidouille Robot) V1.3\nCe programme est developpe par Dorian Fragni et le FabLab des fabriques du ponan.\nIcone de http://icons8.com.\nLe programme sert a configurer/deboguer un arduino tournant sour Open Bidouille Robot.\n\n");
SELECTPORT:
printf("Scan des ports en cours...\n");
Commande = 0;
while(!Commande)
{
for(NoPort=0; NoPort<10; NoPort++)
{
Commande = OBR_Connecter(NoPort, OBR_PC);
if(Commande)
break;
}
}
if(Commande)
{
printf("\n%s V%f Connecte !\n", Commande->Nom, Commande->OBR_Version);
/// Si la version est plus grande que la 0.1
if(Commande->OBR_Version >= 0.2)
{
/// On désactive la déconnexion auto
if(Commande->OBR_Version >= 0.37)
Envoie_Commande("OBR_DECONNEXION_AUTO-0", Commande, Commande->MAITRE_ESCLAVE);
Recup_Commande(Commande);
/// On s'authentifie si possible
printf("Connexion en tant qu'admin...\n");
/// Selon la version, la commande de connexion en admin n'est pas ma même
if(Commande->OBR_Version<0.37)
Envoie_Commande("OBR_CONNECTER-2560", Commande, Commande->MAITRE_ESCLAVE);
else
Envoie_Commande("OBR_CONNECTER_ADMIN-2560", Commande, Commande->MAITRE_ESCLAVE);
Recup_Commande(Commande);
if(!strcmp(Commande->Commande, "OK"))
printf("Connecte en tant qu'administrateur.\n");
else
{
/// Le mot de passe n'est pas 2560, on demande le mot de passe
printf("Mot de passe : ");
scanf("%s", Commande->Commande);
/// On vide le buffer d'entrée
while(getchar()!='\n' && getchar()!='EOF');
if(Commande->OBR_Version<0.37)
sprintf(Buffer, "OBR_CONNECTER-%s", Commande->Commande);
else
sprintf(Buffer, "OBR_CONNECTER_ADMIN-%s", Commande->Commande);
Envoie_Commande(Buffer, Commande, Commande->MAITRE_ESCLAVE);
Recup_Commande(Commande);
if(!strcmp(Commande->Commande, "OK"))
printf("Connecte en tant qu'administrateur.\n");
else
printf("Le mot de passe n'est pas bon, Connecte en tant que simple utilisateur.\n");
}
}
/// On invite l'utilisateur à entrer ses commandes
printf("Vous pouvez maintenant entrer vos commandes ;)\n128 caracteres MAX par commande !\n\nHELP=afficher l'aide et la liste des commandes\nVERSION=Afficher la version du programme\nEXIT=fermer la connexion et quitter\n\n");
strcpy(Buffer, "");
/// Tant qu'on ne quitte pas
while(strcmp(Buffer, "EXIT"))
{
/// On vide les buffers
strcpy(Buffer, "");
strcpy(Commande->Commande, "");
/// On demande à l'arduino s'il est prêt, il répond 1 si on est utilisateur, 2 si on est administrateur, et rien s'il est déconnecté
temp = ArduinoPret(Commande);
if(temp == 1)
printf("@utilisateur>");
else if(temp == 2)
printf("@administrateur>");
else
{
printf("Impossible de communiquer avec l'arduino, verifiez sa connexion.\nDeconnexion et scan des ports en cours...\n");
OBR_Deconnecter(Commande);
Commande = 0;
goto SELECTPORT;
}
/// On récupère la commande entrée par l'utilisateur
Commande_Console(Buffer, Commande);
/// Si on demande l'aide
if(!strcmp(Buffer, "HELP"))
AfficherAide();
/// Si on demande la version de l'OBR installé sur l'arduino
else if(!strcmp(Buffer, "VERSION"))
printf("Version d'OBR : %f\n", Commande->OBR_Version);
else
{
/// On envoie la commande
Envoie_Commande(Buffer, Commande, Commande->MAITRE_ESCLAVE);
/// On récupère la réponse
Recup_Commande(Commande);
/// S'il y a une réponse, on l'écrit à l'écran
if(strcmp(Commande->Commande, ""))
{
switch(Commande->NoEnvoyeur)
{
case 1:
printf("P:>%s\n", Commande->Commande);
break;
case 2:
printf("T:>%s\n", Commande->Commande);
break;
case 3:
printf("M:>%s\n", Commande->Commande);
break;
case 4:
printf("E1:>%s\n", Commande->Commande);
break;
case 5:
printf("E2:>%s\n", Commande->Commande);
break;
default:
printf("?>%s\n", Commande->Commande);
break;
}
}
}
}
/// on se déconnecte et on arrête le programme
printf("\nFermeture du port, et arret du programme...");
OBR_Deconnecter(Commande);
Commande = 0;
}
return 0;
}
void AfficherAide()
{
printf("\n\nAide :\nPour envoyer une commande, tappez la commande certifiee OBR, puis faites 'entree'.\nApres 1/10 de seconde, le programme affiche le retour, et vous rend la main.\n");
printf("\nListe des commandes de base :\n");
printf("OBR_PRESENT=Retourne VRAIE si OBR est present\n");
printf("OBR_VERSION=Retourne la version d'OBR installee\n");
printf("OBR_PRET=Retourne VRAIE si vous etes un utilisateur, ADMIN si vous etes un administrateur\n");
printf("Pour toutes les commandes, veuillez vous referer a la documentation.\n\n");
}
Changelog
OBR
0.1 :
- Première version, non fonctionnelle
0.2 :
- Mise en place du système de question/réponse, sous forme de commande de type OBR_COMMANDE-PARAMETRE1-PARAMETRE2-PARAMETRE3 - Ajout du mode administrateur - Ajout des modes configuration et pilotage - Première version du calcul du niveau de batterie - Passage du port série en 57600 bauds - Ajout du mot de passe, et son système de réinitialisation à "2560"
0.3 :
- Ajout du système d'authentification sur les ports série - Ajout de la prise en charge des cartes d'extension (jusqu'à deux cartes d'extensions) via RS232 (Mais les cartes seront inactives, sauf pour demander la liste des connexions externes) - Ajout du mapage réseau, permettant de relier le PC, télécommande et les cartes d'extensions sur n'importe quel port série (de n'importe quelle carte d'extension) - Ajout du système d'adresse dans les commandes, permettant le routage des données à travers les cartes ([1|2]OBR_...) - Ajout des constantes de compilation pour définir le nom du robot, et son rôle (maitre/esclave), ainsi que le type (MEGA, UNO...) - Ajout de la détection de déconnexion série, et déconnexion auto de l'administrateur
0.4 :
- WatchDog plus intelligent, évite la surcharge du réseau lorsque ça discute - Mise en place de la configuration des cartes d'extension via les ports série, permettant de les utiliser - Centralisation du pilotage des cartes, via le maitre - Mise en place des codes d'erreur dans le noyau du système - Mise en place des fonctions de copie RAM->EEPROM et EEPROM->RAM, contenant les données de fonctionnement (liste des moteurs, capteurs...)
0.5 :
- Ajout des fonctions de mise en place des périphériques (moteurs, capteurs...) - Ajout de toutes les commandes de pilotage - Gestion du pilotage des autres cartes
Pour le moment, la dernière version est la 0.37 : tout ce qui est dit dans la version 0.3 est faite, et une partie de la version 0.4 est traitée.
TeC'OBiR
1.0
- Utilise le protocole OBR - On peut enlever "OBR" et "OBR_" au début de la commande - Tous les espaces sont remplacés par des tirets - Commande 'HELP' affiche l'aide et les commandes existantes lors de la création de la version 1.0 - Commande 'EXIT' Ferme la connexion et quitte le programme
1.1
- La casse est automatiquement mise en majuscule sur les commandes envoyées - Ajout de la couleur bleue - Ajout de la commande 'VERSION' qui affiche la version du programme - Connexion automatique en essayant les 10 premiers ports en boucles - Détection de la déconnexion de l'arduino - Ajout de la connexion admin - Passage au baudrate de 57600 bauds.
1.2
- réécriture du noyau - Adaptation au nouveau protocole OBR 0.3 - Prise en compte des adresses
1.27
- Désactivation automatique du WatchDog inclus sur l'OBR 0.37 et +
1.3
- Ajout du choix de l'adresse destinatrice (Commande sous forme "add:OBR_COMMANDE-PARAMS" ex : pour connaitre le nom du maitre, "M:OBR_NOM") - Ajout de l'adresse émettrice dans la réponse - Séparation du code TeC'OBiR et de la bibliothèque OBR_Communication
1.4
- Adaptation au protocole OBR 0.4, qui inclus un watchdog sur la connexion série - Prise en charge des fichiers de config .map - Peut être ouvert avec, comme paramètre, un fichier .map. La configuration auto se fera dès que la connexion est effectuée
Pour le moment, la dernière version est la 1.27, qui désactive le chien de garde à la connexion, pour éviter les déconnexions intempestives. (il faudrait mettre moins de 5 secondes à taper une commande, et ne jamais s'arrêter...)
Liens de téléchargements
Un compte a été ouvert sur GitHub pour centraliser les fichiers sources...
Documents techniques + notices
Binaires finalisées
Open Bidouille Robot (à compiler sur un arduino)
Terminal Console for Open Bidouille Robot
Open Bidouille Robot Contrôleur Arduino (à compiler sur un arduino)
Open Bidouille Robot Contrôleur PC
Changelog
Changelog OBR Changelog TeC'OBiR
