doc ros v0.2.1

changelist :
- Interface PCB Alim
This commit is contained in:
acki
2025-04-08 19:41:26 -04:00
parent 9ed0c5d0ae
commit 068e1dfc4c
14 changed files with 238 additions and 1 deletions

View File

@@ -80,6 +80,13 @@
<toc-element topic="Add-Solenoid-Service.md"/>
<toc-element topic="Add-Serial-Listener-Service.md"/>
<toc-element topic="Add-Servo-Service.md"/>
<toc-element topic="Alim-Service.md">
<toc-element topic="AlimOut-Service.md"/>
<toc-element topic="AlimIn-Service.md"/>
<toc-element topic="AlimBau-Service.md"/>
<toc-element topic="AlimEmg-Service.md"/>
<toc-element topic="AlimTemp-Service.md"/>
</toc-element>
<toc-element topic="Button-Service.md"/>
<toc-element topic="Odometry-Service.md">
<toc-element topic="Odometry-ToF-Service.md"/>
@@ -126,6 +133,13 @@
<toc-element topic="OdometryStart-Service-Interface.md"/>
<toc-element topic="OdometryToF-Service-Interface.md"/>
</toc-element>
<toc-element topic="Alim-Service-Interface.md">
<toc-element topic="AlimBau-Service-Interface.md"/>
<toc-element topic="AlimEmg-Service-Interface.md"/>
<toc-element topic="AlimIn-Service-Interface.md"/>
<toc-element topic="AlimOut-Service-Interface.md"/>
<toc-element topic="AlimTemp-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"/>

Binary file not shown.

View File

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

View File

@@ -0,0 +1,26 @@
# AlimBau
`<modelec_interface/srv/alim_bau.hpp>`
## Objectif
Vérifier l'état du bouton d'arrêt d'urgence.
## Interface
```cpp
---
bool success
bool activate
```
## Params
| Type | Name | Description |
|--------|------|---------------|
## Retour
| Type | Name | Description |
|------|----------|----------------------------------|
| bool | success | requête réussie ou non |
| bool | activate | état du bouton d'arrêt d'urgence |
## Utilisé par

View File

@@ -0,0 +1,13 @@
# AlimBau
## Nom du service : **alim/emg**
[Interface](AlimBau-Service-Interface.md)
## Objectif
Récupérer l'état du bouton d'arrêt d'urgence de la carte d'alimentation.
### Service
- [](PCB-Alim-Interface-Node.md)
### Client
-

View File

@@ -0,0 +1,26 @@
# AlimEmg
`<modelec_interface/srv/alim_emg.hpp>`
## Objectif
Contrôler l'arrêt d'urgence software.
## Interface
```cpp
bool activate
---
bool success
```
## Params
| Type | Name | Description |
|------|----------|------------------------------------------|
| bool | activate | activé ou non l'arrêt d'urgence software |
## Retour
| Type | Name | Description |
|------|---------|------------------------|
| bool | success | requête réussie ou non |
## Utilisé par

View File

@@ -0,0 +1,13 @@
# AlimEmg
## Nom du service : **alim/emg**
[Interface](AlimEmg-Service-Interface.md)
## Objectif
Contrôler l'arrêt d'urgence software.
### Service
- [](PCB-Alim-Interface-Node.md)
### Client
-

View File

@@ -0,0 +1,35 @@
# AlimIn
`<modelec_interface/srv/alim_in.hpp>`
## Objectif
Vérifier l'état de l'alimentation.
## Interface
```cpp
string VOLT="VOLT"
string AMPS="AMPS"
string STATE="STATE"
string VALID="VALID"
int16 input
string type "STATE"
---
bool success
int64 result
```
## Params
| Type | Name | Description |
|--------|-------|-----------------------------------------------|
| int16 | input | input 1 ou 2 |
| string | type | type de la requête (VOLT, AMPS, STATE, VALID) |
## Retour
| Type | Name | Description |
|-------|---------|------------------------|
| bool | success | requête réussie ou non |
| int64 | result | résultat de la requête |
## Utilisé par

View File

@@ -0,0 +1,13 @@
# AlimIn
## Nom du service : **alim/in**
[Interface](AlimIn-Service-Interface.md)
## Objectif
Récupérer les valeurs d'alimentation du robot.
### Service
- [](PCB-Alim-Interface-Node.md)
### Client
-

View File

@@ -0,0 +1,41 @@
# AlimOut
`<modelec_interface/srv/alim_out.hpp>`
## Objectif
Vérifier l'état des sorties d'alimentation.
## Interface
```cpp
string OUT_5V="OUT5V"
string OUT_5V1="OUT5V1"
string OUT_12V="OUT12V"
string OUT_24V="OUT24V"
string STATE="STATE"
string VOLT="VOLT"
string AMPS="AMPS"
string out
string type "STATE"
int8 enable -1
---
bool success
int64 result
```
## Params
| Type | Name | Description |
|--------|--------|--------------------------------------------------------|
| string | out | nom de la sortie d'alimentation |
| string | type | type de la requête |
| int8 | enable | 1 pour activer, 0 pour désactiver, -1 pour lire l'état |
## Retour
| Type | Name | Description |
|-------|---------|------------------------|
| bool | success | requête réussie ou non |
| int64 | result | résultat de la requête |
## Utilisé par

View File

@@ -0,0 +1,13 @@
# AlimOut
## Nom du service : **alim/out**
[Interface](AlimOut-Service-Interface.md)
## Objectif
Vérifier l'état des sorties d'alimentation.
### Service
- [](PCB-Alim-Interface-Node.md)
### Client
-

View File

@@ -0,0 +1,27 @@
# AlimTemp
`<modelec_interface/srv/alim_temp.hpp>`
## Objectif
Vérifier l'état de la température de l'alimentation.
## Interface
```cpp
---
bool success
int64 value
```
## Params
| Type | Name | Description |
|------|------|-------------|
| | | |
## Retour
| Type | Name | Description |
|-------|---------|---------------------------------------|
| bool | success | requête réussie ou non |
| int64 | value | valeur de la température (en celcius) |
## Utilisé par

View File

@@ -0,0 +1,13 @@
# AlimTemp
## Nom du service : **alim/temp**
[Interface](AlimTemp-Service-Interface.md)
## Objectif
Vérifier la température de l'alimentation.
### Service
- [](PCB-Alim-Interface-Node.md)
### Client
-

View File

@@ -4,7 +4,7 @@
[Interface](OdometrySpeed-Service-Interface.md)
## Objectif
Récuperer la vitesse du robot à partir de l'odométrie.
Récupérer la vitesse du robot à partir de l'odométrie.
### Service
- [](PCB-Odo-Interface-Node.md)