Readme update

monte_charge/README.md

@@ -41,3 +41,40 @@ Les retours d'information (allumer = True ou False) du pupitre sont :
 #### Gestion du temps
 
 Les temporisations : **tempo(duree)** avec la durée en seconde
+
+#### Gestion du temps
+
+- Temporisation : **tempo(duree)** avec la durée en seconde.
+- Réinitialiser la valeur du temps : **reset_t()**.
+- Obtenir la valeur du temps en seconde depuis le démarrage du cycle : **get_t()**.
+- Définir la valeur (x) du temps en seconde : **set_t(x)**.
+
+## Accès aux données
+
+ - Retourne la valeur de la variable à \n l'instant : **get(variable)**.
+ -  Enregistre les données et génére un fichier de données CSV à l'arrêt du cycle : **daq([variables])**.
+ -  Affiche, à l'arrêt du cycle, le chronogramme des données enregristrées : **plot([variables])**.
+ 
+#### Variables publiques : 
+- Entrées/sorties : 'ba_0', 'ba_1', 'pc_0', 'pc_1', 'mot_m', 'mot_d', 'voy_0' et 'voy_1'.
+- Variables réels (si il y a jumelage) : 'ba_0_r', 'ba_1_r', 'pc_0_r' et 'pc_1_r'.
+- Autres variables : 't' (temps), 'mot_angle', 'mot_vitesse' et 'cabine_z'.
+
+## Jumelage
+
+- Démarrer le jumelage : **jumeau(brochage)**.
+- Arrêter le jumelage : **jumeau_stop()**.
+- Définit les modes  d'activation des entrées/sorties (True ou False) : **jumeau_mode(entrées réelles, entrées numériques, sorties réelles, sorties numériques)**.
+
+#### Brochage 
+
+Le brochage est un dictionnaire qui permet d'associer les objets 3D du jumeau numérique aux broches du jumeau réel. 
+
+Son format est le suivant : **brochage = { nom:[type, broche, mode] }** :
+ - nom : nom de l'objet 3D du jumeau numérique,
+ - type : a (analogique) ou d (binaire),
+ - broche : numéro de la broche de carte (Arduino, ...),
+ - mode : i (entrée), o (sortie) ou p (pwm).
+
+#### Objets 3D du jumeau numérique : 
+- Entrées/sorties : 'ba_0', 'ba_1', 'pc_0', 'pc_1', 'mot_m',  'mot_d', 'voy_0' et 'voy_1'.

portail_coulissant/README.md

@@ -51,9 +51,9 @@ Les consignes (valeur retournée = True ou False) du pupitre sont :
  -  Affiche, à l'arrêt du cycle, le chronogramme des données enregristrées : **plot([variables])**.
  
 #### Variables publiques : 
-- Entrées/sorties : 'bp_ext', 'bp_int', 'fdc_o', 'fdc_f', 'mot_o', 'mot_f', 'gyr', 'ir_emet', 'ir_recep'.
+- Entrées/sorties : 'bp_ext', 'bp_int', 'fdc_o', 'fdc_f', 'mot_o', 'mot_f', 'gyr', 'ir_emet' et 'ir_recep'.
-- Variables réels (si il y a jumelage) : 'bp_ext_r', 'bp_int_r', 'fdc_o_r', 'fdc_f_r', 'ir_recep_r'.
+- Variables réels (si il y a jumelage) : 'bp_ext_r', 'bp_int_r', 'fdc_o_r', 'fdc_f_r' et 'ir_recep_r'.
-- Autres variables : 't' (temps), 'mot_angle', 'mot_vitesse', 'portail_x', 'portail_vitesse'.
+- Autres variables : 't' (temps), 'mot_angle', 'mot_vitesse', 'portail_x' et 'portail_vitesse'.
 
 ## Jumelage
 
@@ -72,4 +72,4 @@ Son format est le suivant : **brochage = { nom:[type, broche, mode] }** :
  - mode : i (entrée), o (sortie) ou p (pwm).
 
 #### Objets 3D du jumeau numérique : 
-- Entrées/sorties : 'bp_ext', 'bp_int', 'fdc_o', 'fdc_f', 'mot_o', 'mot_f', 'gyr', 'ir_emet', 'ir_recep'.
+- Entrées/sorties : 'bp_ext', 'bp_int', 'fdc_o', 'fdc_f', 'mot_o', 'mot_f', 'gyr', 'ir_emet' et 'ir_recep'.

volet_roulant/README.md

@@ -43,3 +43,34 @@ Le retour d'information (allumer = True ou False) du pupitre est :
 #### Gestion du temps
 
 Les temporisations : **tempo(duree)** avec la durée en seconde
+
+## Accès aux données
+
+ - Retourne la valeur de la variable à \n l'instant : **get(variable)**.
+ -  Enregistre les données et génére un fichier de données CSV à l'arrêt du cycle : **daq([variables])**.
+ -  Affiche, à l'arrêt du cycle, le chronogramme des données enregristrées : **plot([variables])**.
+ 
+#### Variables publiques : 
+- Entrées/sorties : 'bp_m', 'bp_a', 'bp_d', 'mot_m', 'mot_d', 'fdc_h', 'fdc_b', 'bp_auto', 'voy_auto' et 'lum'.
+- Variables réels (si il y a jumelage) : 'bp_m_r', 'bp_a_r', 'bp_d_r', 'fdc_h_r', 'fdc_b_r', 'bp_auto_r' et  'lum_r'.
+- Autres : 't' (temps), 'mot_angle' et 'mot_vitesse'.
+
+## Jumelage
+
+- Démarrer le jumelage : **jumeau(brochage)**.
+- Arrêter le jumelage : **jumeau_stop()**.
+- Définit les modes  d'activation des entrées/sorties (True ou False) : **jumeau_mode(entrées réelles, entrées numériques, sorties réelles, sorties numériques)**.
+
+#### Brochage 
+
+Le brochage est un dictionnaire qui permet d'associer les objets 3D du jumeau numérique aux broches du jumeau réel. 
+
+Son format est le suivant : **brochage = { nom:[type, broche, mode] }** :
+ - nom : nom de l'objet 3D du jumeau numérique,
+ - type : a (analogique) ou d (binaire),
+ - broche : numéro de la broche de carte (Arduino, ...),
+ - mode : i (entrée), o (sortie) ou p (pwm).
+
+#### Objets 3D du jumeau numérique : 
+- Entrées/sorties : 'bp_m', 'bp_a', 'bp_d', 'mot_m', 'mot_d', 'fdc_h', 'fdc_b', 'bp_auto', 'voy_auto' et 'lum'.
+