Ecriture de la documentation pour python et du système

portail_coulissant/porcou_doc.py

@@ -17,49 +17,56 @@ card_description ={}
 
 # Maquette
 card_model_title="Maquette"
-card_model_text=""" Le modèle 3D est basé sur la \n maquette développée par \n l\"entreprise A4 Technologie. \n 
+card_model_text=""" Le modèle 3D est basé sur la maquette \n développée par l\"entreprise A4 Technologie. \n 
- Les documents techniques et \n pédagogiques signés \n A4 Technologie sont diffusés \n librement sous licence \n Creative Commons BY-NC-SA."""
+ Les documents techniques et \n pédagogiques signés A4 Technologie \n sont diffusés librement sous licence \n Creative Commons BY-NC-SA."""
 card_model_url=[["Wiki A4 Technologie","https://www.a4.fr/wiki/index.php?title=Portail_coulissant_(BE-APORT-COUL)"]]
 card_description.update({"model-card" : [card_model_title, card_model_text, card_model_url]})
 
 # Jumeau numérique
 card_twins_title="Jumeau numérique"
-card_twins_text=""" jumeau(port, vitesse=115200) \n -> Active le jumeau réel par la \n liaison série. Si le port n\"est pas \n spécifié, il est recherché \n automatiquement. \n
+card_twins_text=""" jumeau() \n -> Active le jumeau réel.\n  
- serie_msg(texte) \n -> Envoi un message \n \n texte=serie_rcpt() \n -> Reçoit un message"""
+ jumeau_config(port, vitesse) \n -> Définit la configuration de la liaison \n série.
+ 
+ Si le port n\"est pas spécifié, il sera \n recherché automatiquement \n (carte Arduino Uno ou Mega). \n
+ La vitesse par défaut est 115200 baud."""
+card_twins_url=[["Microcontrôleur Arduino","https://www.arduino.cc/"],
+                ["Liaison série : pySerial","https://pythonhosted.org/pyserial/"],
+                ["Protocole Firmata : pyFirmata","https://github.com/tino/pyFirmata"]]
+card_description.update({"twins-card" : [card_twins_title, card_twins_text, card_twins_url]})
 
 # Message envoyé (asynchrone) : \n avancer : a, reculer : r, droite : d, \n gauche g, marquer : m et forer : f \n\n\n """
-card_twins_url=[]
+ # serie_msg(texte) \n -> Envoi un message \n \n texte=serie_rcpt() \n -> Reçoit un message"""
-card_description.update({"twins-card" : [card_twins_title, card_twins_text, card_twins_url]})
  
 # Ouvrir et fermer
 card_movement_title="Ouvrir et fermer"
-card_movement_text=" FIXME"
+card_movement_text=""" mot_o (True|False) \n -> Ouvre le portail (moteur sens trigo) \n
-# card_movementurn_text=" rp_gauche() \n -> Tourne à gauche (90°).\n \n rp_droite() \n -> Tourne à droite (90°)."
+ mot_f (True|False) \n -> Ferme le portail (moteur sens horaire) \n
+ fdc_o() \n -> Capteur fin de course portail ouvert\n Retourne True si le portail est ouvert. \n
+ fdc_f() \n -> Capteur fin de course portail fermé\n Retourne True si le portail est fermé."""
 card_movement_url=[]
 card_description.update({"movement-card" : [card_movement_title, card_movement_text, card_movement_url]})
 
 # Capteurs
-card_sensor_title="Capteurs"
+card_sensor_title="Capteur Infrarouge"
-card_sensor_text=" FIXME"
+card_sensor_text=""" ir_emet(True|False) \n -> Active l\"émetteur infrarouge (IR) \n 
-# card_sensor_text=" rp_marquer() \n -> Place une balise sur la case. \n \n Ropy possède que 20 balises, il ne \n peut pas en poser une de plus.\n\n Avec l'amélioration \"Balise +\", le \n nombre de balise transportées est \n étendu à 200."v
+ ir_recep() \n -> Récepteur barrage infrarouge (IR)\n Retourne True s\"il n\"y a pas d\"obstacle."""
 card_sensor_url=[]
 card_description.update({"sensor-card" : [card_sensor_title, card_sensor_text, card_sensor_url]})
 
 # Gyrophare
 card_gyro_title="Gyrophare"
-card_gyro_text=" FIXME"
+card_gyro_text=""" gyr (True|False) \n -> Active le gyrophare"""
-# card_gyro_text=" rp_marquer() \n -> Place une balise sur la case. \n \n Ropy possède que 20 balises, il ne \n peut pas en poser une de plus.\n\n Avec l'amélioration \"Balise +\", le \n nombre de balise transportées est \n étendu à 200."
 card_gyro_url=[]
 card_description.update({"gyro-card" : [card_gyro_title, card_gyro_text, card_gyro_url]})
 
 # Pupitre
 card_board_title="Pupitre"
-card_board_text=" FIXME"
+card_board_text= """ bp_ext() \n -> Bouton poussoir coté rue\n Retourne True si le bouton est pressé.\n 
+ bp_int() \n -> Bouton poussoir coté cour\n Retourne True si le bouton est pressé."""
 # card_board_text=" rp_marquer() \n -> Place une balise sur la case. \n \n Ropy possède que 20 balises, il ne \n peut pas en poser une de plus.\n\n Avec l'amélioration \"Balise +\", le \n nombre de balise transportées est \n étendu à 200."
 card_board_url=[]
 card_description.update({"board-card" : [card_board_title, card_board_text, card_board_url]})
 
-
 ##
 # Envoi des données
 ##

twin_doc.py

@@ -50,7 +50,7 @@ python_card=["function-card", "alternative-card", "loop-card", "flow-card", "con
 
 # Fonction
 card_function_title="Fonction"
-card_function_text=" La définition d\"une fonction se fait \n avec \'def\'. La fonction peut \n renvoyer une valeur avec \'return\'. \n\n"
+card_function_text=" La définition d\"une fonction se fait avec \n \'def\'. La fonction peut renvoyer une \n valeur avec \'return\'. \n\n"
 card_function_text=card_function_text + " def fonction_1 (arguments) : \n    instruction_1 \n    instruction_2 \n    ....\n    return valeurs_renvoyées \n\n"
 card_function_text=card_function_text + " Les arguments sont des données \n transmises à la fonction."
 card_function_url=[["w3schools.com : functions","https://www.w3schools.com/python/python_functions.asp"]]
@@ -59,7 +59,7 @@ card_description.update({"function-card" : [card_function_title, card_function_t
 # Alternative
 card_alternative_title="Alternative"
 card_alternative_text=" L\"alternative permet d\"éxécuter des \n instructions en fonction d\"un test. \n"
-card_alternative_text=card_alternative_text + " Elle se programme en suivant la \n suite : \'if \' (si) ... \'else\' (sinon) ... \n\n"
+card_alternative_text=card_alternative_text + " Elle se programme en suivant la suite : \n \'if \' (si) ... \'else\' (sinon) ... \n\n"
 card_alternative_text=card_alternative_text + " if condition :\n"
 card_alternative_text=card_alternative_text + "     instruction_1\n"
 card_alternative_text=card_alternative_text + " else : \n"
@@ -70,7 +70,7 @@ card_description.update({"alternative-card" : [card_alternative_title, card_alte
 
 # Boucles
 card_loop_title="Boucles"
-card_loop_text=" Il y a deux types de boucle : \n - avec \'for\' pour définir un nombre \n   de répétition (ici n), \n - avec \'while\' (tant que) pour \n   prendre en compte une condition. \n \n"
+card_loop_text=" Il y a deux types de boucle : \n - avec \'for\' pour définir un nombre de \n   répétition (ici n), \n - avec \'while\' (tant que) pour prendre \n   en compte une condition. \n \n"
 card_loop_text=card_loop_text + " for i in range (n) : \n     instruction \n \n"
 card_loop_text=card_loop_text + " while condition : \n     instruction"
 card_loop_url=[["w3schools.com : for","https://www.w3schools.com/python/python_for_loops.asp"],
@@ -79,10 +79,10 @@ card_description.update({"loop-card" : [card_loop_title, card_loop_text, card_lo
 
 # Flux
 card_flow_title="Contrôle du flux"
-card_flow_text=" Les structures (if, while, for) peuvent \n être gérées plus finement par les \n fonctions \'break\', \'continue\' et \n \'pass\'. \n\n"
+card_flow_text=""" Les structures (if, while, for) peuvent \n être gérées plus finement par les \n fonctions \'break\', \'continue\' et  \'pass\'. \n
-card_flow_text= card_flow_text + "- \'break\' : termine l\"itération en \n  cours et arrête la boucle.\n"
+ - \'break\' : termine l\"itération en cours et \n  arrête la boucle.
-card_flow_text= card_flow_text + "- \'continue\' : termine l\"itération en \n   cours et reprend la boucle.\n"
+ - \'continue\' : termine l\"itération en cours et \n   reprend la boucle.
-card_flow_text= card_flow_text + "- \'pass\' : instruction vide." 
+ - \'pass\' : instruction vide.""" 
 card_flow_url=[["w3schools.com : break","https://www.w3schools.com/python/ref_keyword_break.asp"],
              ["w3schools.com : continue","https://www.w3schools.com/python/ref_keyword_break.asp"],
              ["w3schools.com : pass","https://www.w3schools.com/python/ref_keyword_pass.asp"]]
@@ -114,7 +114,7 @@ card_description.update({"oop-card" : [card_oop_title, card_oop_text, card_oop_u
 
 # Console
 card_console_title="Console"
-card_console_text=" Si vous avez executé Ropy dans un \n terminal avec l\"option \'-con\', vous \n pouvez utiliser le terminal comme \n console de debuggage.\n\n"
+card_console_text=" Si vous avez executé Ropy dans un \n terminal (avec l\"option \'-con\'), vous \n pouvez utiliser le terminal comme \n console de debuggage.\n\n"
 card_console_text= card_console_text + " print(\'Bonjour !\') \n -> Affiche le texte dans la console.\n\n"
 card_console_text= card_console_text + " variable = input () \n -> Permet la saisie, par exemple : \n"
 card_console_text= card_console_text + " entree = \'\'\n while entree == \'\' :\n     entree = input ()"
@@ -124,9 +124,9 @@ card_description.update({"console-card" : [card_console_title, card_console_text
 
 # Temps
 card_sleep_title="Gestion du temps"
-card_sleep_text=" Vous pouvez créer des \n temporisations dans le déroulement \n du script.\n\n"
+card_sleep_text=" Vous pouvez créer des temporisations \n dans le déroulement du script.\n\n"
 card_sleep_text= card_sleep_text + " time.sleep(x) \n -> Marque d\"un temps d\"arrêt de \n     x secondes.\n\n"
-card_sleep_text= card_sleep_text + " Il faudra préalablement importer la \n bibliothèque \'time\' avec \n \'import time\'."
+card_sleep_text= card_sleep_text + " Il faudra préalablement importer la \n bibliothèque \'time\' avec \'import time\'."
 card_sleep_url=[["docs.python.org : sleep","https://docs.python.org/fr/3/library/time.html#time.sleep"]]
 card_description.update({"sleep-card" : [card_sleep_title, card_sleep_text, card_sleep_url]})