summaryrefslogtreecommitdiff
path: root/i/siroco/src/HELP
diff options
context:
space:
mode:
authorgalmes2004-01-14 15:22:11 +0000
committergalmes2004-01-14 15:22:11 +0000
commit38ebaee86d56fcc8ff3d0f0b5451285d003f12f6 (patch)
tree43dea1282285212b213aaa13d19db1e207336a65 /i/siroco/src/HELP
parent0db514b44d66bf8c73d0d0ad2d68535d6b3ac2ff (diff)
Ajout du fichier HELP, définition et déclaration de plein de fichier.
Diffstat (limited to 'i/siroco/src/HELP')
-rw-r--r--i/siroco/src/HELP64
1 files changed, 64 insertions, 0 deletions
diff --git a/i/siroco/src/HELP b/i/siroco/src/HELP
new file mode 100644
index 0000000..a3889e5
--- /dev/null
+++ b/i/siroco/src/HELP
@@ -0,0 +1,64 @@
+Quelques explication sur les différents fichiers.
+
+
+I - Description des différentes classes
+
+1 - Interface :
+
+interface_widget.h :
+la classe parent pour l'interface.
+
+interface_container.h :
+
+interface_notebook.h :
+
+
+interface_asservissement.h :
+interface graphique pour le module asservissement.
+
+2 - Communication :
+
+communication_hub.h :
+gère la communication entre les différents modules (dont le robot). Registre
+et désenregistre les modules.
+
+communication_module.h :
+C'est la classe abstraite module.
+
+communication_asservissement_control.h :
+se charge d'envoyer au robot les demandes de changement de "paramètres"
+(changer les valeurs de pid...)
+
+communication_asservissement_data.h :
+c'est un module! il se charge de recevoir les données d'asservissement
+provenant du robot (aspirateur d'infos).
+
+3 - Message :
+
+Les structures des messages qui transitent sur le rézo.
+
+message.h :
+la classe parent.
+
+message_asservissement_info.h :
+les messages en relation avec 'asservissement, comme le p, i, d.
+
+message_asservissement_get_info.h :
+type de message pour demander au robot de renvoyer des infos sur
+l'asservissement.
+
+message_asservissement_data.h :
+message contenant les données en relation avec l'asservissement (c, p, m)
+
+message_asservissement_control.h :
+message de modification des coefficients de PID.
+
+
+II - Les modules :
+
+1 - L'asservissement
+
+comme données, il y a :
+- la consigne, ie, ce que l'on demande à la carte.
+- la pwm, ie, ce que l'on envoie au moteur.
+- la mesure, ie, ce que l'on obtient réellement.