Ajout de la documentation sur le brochage

This commit is contained in:
Philippe Roy 2023-01-14 21:38:18 +01:00
parent 593b319d98
commit 2c5aa5d362
7 changed files with 36 additions and 18 deletions

View File

@ -12,15 +12,14 @@
# 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", "board-card", "model-card", "arduino-card"]
system_card=["twins-card", "pin-card", "firmata-card", "movement-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
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
@ -28,10 +27,23 @@ Le brochage est un dictionnaire, par \n exemple : brochage={ "bouton": ['d',2,'i
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 'ba_0', 'ba_1', 'pc_0', 'pc_1', 'mot_m', 'mot_d', \n 'voy_0' et 'voy_1'."""
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=""" La communication entre les jumeaux \n est basée sur le protocole Firmata.\n
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
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"]]

Binary file not shown.

View File

@ -23,8 +23,6 @@ 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
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
# La vitesse par défaut est 115200 baud."""
@ -41,10 +39,6 @@ card_pin_text=""" Le brochage est un dictionnaire qui permet \n d'associer les o
- 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]})

View File

@ -1,7 +1,7 @@
<data>
<screen>
<width>1609</width>
<height>905</height>
<width>1140</width>
<height>641</height>
<quality>1</quality>
</screen>
</data>

Binary file not shown.

View File

@ -12,15 +12,14 @@
# Documentation du système
################################################################################
# system_card=["twins-card", "serial-card", "movement-card", "sensor-card", "board-card", "model-card", "arduino-card"]
system_card=["twins-card", "firmata-card", "movement-card", "sensor-card", "board-card", "model-card", "arduino-card"]
system_card=["twins-card", "pin-card", "firmata-card", "movement-card", "sensor-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
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
@ -28,10 +27,23 @@ Le brochage est un dictionnaire, par \n exemple : brochage={ "bouton": ['d',2,'i
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_m', 'bp_a', 'bp_d', 'fdc_h', 'fdc_b', 'mot_m', \n 'mot_d', 'bp_auto', 'voy_auto' et 'lum'."""
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=""" La communication entre les jumeaux \n est basée sur le protocole Firmata.\n
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
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"]]