###############################################################################
# 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=["forward-card", "turn-card", "delineate-card", "detect-card", "radar-card", "twins-card"]
system_card=system_card+["speed-card", "paint-card", "battery-card", "beacon-card"]
card_description ={}

# Avancer et reculer
rp_forward_title="Avancer et reculer"
rp_forward_text=" rp_avancer() \n -> Avance d'un pas en avant. \n \n rp_reculer() \n -> Recule d'un pas."
rp_forward_url=[]
card_description.update({"forward-card" : [rp_forward_title, rp_forward_text, rp_forward_url]})

# Tourner
rp_turn_title="Tourner"
rp_turn_text=" rp_gauche() \n -> Tourne à gauche (90°).\n \n rp_droite() \n -> Tourne à droite (90°)."
rp_turn_url=[]
card_description.update({"turn-card" : [rp_turn_title, rp_turn_text, rp_turn_url]})

# Baliser
rp_delineate_title="Baliser"
rp_delineate_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."
rp_delineate_url=[]
card_description.update({"delineate-card" : [rp_delineate_title, rp_delineate_text, rp_delineate_url]})

# Détecter
rp_detect_title="Détecter"
rp_detect_text=" rp_detect() \n -> Détecte un obstacle.\n \n La fonction retourne : \n - \"True\" si il a un obstacle, \n - \"False\" si il n'y a pas d'obstacle."
rp_detect_url=[]
card_description.update({"detect-card" : [rp_detect_title, rp_detect_text, rp_detect_url]})

# Radar
rp_radar_title="Radar"
rp_radar_text=" Le radar n'est toujours pas \n opérationnel ! \n \n Mais où est donc encore passé Thomas !"
rp_radar_url=[]
card_description.update({"radar-card" : [rp_radar_title, rp_radar_text, rp_radar_url]})

# Jumeau numérique
rp_twins_title="Jumeau numérique"
rp_twins_text=""" Via une liaison série, Ropy peut être \n le jumeau numérique d'un robot réel. \n
 rp_jumeau(port, vitesse=115200) \n -> Active le jumeau réel par la liaison \n série. Si le port n'est pas spécifié, il \n est recherché automatiquement. \n
 rp_serie_msg(texte) \n -> Envoi un message \n \n texte=rp_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 """
rp_twins_url=[]
card_description.update({"twins-card" : [rp_twins_title, rp_twins_text, rp_twins_url]})

# Speed - Vitesse
rp_speed_title="Vitesse"
rp_speed_text=" L'amélioration \"Vitesse\" permet de \n changer la vitesse des déplacements \n par l'interface (en bas à gauche).\n\n"
rp_speed_text=rp_speed_text + " La vitesse est modifiable par codage : \n"
rp_speed_text=rp_speed_text + " rp_vitesse(nouvelle_vitesse), où \n la vitesse est une valeur de 0,1 à 10.\n\n La fonction rp_vitesse() retourne la \n vitesse actuelle."
rp_speed_url=[]
card_description.update({"speed-card" : [rp_speed_title, rp_speed_text, rp_speed_url]})

# Paint - Peinture
rp_paint_title="Peinture"
rp_paint_text=" rp_couleur(objets, couleur) \n -> Change la couleur du groupe \n d'objets 3d. \n"
rp_paint_text=rp_paint_text + " - La couleur est un tuple au format \n (R,V,B,Alpha) avec des valeurs de 0 à 1.\n"
rp_paint_text=rp_paint_text + " - objets peut être : \"Rover 1\",\n \"Rover 2\", \"Rover 3\", \"Station 1\", \n \"Station 2\", \"Station 3\", \"Station 4\", \n \"Balises\" ou \"Balise 1\" à \"Balise 200\".\n\n"
rp_paint_text=rp_paint_text + " rp_couleur_init(objets) \n -> Réinitialise la couleur des objets.\n rp_couleur_init() réinitialise tout !"
rp_paint_url=[]
card_description.update({"paint-card" : [rp_paint_title, rp_paint_text, rp_paint_url]})

# Battery + - Batterie +
rp_battery_title="Batterie +"
rp_battery_text=" L'amélioration \"Batterie +\" permet \n d'augmenter la capacité de la batterie \n du Rover à 200 pas (contre 20 pas). \n\n"
rp_battery_text=rp_battery_text + " La fonction rp_batterie() retourne \n la charge actuelle de la batterie \n (valeur de 0 à 100 %)."
rp_battery_url=[]
card_description.update({"battery-card" : [rp_battery_title, rp_battery_text, rp_battery_url]})

# Beacon + - Balise +
rp_beacon_title="Balise +"
rp_beacon_text=" L'amélioration \"Balise +\" permet \n d'augmenter le nombre de balises \n pouvant être posées à 200 (contre 20). \n\n"
rp_beacon_text=rp_beacon_text + " La fonction rp_balise() retourne \n le nombre de balises dejà posées \n lors du trajet."
rp_beacon_url=[]
card_description.update({"beacon-card" : [rp_beacon_title, rp_beacon_text, rp_beacon_url]})

##
# Envoi des données
##

def get_system_card():
    return system_card

def get_card_description():
    return card_description