mirror of
https://forge.apps.education.fr/blender-edutech/jumeaux-numeriques.git
synced 2024-01-27 06:56:18 +01:00
139 lines
7.6 KiB
Python
139 lines
7.6 KiB
Python
###############################################################################
|
|
# porcou_doc.py
|
|
# @title: Documentation du portail coulissant
|
|
# @project: Blender-EduTech
|
|
# @lang: fr
|
|
# @authors: Philippe Roy <philippe.roy@ac-grenoble.fr>
|
|
# @copyright: Copyright (C) 2020-2023 Philippe Roy
|
|
# @license: GNU GPL
|
|
###############################################################################
|
|
|
|
# Texte en X : 426.474 m
|
|
|
|
################################################################################
|
|
# Documentation du système
|
|
################################################################################
|
|
|
|
system_card=["twins-card", "pin-card", "data-card", "daq-card", "movement-card", "sensor-card", "gyro-card", "board-card", "model-card", "firmata-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
|
|
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_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 = { 'gyr':['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'."""
|
|
card_pin_url=[]
|
|
system_card_description.update({"pin-card" : [card_pin_title, card_pin_text, card_pin_url]})
|
|
|
|
# Données
|
|
card_data_title="Accès aux données"
|
|
card_data_text=""" get(variable) \n -> Retourne la valeur de la variable à \n l'instant t. Par exemple : val = get('bp_ext').\n
|
|
Entrées/sorties : 'bp_ext', 'bp_int', 'fdc_o', \n 'fdc_f', 'mot_o', 'mot_f', 'gyr', 'ir_emet', \n 'ir_recep'.\n
|
|
Variables réels (si il y a jumelage) : 'bp_ext_r', \n 'bp_int_r', 'fdc_o_r', 'fdc_f_r', 'ir_recep_r'.\n
|
|
Autres variables : 't' (temps), 'mot_angle', \n 'mot_vitesse', 'portail_x', 'portail_vitesse'."""
|
|
card_data_url=[]
|
|
system_card_description.update({"data-card" : [card_data_title, card_data_text, card_data_url]})
|
|
|
|
# Monitoring
|
|
card_daq_title="Acquisition de données"
|
|
# card_daq_text="aaa"+"\u2192"+"ddd"
|
|
card_daq_text=""" daq([variables]) \n -> Déclenche l'acquisition de données afin \n de générer un fichier de données CSV à \n l'arrêt du cycle.
|
|
Par exemple : daq(['bp_ext', 'portail_x']).\n
|
|
plot([variables]) \n -> Affiche le chronogramme à l'arrêt du
|
|
cycle. Le chronogramme interactif est en \n cours d'implémentation.\n
|
|
Les variables pouvant être suivies sont les \n mêmes que celles de la page "Données"."""
|
|
# Blender étant cadencé à 60 fps, la fréquence \n d'acquisition est 16 ms."""
|
|
card_daq_url=[["Wikipedia Français : fichier CSV","https://fr.wikipedia.org/wiki/Comma-separated_values"],
|
|
["Bibliothèque Matplotlib","https://matplotlib.org/"]]
|
|
system_card_description.update({"daq-card" : [card_daq_title, card_daq_text, card_daq_url]})
|
|
|
|
# Ouvrir et fermer
|
|
card_movement_title="Ouvrir et fermer"
|
|
card_movement_text=""" mot_o(True | False) \n -> Ouvrir le portail (moteur sens trigo).
|
|
mot_f(True | False) \n -> Fermer le portail (moteur sens horaire).\n
|
|
fdc_o() \n -> Capteur fin de course portail ouvert.
|
|
fdc_f() \n -> Capteur fin de course portail fermé.\n
|
|
mot_digitset(vitesse) -> Change la vitesse \n du moteur numérique en rad/s. Si 'vitesse' \n est ommis, elle sera réinitialisée."""
|
|
# 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é.\n
|
|
|
|
card_movement_url=[]
|
|
system_card_description.update({"movement-card" : [card_movement_title, card_movement_text, card_movement_url]})
|
|
|
|
# Capteurs
|
|
card_sensor_title="Capteur"
|
|
card_sensor_text=""" ir_emet(True | False) \n -> Activer l'émetteur infrarouge (IR).\n
|
|
ir_recep() \n -> Récepteur barrage infrarouge (IR).\n Retourne True s'il n'y a pas d'obstacle."""
|
|
card_sensor_url=[]
|
|
system_card_description.update({"sensor-card" : [card_sensor_title, card_sensor_text, card_sensor_url]})
|
|
|
|
# Gyrophare
|
|
card_gyro_title="Gyrophare"
|
|
card_gyro_text=""" gyr(True | False) \n -> Activer le gyrophare."""
|
|
card_gyro_url=[]
|
|
system_card_description.update({"gyro-card" : [card_gyro_title, card_gyro_text, card_gyro_url]})
|
|
|
|
# Pupitre
|
|
card_board_title="Pupitre"
|
|
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_url=[]
|
|
system_card_description.update({"board-card" : [card_board_title, card_board_text, card_board_url]})
|
|
|
|
# Maquette
|
|
card_model_title="Maquette"
|
|
card_model_text=""" Le modèle 3D est basé sur la maquette \n développée par l'entreprise A4 \n Technologie. \n
|
|
Les documents techniques et \n pédagogiques signés A4 Technologie \n sont diffusés librement sous licence \n Creative Commons BY-NC-SA. \n
|
|
Le pilotage de la maquette se fait par une \n carte Arduino (Uno ou Mega) reliée à \n l'ordinateur via la liaison série (USB) et le \n protocole Firmata."""
|
|
card_model_url=[["A4 Technologie","https://www.a4.fr"],
|
|
["Maquette A4 Technologie","https://www.a4.fr/wiki/index.php?title=Portail_coulissant_(BE-APORT-COUL)"]]
|
|
system_card_description.update({"model-card" : [card_model_title, card_model_text, card_model_url]})
|
|
|
|
# Firmata
|
|
card_firmata_title="Protocole Firmata"
|
|
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]})
|
|
|
|
# Arduino
|
|
card_arduino_title="Arduino"
|
|
card_arduino_text=""" Arduino une plateforme open-source de \n développement électronique basée sur le \n microcontrôleur de la famille ATmega.
|
|
|
|
Elle est utilisée pour la création d'objets \n électroniques interactifs et connectés : \n IoT, domotique, robotique, ...
|
|
|
|
Le langage de programmation est le C. Par \n la bibliothèque Arduino l'accès aux entrées \n et sorties de la carte est particulièrement
|
|
aisé. Les platines permettent l'ajout \n d'extensions : relais, Grove, RFID, GPS, ... """
|
|
|
|
card_arduino_url=[["Plateforme Arduino","https://www.arduino.cc/"]]
|
|
system_card_description.update({"arduino-card" : [card_arduino_title, card_arduino_text, card_arduino_url]})
|
|
|
|
##
|
|
# Envoi des données
|
|
##
|
|
|
|
def get_system_card():
|
|
return system_card
|
|
|
|
def get_system_card_description():
|
|
return system_card_description
|