###############################################################################
# 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-2022 Philippe Roy
# @license: GNU GPL
###############################################################################

################################################################################
# Documentation du système
################################################################################

system_card=["model-card", "twins-card", "movement-card", "sensor-card", "gyro-card", "board-card"]
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 
 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."""
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
 serie_msg(texte) \n -> Envoi un message \n \n texte=serie_rcpt() \n -> Reçoit un message"""

# Message envoyé (asynchrone) : \n avancer : a, reculer : r, droite : d, \n gauche g, marquer : m et forer : f \n\n\n """
card_twins_url=[]
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_movementurn_text=" rp_gauche() \n -> Tourne à gauche (90°).\n \n rp_droite() \n -> Tourne à droite (90°)."
card_movement_url=[]
card_description.update({"movement-card" : [card_movement_title, card_movement_text, card_movement_url]})

# Capteurs
card_sensor_title="Capteurs"
card_sensor_text=" FIXME"
# 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
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=" 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=" 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
##

def get_system_card():
    return system_card

def get_card_description():
    return card_description