Ajout de la documentation sur le brochage

asset/icons/doc/game-icons/system/unplugged.svg

@@ -0,0 +1 @@
+<svg style="height: 512px; width: 512px;" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M0 0h512v512H0z" fill="#ffffff" fill-opacity="1"></path><g class="" style="" transform="translate(0,0)"><path d="M196 136c-61.174 0-111.656 45.834-119.063 105H16v30h60.938C84.344 330.166 134.825 376 196 376h15c8.31 0 15-6.69 15-15v-30h45v-30h-45v-90h45v-30h-45v-30c0-8.31-6.69-15-15-15h-15zm210 0c-8.31 0-15 6.69-15 15v30h30v30h-30v90h30v30h-30v30c0 8.31 6.69 15 15 15h90V136h-90z" fill="#000000" fill-opacity="1"></path></g></svg>

portail_coulissant/porcou_doc.py

@@ -8,20 +8,22 @@
 # @license: GNU GPL
 ###############################################################################
 
+# Texte en X : 426.474 m
+
 ################################################################################
 # Documentation du système
 ################################################################################
 
-# system_card=["twins-card", "serial-card", "movement-card", "sensor-card", "gyro-card", "board-card", "model-card", "arduino-card"]
-system_card=["twins-card", "firmata-card", "movement-card", "sensor-card", "gyro-card", "board-card", "model-card", "arduino-card"]
+system_card=["twins-card", "pin-card", "firmata-card", "movement-card", "sensor-card", "gyro-card", "board-card", "model-card", "arduino-card"]
 system_card_description ={}
 
 # Jumeau numérique
 card_twins_title="Jumeau numérique"
 card_twins_text=""" jumeau(brochage) \n -> Active le jumeau réel.\n
+ brochage permet de faire le lien entre les \n deux jumeaux (plus de précision sur la \n page "Brochage").\n
  jumeau_stop() \n -> Désactive le jumeau réel.\n
-Le brochage est un dictionnaire, par \n exemple : brochage={ "bouton": ['d',2,'i'], \n "led": ['d',3,'o'] }.\n
-Les objets numériques du jumeau sont : \n 'bp_ext', 'bp_int', 'fdc_o','fdc_f', 'mot_o',\n 'mot_f', 'gyr','ir_emet' et 'ir_recep'."""
+ Avec "carte=jumeau(brochage)", on peut \n utiliser l'objet "carte" pour communiquer \n directement avec le protocole Firmata."""
+# Les objets numériques du jumeau sont : \n 'bp_ext', 'bp_int', 'fdc_o','fdc_f', 'mot_o',\n 'mot_f', 'gyr','ir_emet' et 'ir_recep'."""
  # Avec "carte=jumeau(brochage)", on peut \n utiliser l'objet "carte" pour communiquer \n directement avec le protocole Firmata.
   # jumeau_config(port, vitesse) \n -> Définit la configuration de la liaison \n série.\n
  # Si le port n'est pas spécifié, il sera \n recherché automatiquement (carte \n Arduino Uno ou Mega). \n
@@ -29,12 +31,28 @@ Les objets numériques du jumeau sont : \n 'bp_ext', 'bp_int', 'fdc_o','fdc_f',
 card_twins_url=[]
 system_card_description.update({"twins-card" : [card_twins_title, card_twins_text, card_twins_url]})
 
+# Brochage
+card_pin_title="Brochage"
+card_pin_text=""" Le brochage est un dictionnaire qui permet \n d'associer les objets 3D du jumeau \n numérique aux broches du jumeau réel, 
+ brochage = { nom : [type, broche, mode] } :
+ - nom : nom de l'objet 3D,
+ - type : a (analogique) ou d (numérique),
+ - broche : numéro de la broche de carte,
+ - mode : i (entrée), o (sortie) ou p (pwm).
+ Par exemple : brochage = { "led" : ['d', 3, 'o'] }.\n
+Les objets numériques du jumeau sont : \n 'bp_ext', 'bp_int', 'fdc_o','fdc_f', 'mot_o',\n 'mot_f', 'gyr','ir_emet' et 'ir_recep'."""
+ # Avec "carte=jumeau(brochage)", on peut \n utiliser l'objet "carte" pour communiquer \n directement avec le protocole Firmata.
+  # jumeau_config(port, vitesse) \n -> Définit la configuration de la liaison \n série.\n
+ # Si le port n'est pas spécifié, il sera \n recherché automatiquement (carte \n Arduino Uno ou Mega). \n
+ # La vitesse par défaut est 115200 baud."""
+card_pin_url=[]
+system_card_description.update({"pin-card" : [card_pin_title, card_pin_text, card_pin_url]})
+
 # Firmata
 card_firmata_title="Protocole Firmata"
-card_firmata_text=""" Firmata est le protocole entre les jumeaux.\n
- carte=jumeau(brochage) \n -> Retourne la "carte" lors de l'activation.
- broche = carte.get_pin('type:broche:mode') \n -> Créer une entrée/sortie (broche) \n - type : a (analogique) ou d (numérique) \n - mode : i (entrée) , o (sortie) ou p (pwm). \n
- broche.read() \n -> Retourne la valeur de la broche.
+card_firmata_text=""" Firmata est le protocole de \n communication entre les deux jumeaux.\n
+ broche = carte.get_pin('type:numéro:mode') \n -> Créer une entrée/sortie (broche) \n - type : a (analogique) ou d (numérique) \n - mode : i (entrée) , o (sortie) ou p (pwm). \n
+ broche.read() \n -> Retourne la valeur de la broche.\n
  broche.write(valeur) \n -> Écrire la valeur sur la broche."""
 card_firmata_url=[["Protocole Firmata : pyFirmata","https://github.com/tino/pyFirmata"]]
 system_card_description.update({"firmata-card" : [card_firmata_title, card_firmata_text, card_firmata_url]})