doc ros v0.1.0

changelist :
- Node

Writerside/gu.tree

@@ -30,17 +30,17 @@
                     </toc-element>
                     <toc-element topic="ROS2-Modelec.md">
                         <toc-element topic="Nodes.md">
-                            <toc-element topic="Multiple-Serial-Listener-Node.md"/>
-                            <toc-element topic="PCA9685-Controller-Node.md"/>
-                            <toc-element topic="Odometry-Logic-Processor-Node.md"/>
+                            <toc-element topic="Arm-Controller-Node.md"/>
                             <toc-element topic="Button-GPIO-Controller-Node.md"/>
+                            <toc-element topic="Game-Controller-Listener-Node.md"/>
                             <toc-element topic="Lidar-Controller-Node.md"/>
                             <toc-element topic="Move-Controller-Node.md"/>
+                            <toc-element topic="Multiple-Serial-Listener-Node.md"/>
+                            <toc-element topic="Odometry-Logic-Processor-Node.md"/>
+                            <toc-element topic="PCA9685-Controller-Node.md"/>
                             <toc-element topic="PCB-Alim-Interface-Node.md"/>
                             <toc-element topic="Solenoid-Controller-Node.md"/>
                             <toc-element topic="Tirette-Controller-Node.md"/>
-                            <toc-element topic="Arm-Controller-Node.md"/>
-                            <toc-element topic="Game-Controller-Listener-Node.md"/>
                         </toc-element>
                         <toc-element topic="Topics.md">
                             <toc-element topic="Arm-Control-Topic.md"/>

Writerside/labels.list

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE labels SYSTEM "https://resources.jetbrains.com/writerside/1.0/labels-list.dtd">
+<labels xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/labels.xsd">
+    <primary-label id="Deprecated" short-name="D" name="Deprecated" color="red">
+        This feature is deprecated and will be removed in the future.
+    </primary-label>
+
+    <secondary-label id="wip" name="WIP" color="purple">Work in progress</secondary-label>
+    <secondary-label id="beta" name="β" color="tangerine">Beta</secondary-label>
+</labels>

Writerside/redirection-rules.xml

@@ -44,4 +44,8 @@
         <description>Created after removal of "Robot Position" from Documentation Robot Modelec 2024</description>
         <accepts>Robot-Position.html</accepts>
     </rule>
+    <rule id="35783336">
+        <description>Created after removal of "Robot Position" from Documentation Robot Modelec 2024</description>
+        <accepts>Robot-Position.html</accepts>
+    </rule>
 </rules>

Writerside/topics/Add-Serial-Listener-Service.md

@@ -10,7 +10,7 @@ Deux topics sont ensuite créés :
 - [](Send-To-Serial-Topic.md) : pour envoyer des données vers le port série.
 
 ### Service
-- [](Multiple-Serial-Listener-Node.md)
+- [](Multiple-Serial-Listener-Node.md) : créer un nouveau listener USB ou renvoie un listener existant (si le listener existe déjà).
 
 ### Client
 - [](PCB-Alim-Interface-Node.md)

Writerside/topics/Arm-Controller-Node.md

@@ -1 +1,7 @@
-# Arm Controller
+<primary-label ref="Deprecated"/>
+
+# Arm Controller
+`<modelec/arm_controller.hpp>`
+
+## Objectif
+Node de contrôle du bras de [](Serge.md).

Writerside/topics/Button-GPIO-Controller-Node.md

@@ -1 +1,12 @@
 # Button GPIO Controller
+`<modelec/button_gpio_controller.hpp>`
+
+## Objectif
+Contrôler un bouton sur un GPIO.
+
+### Topic
+- [](Button-Topic.md) : Pour chaque bouton, un topic est créé pour publier l'état du bouton.
+
+### Service
+- [](Add-Button-Service.md) : setup le contrôle d'un bouton sur un GPIO.
+- [](Button-Service.md) : vérifier l'état d'un bouton.

Writerside/topics/Button-Topic.md

@@ -11,4 +11,4 @@ Ce topic permet de recevoir continuellement l'état du bouton.
 - [](Button-GPIO-Controller-Node.md)
 
 ### Subscriber
-- []()
+-

Writerside/topics/Game-Controller-Listener-Node.md

@@ -1 +1,12 @@
 # Game Controller Listener
+`<modelec/gamecontroller_listener.hpp>`
+
+## Objectif
+Recevoir les données de la manette de jeu et contrôle le robot avec.
+
+### Topic
+- [](Joy-Topic.md) : reçoit les données de la manette de jeu.
+- [](Arm-Control-Topic.md) : envoie les données de contrôle du bras.
+
+### Service
+- [](Add-Serial-Listener-Service.md) : créer un nouveau listener USB pour l'odometrie.

Writerside/topics/Lidar-Controller-Node.md

@@ -1 +1,10 @@
 # Lidar Controller
+`<modelec/lidar_controller.hpp>`
+
+## Objectif
+Traite les infos recu par le lidar et les envoie au systeme de navigation.
+
+### Topic
+- [](Lidar-Topic.md)
+
+### Service

Writerside/topics/Move-Controller-Node.md

@@ -1 +1,10 @@
-# Move Controller
+<primary-label ref="Deprecated"/>
+
+# Move Controller
+`<modelec/move_controller.hpp>`
+
+## Objectif
+Node de test pour déplacer le robot sans le faire bouger pour tester les autres Nodes.
+
+> **Warning**: Ce node est deprecated et n'est plus utilisé dans le code actuel. Il est conservé pour référence historique.
+{style="warning"}

Writerside/topics/Multiple-Serial-Listener-Node.md

@@ -1,4 +1,16 @@
 # Multiple Serial Listener
+`<modelec/multiple_serial_listener.hpp>`
 
 ## Objectif
 Un listener pour plusieurs ports série.
+
+Le but de ce nœud est de permettre la communication avec plusieurs ports série en même temps. Il est configuré pour écouter les données sur plusieurs ports et les publier sur des topics ROS2 distincts. Cela permet de gérer plusieurs périphériques série simultanément sans avoir à créer un nœud séparé pour chaque port.
+
+### Topic
+Ce nœud écoute et publie sur les topics suivants (un pour chaque port série) :
+- [](Raw-Data-Topic.md) : recup les informations brutes envoyées par le port série et les transmet au travers du topic.
+- [](Send-To-Serial-Topic.md) : envoie les données brutes au port série.
+
+### Service
+Le noeud expose un service pour setup un port série :
+- [](AddSerialListener-Service-Interface.md)

Writerside/topics/Odometry-Data-Topic.md

@@ -10,4 +10,4 @@ Transmettre la position du robot renvoyé par l'odométrie.
 - [](Odometry-Logic-Processor-Node.md)
 
 ### Subscriber
-- []()
+-

Writerside/topics/Odometry-Logic-Processor-Node.md

@@ -1 +1,13 @@
 # Odometry Logic Processor
+`<modelec/odometry_logic_processor.hpp>`
+
+## Objectif
+Le but de ce noeud est de traiter les données d'odométrie envoyées par le noeud de listener USB et de les publier sur le topic `odometry` pour être utilisées par d'autres noeuds.
+
+### Topic
+**[](Odometry-Listener-Serial-Topic.md)**
+- [](Raw-Data-Topic.md) : reçoit les données brutes envoyées par le port série.
+- [](Send-To-Serial-Topic.md) : envoie les données brutes au port série.
+
+### Service
+- [](Add-Serial-Listener-Service.md) : créer un nouveau listener USB pour l'odométrie.

Writerside/topics/PCA9685-Controller-Node.md

@@ -1 +1,12 @@
 # PCA9685 Controller
+`<modelec/pca9685_controller.hpp>`
+
+## Objectif
+Contrôler le PCA9685 qui va lui-même contrôler des servo moteur grâce à des signaux PWM.
+
+### Topic
+- [](Servo-Control-Topic.md) : mettre à jour la position angulaire d'un servo moteur.
+- [](Clear-PCA9685.md) : reset tous les PWM du PCA9685.
+
+### Service
+- [](Add-Servo-Service.md) : setup le contrôle d'un servo moteur.

Writerside/topics/PCB-Alim-Interface-Node.md

@@ -1 +1,13 @@
 # PCB Alim Interface
+`<modelec/pcb_alim_interface.hpp>`
+
+## Objectif
+Interface entre le PCB alim et le systeme de navigation.
+
+### Topic
+**[](PCB-Alim-Serial-Topic.md)**
+- [](Raw-Data-Topic.md) : reçoit les données brutes envoyées par le port série.
+- [](Send-To-Serial-Topic.md) : envoie les données brutes au port série.
+
+### Service
+- [](Add-Serial-Listener-Service.md) : créer un nouveau listener USB pour le control du .

Writerside/topics/Servo-Topic.md

@@ -1,2 +1,5 @@
 # Servo
-Topic liée au contrôle des servos moteurs.
+Topic liée au contrôle des servos moteurs.
+
+- [](Servo-Control-Topic.md)
+- [](Clear-PCA9685.md)

Writerside/topics/ServoMode-Message-Interface.md

@@ -1,4 +1,6 @@
-# ServoMode
+<primary-label ref="Deprecated"/>
+
+# ServoMode
 `<modelec_interface/msg/servo_mode.hpp>`
 
 ## Objectif

Writerside/topics/Solenoid-Controller-Node.md

@@ -1 +1,11 @@
 # Solenoid Controller
+`<modelec/solenoid_controller.hpp>`
+
+## Objectif
+Contrôler l'état d'un solénoïde.
+
+### Topic
+- [](Solenoid-Topic.md) : Contrôle de chaque solénoïde via ce topic.
+
+### Service
+- [](Add-Solenoid-Service.md) : Setup le contrôle d'un solénoïde sur un GPIO.

Writerside/topics/Solenoid-Topic.md

@@ -7,7 +7,7 @@
 Contrôler l'état d'un solénoïde.
 
 ### Publisher
-- []()
+-
 
 ### Subscriber
 - [](Solenoid-Controller-Node.md)

Writerside/topics/Tirette-Controller-Node.md

@@ -1 +1,11 @@
 # Tirette Controller
+`<modelec/tirette_controller.hpp>`
+
+## Objectif
+Contrôler l'état de la tirette.
+
+### Topic
+- [](Tirette-Topic.md) : envoie en continu l'état de la tirette.
+
+### Service
+- [](Tirette-Service.md) : permet de vérifier l'état de la tirette à la demande.