doc ros v0.2.0

changelist :
- Odometry Interface
This commit is contained in:
acki
2025-04-07 17:37:50 -04:00
parent 242f914459
commit 2c7fa8fb3d
41 changed files with 665 additions and 37 deletions

View File

@@ -42,14 +42,25 @@
<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="PCB-Odo-Interface-Node.md"/>
<toc-element topic="Solenoid-Controller-Node.md"/>
<toc-element topic="Speed-Result-Node.md"/>
<toc-element topic="Tirette-Controller-Node.md"/>
</toc-element>
<toc-element topic="Topics.md">
<toc-element topic="Arm-Control-Topic.md"/>
<toc-element topic="Button-Topic.md"/>
<toc-element topic="Lidar-Topic.md"/>
<toc-element topic="Odometry-Data-Topic.md"/>
<toc-element topic="Odometry-Topic.md">
<toc-element topic="Odoemtry-GetPosition-Topic.md"/>
<toc-element topic="Odoemtry-SetPosition-Topic.md"/>
<toc-element topic="Odoemtry-Speed-Topic.md"/>
<toc-element topic="Odoemtry-ToF-Topic.md"/>
<toc-element topic="Odoemtry-WaypoointReach-Topic.md"/>
<toc-element topic="Odoemtry-AddWaypoint-Topic.md"/>
<toc-element topic="Odoemtry-GetPID-Topic.md"/>
<toc-element topic="Odoemtry-SetPID-Topic.md"/>
</toc-element>
<toc-element topic="Solenoid-Topic.md"/>
<toc-element topic="Serial-Listener-Topic.md">
<toc-element topic="Raw-Data-Topic.md"/>
@@ -70,6 +81,16 @@
<toc-element topic="Add-Serial-Listener-Service.md"/>
<toc-element topic="Add-Servo-Service.md"/>
<toc-element topic="Button-Service.md"/>
<toc-element topic="Odometry-Service.md">
<toc-element topic="Odometry-ToF-Service.md"/>
<toc-element topic="Odometry-Speed-Service.md"/>
<toc-element topic="Odometry-GetPosition-Service.md"/>
<toc-element topic="Odometry-Start-Service.md">
</toc-element>
<toc-element topic="Odometry-GetPID-Service.md"/>
<toc-element topic="Odometry-SetPID-Service.md"/>
<toc-element topic="Odometry-AddWaypoint-Service.md"/>
</toc-element>
<toc-element topic="Tirette-Service.md"/>
</toc-element>
<toc-element topic="Utils.md"/>
@@ -77,13 +98,34 @@
<toc-element topic="ROS2-UI.md"/>
<toc-element topic="ROS2-Interfaces.md">
<toc-element topic="Message.md">
<toc-element topic="Odometry-Topic-Interface.md">
<toc-element topic="PID-Topic-Interface.md">
<toc-element topic="OdometryPid-Topic-Interface.md"/>
</toc-element>
<toc-element topic="OdometryAddWaypoint-Topic-Interface.md"/>
<toc-element topic="OdometryPos-Topic-Interface.md"/>
<toc-element topic="OdometrySpeed-Topic-Interface.md"/>
<toc-element topic="OdometryStart-Topic-Interface.md"/>
<toc-element topic="OdometryToF-Topic-Interface.md"/>
<toc-element topic="OdometryWaypointReach-Topic-Interface.md"/>
</toc-element>
<toc-element topic="Button-Message-Interface.md"/>
<toc-element topic="OdometryData-Message-Interface.md"/>
<toc-element topic="PCA9685Servo-Message-Interface.md"/>
<toc-element topic="Solenoide-Message-Interface.md"/>
<toc-element topic="ServoMode-Message-Interface.md"/>
</toc-element>
<toc-element topic="Service.md">
<toc-element topic="Odometry-Service-Interface.md">
<toc-element topic="Odometry-PID-Service-Interface.md">
<toc-element topic="OdometryGetPid-Service-Interface.md"/>
<toc-element topic="OdometrySetPid-Service-Interface.md"/>
</toc-element>
<toc-element topic="OdometryAddWaypoint-Service-Interface.md"/>
<toc-element topic="OdometryPosition-Service-Interface.md"/>
<toc-element topic="OdometrySpeed-Service-Interface.md"/>
<toc-element topic="OdometryStart-Service-Interface.md"/>
<toc-element topic="OdometryToF-Service-Interface.md"/>
</toc-element>
<toc-element topic="AddButton-Service-Interface.md"/>
<toc-element topic="AddSolenoid-Service-Interface.md"/>
<toc-element topic="AddSerialListener-Service-Interface.md"/>

View File

@@ -48,4 +48,29 @@
<description>Created after removal of "Robot Position" from Documentation Robot Modelec 2024</description>
<accepts>Robot-Position.html</accepts>
</rule>
<rule id="41d692d7">
<description>Created after removal of "PID" from Documentation Robot Modelec 2024</description>
<accepts>PID.html</accepts>
</rule>
<rule id="2804f0d3">
<description>Created after removal of "Odometry" from Documentation Robot Modelec 2024</description>
<accepts>Odometry.html</accepts>
</rule>
<rule id="620cb063">
<description>Created after removal of "OdometryData" from Documentation Robot Modelec 2024</description>
<accepts>OdometryData-Message-Interface.html</accepts>
</rule>
<rule id="403fabd2">
<description>Created after removal of "Odometry-Topic-Interface" from Documentation Robot Modelec 2024
</description>
<accepts>Odometry-Topic-Interface.html</accepts>
</rule>
<rule id="17751c2d">
<description>Created after removal of "Odometry Data" from Documentation Robot Modelec 2024</description>
<accepts>Odometry-Data-Topic.html</accepts>
</rule>
<rule id="2628f634">
<description>Created after removal of "Odometry-Topic" from Documentation Robot Modelec 2024</description>
<accepts>Odometry-Topic.html</accepts>
</rule>
</rules>

View File

@@ -0,0 +1,12 @@
# AddWaypoint
## Nom du topic : **odometry/add_waypoint**
[Interface](OdometryAddWaypoint-Topic-Interface.md)
## Objectif
Ajouter un waypoint à la liste des waypoints de l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# GetPID
## Nom du topic : **odometry/get_pid**
[Interface](OdometryPid-Topic-Interface.md)
## Objectif
Récupérer les valeurs de PID de l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# GetPosition
## Nom du topic : **odometry/get_position**
[Interface](OdometryPos-Topic-Interface.md)
## Objectif
Envoie la position du robot à partir de l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# SetPID
## Nom du topic : **odometry/set_pid**
[Interface](OdometryPid-Topic-Interface.md)
## Objectif
Configurer le PID de l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# SetPosition
## Nom du topic : **odometry/set_position**
[Interface](OdometryPos-Topic-Interface.md)
## Objectif
Envoyé une position à l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# Speed
## Nom du topic : **odometry/speed**
[Interface](OdometrySpeed-Topic-Interface.md)
## Objectif
Récuperer la vitesse du robot à partir de l'odométrie.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# ToF
## Nom du topic : **odometry/tof**
[Interface](OdometryToF-Topic-Interface.md)
## Objectif
Récupérer la distance entre le robot et un obstacle à l'aide d'un capteur ToF.
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,11 @@
# WaypoointReach
## Nom du topic : **odometry/waypoint_reach**
[Interface](OdometryWaypointReach-Topic-Interface.md)
## Objectif
### Publisher
- [](PCB-Odo-Interface-Node.md)
### Subscriber

View File

@@ -0,0 +1,12 @@
# AddWaypoint
## Nom du service : **odometry/add_waypoint**
[Interface](OdometryAddWaypoint-Service-Interface.md)
## Objectif
Ajouter un waypoint à la liste des waypoints de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -1,13 +0,0 @@
# Odometry Data
### Nom du topic : **odometry_data**
[Interface](OdometryData-Message-Interface.md)
### Objectif
Transmettre la position du robot renvoyé par l'odométrie.
### Publisher
- [](Odometry-Logic-Processor-Node.md)
### Subscriber
-

View File

@@ -0,0 +1,12 @@
# GetPID
## Nom du service : **odometry/get_pid**
[Interface](OdometryGetPid-Service-Interface.md)
## Objectif
Récupérer les valeurs de PID de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,12 @@
# GetPosition
## Nom du service : **odometry/get_position**
[Interface](OdometryPosition-Service-Interface.md)
## Objectif
Récupérer la position du robot à partir de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,2 @@
# PID

View File

@@ -0,0 +1,3 @@
# Odometry
Start typing here...

View File

@@ -0,0 +1,3 @@
# Odometry
Start typing here...

View File

@@ -0,0 +1,12 @@
# SetPID
## Nom du service : **odometry/set_pid**
[Interface](OdometrySetPid-Service-Interface.md)
## Objectif
Configurer le PID de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,12 @@
# Speed
## Nom du service : **odometry/speed**
[Interface](OdometrySpeed-Service-Interface.md)
## Objectif
Récuperer la vitesse du robot à partir de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,12 @@
# Start
## Nom du service : **odometry/start**
[Interface](OdometryStart-Service-Interface.md)
## Objectif
Démarrer ou éteindre l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,12 @@
# ToF
## Nom du service : **odometry/tof**
[Interface](OdometryToF-Service-Interface.md)
## Objectif
Récupérer la distance entre le robot et un obstacle à l'aide d'un capteur ToF.
### Service
- [](PCB-Odo-Interface-Node.md)
### Client

View File

@@ -0,0 +1,3 @@
# Odometry
Start typing here...

View File

@@ -0,0 +1,3 @@
# Odometry
Start typing here...

View File

@@ -0,0 +1,35 @@
# OdometryAddWaypoint
`<modelec_interface/srv/odometry_add_waypoint.hpp>`
## Objectif
Ajouter un waypoint à la liste des waypoints de l'odométrie.
## Interface
```cpp
int8 id
bool is_end
int64 x
int64 y
int64 theta
---
bool success
```
## Params
| Type | Name | Description |
|-------|--------|-------------------|
| uint8 | id | id du waypoint |
| bool | is_end | waypoint de fin |
| int64 | x | coordonnée x |
| int64 | y | coordonnée y |
| int64 | theta | angle du waypoint |
## Retour
| Type | Name | Description |
|------|---------|------------------------|
| bool | success | requête réussie ou non |
## Utilisé par
-

View File

@@ -0,0 +1,28 @@
# OdometryAddWaypoint
`<modelec_interface/msg/odometry_add_waypoint.hpp>`
## Objectif
Ajouter un waypoint à la liste des waypoints de l'odométrie.
## Interface
```cpp
int8 id
bool is_end
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|-------|--------|-------------------|
| uint8 | id | id du waypoint |
| bool | is_end | waypoint de fin |
| int64 | x | coordonnée x |
| int64 | y | coordonnée y |
| int64 | theta | angle du waypoint |
## Utilisé par
-

View File

@@ -1,22 +0,0 @@
# OdometryData
`<modelec_interface/msg/odometry_data.hpp>`
## Objectif
Transmission des données d'odométrie depuis le controller vers la rasp
## Interface
```cpp
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|-------|-------|---------------|
| int64 | x | position en x |
| int64 | y | position en y |
| int64 | theta | angle selon z |
## Utilisé par
- [](Odometry-Logic-Processor-Node.md)

View File

@@ -0,0 +1,30 @@
# OdometryGetPid
`<modelec_interface/srv/odometry_get_pid.hpp>`
## Objectif
Récupérer les paramètres PID de l'odométrie.
## Interface
```cpp
---
float32 p
float32 i
float32 d
```
## Params
| Type | Name | Description |
|------|------|-------------|
| | | |
## Retour
| Type | Name | Description |
|---------|------|-----------------------|
| float32 | p | valeur du paramètre P |
| float32 | i | valeur du paramètre I |
| float32 | d | valeur du paramètre D |
## Utilisé par
-

View File

@@ -0,0 +1,23 @@
# OdometryPid
`<modelec_interface/msg/odometry_pid.hpp>`
## Objectif
Configurer le PID de l'odométrie.
## Interface
```cpp
float32 p
float32 i
float32 d
```
## Params
| Type | Name | Description |
|---------|------|--------------------|
| float32 | p | valeur paramètre P |
| float32 | i | valeur paramètre I |
| float32 | d | valeur paramètre D |
## Utilisé par
-

View File

@@ -0,0 +1,23 @@
# OdometryPos
`<modelec_interface/msg/odometry_pos.hpp>`
## Objectif
Récuperer la position du robot à partir de l'odométrie.
## Interface
```cpp
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|-------|-------|-----------------------------|
| int64 | x | position selon l'axe x (mm) |
| int64 | y | position selon l'axe x (mm) |
| int64 | theta | angle selon l'axe x (rad) |
## Utilisé par
-

View File

@@ -0,0 +1,31 @@
# OdometryPosition
`<modelec_interface/srv/odometry_position.hpp>`
## Objectif
Récuperer la position du robot à partir de l'odométrie.
## Interface
```cpp
---
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|------|------|-------------|
| | | |
## Retour
| Type | Name | Description |
|-------|-------|-----------------------------|
| int64 | x | position selon l'axe x (mm) |
| int64 | y | position selon l'axe x (mm) |
| int64 | theta | angle selon l'axe x (rad) |
## Utilisé par
-

View File

@@ -0,0 +1,31 @@
# OdometrySetPid
`<modelec_interface/srv/odometry_set_pid.hpp>`
## Objectif
Configurer le PID de l'odométrie.
## Interface
```cpp
float32 p
float32 i
float32 d
---
bool success
```
## Params
| Type | Name | Description |
|---------|------|-----------------------|
| float32 | p | valeur du paramètre P |
| float32 | i | valeur du paramètre I |
| float32 | d | valeur du paramètre D |
## Retour
| Type | Name | Description |
|------|---------|------------------------|
| bool | success | requête réussie ou non |
## Utilisé par
-

View File

@@ -0,0 +1,30 @@
# OdometrySpeed
`<modelec_interface/srv/odometry_speed.hpp>`
## Objectif
Récuperer la vitesse du robot à partir de l'odométrie.
## Interface
```cpp
---
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|------|------|-------------|
| | | |
## Retour
| Type | Name | Description |
|-------|-------|---------------------------------------------|
| int64 | x | vitesse selon l'axe x (mm^2) |
| int64 | y | vitesse selon l'axe x (mm^2) |
| int64 | theta | vitesse angulaire autour de l'axe z (rad^2) |
## Utilisé par
-

View File

@@ -0,0 +1,23 @@
# OdometrySpeed
`<modelec_interface/msg/odometry_speed.hpp>`
## Objectif
Récuperer la vitesse du robot à partir de l'odométrie.
## Interface
```cpp
int64 x
int64 y
int64 theta
```
## Params
| Type | Name | Description |
|-------|-------|---------------------------------------------|
| int64 | x | vitesse selon l'axe x (mm^2) |
| int64 | y | vitesse selon l'axe x (mm^2) |
| int64 | theta | vitesse angulaire autour de l'axe z (rad^2) |
## Utilisé par
-

View File

@@ -0,0 +1,27 @@
# OdometryStart
`<modelec_interface/srv/odometry_start.hpp>`
## Objectif
Lancer l'odométrie.
## Interface
```cpp
bool start
---
bool success
```
## Params
| Type | Name | Description |
|------|-------|-----------------------------|
| bool | start | démarrer l'odométrie ou non |
## Retour
| Type | Name | Description |
|------|---------|------------------------|
| bool | success | requête réussie ou non |
## Utilisé par
-

View File

@@ -0,0 +1,19 @@
# OdometryStart
`<modelec_interface/msg/odometry_start.hpp>`
## Objectif
Lancer l'odométrie.
## Interface
```cpp
bool start
```
## Params
| Type | Name | Description |
|------|-------|-----------------------------|
| bool | start | démarrer l'odométrie ou non |
## Utilisé par
-

View File

@@ -0,0 +1,27 @@
# OdometryToF
`<modelec_interface/srv/odometry_to_f.hpp>`
## Objectif
Recupérer la distance entre le robot et un obstacle à l'aide d'un capteur ToF.
## Interface
```cpp
uint8 n
---
int64 distance
```
## Params
| Type | Name | Description |
|-------|---------|-------------------|
| uint8 | n | numéro du capteur |
## Retour
| Type | Name | Description |
|--------|----------|-------------------------------------|
| int64 | distance | distance calculé par le capteur ToF |
## Utilisé par
-

View File

@@ -0,0 +1,21 @@
# OdometryToF
`<modelec_interface/msg/odometry_to_f.hpp>`
## Objectif
Récupérer la distance entre le robot et un obstacle à l'aide d'un capteur ToF.
## Interface
```cpp
int8 n
int64 distance
```
## Params
| Type | Name | Description |
|-------|----------|-------------------------------------|
| uint8 | n | numéro du capteur |
| int64 | distance | distance calculé par le capteur ToF |
## Utilisé par
-

View File

@@ -0,0 +1,19 @@
# OdometryWaypointReach
`<modelec_interface/msg/odometry_waypoint_reach.hpp>`
## Objectif
Indique que le robot a atteint un waypoint.
## Interface
```cpp
uint8 id
```
## Params
| Type | Name | Description |
|-------|------|----------------|
| uint8 | id | id du waypoint |
## Utilisé par
-

View File

@@ -0,0 +1,24 @@
# PCB Odo Interface
`<modelec/pcb_odo_interface.hpp>`
## Objectif
Interface de communication avec le PCB Odo.
### Topic
- [](Odoemtry-GetPosition-Topic.md) : recupère la position du robot à partir de l'odométrie et l'envoie.
- [](Odoemtry-SetPosition-Topic.md) : envoie la nouvelle position du robot à l'odométrie.
- [](Odoemtry-Speed-Topic.md) : recupère la vitesse du robot à partir de l'odométrie et l'envoie.
- [](Odoemtry-ToF-Topic.md) : recupère la distance du robot à l'obstacle le plus proche et l'envoie.
- [](Odoemtry-WaypoointReach-Topic.md) : envoie un message lorsque le robot a atteint un waypoint.
- [](Odoemtry-AddWaypoint-Topic.md) : ajoute un waypoint à la liste des waypoints à atteindre.
- [](Odoemtry-GetPID-Topic.md) : recupère les valeurs des PID de l'odométrie et les envoie.
- [](Odoemtry-SetPID-Topic.md) : envoie les nouvelles valeurs des PID de l'odométrie.
### Service
- [](Odometry-ToF-Service.md) : recupère la distance du robot à l'obstacle le plus proche.
- [](Odometry-Speed-Service.md) : recupère la vitesse du robot à partir de l'odométrie.
- [](Odometry-GetPosition-Service.md) : recupère la position du robot à partir de l'odométrie.
- [](Odometry-Start-Service.md) : demarre l'odométrie.
- [](Odometry-GetPID-Service.md) : recupère les valeurs des PID de l'odométrie.
- [](Odometry-SetPID-Service.md) : envoie les nouvelles valeurs des PID de l'odométrie.
- [](Odometry-AddWaypoint-Service.md) : ajoute un waypoint à la liste des waypoints à atteindre.

View File

@@ -0,0 +1,3 @@
# PID
Start typing here...

View File

@@ -0,0 +1,9 @@
# Speed Result
`<modelec/speed_result.hpp>`
## Objectif
Récupérer les valeurs de vitesse du robot à partir de l'odométrie.
### Topic
### Service