From 068e1dfc4c761bc3949207ef5ce340eb62ddd0d0 Mon Sep 17 00:00:00 2001 From: acki Date: Tue, 8 Apr 2025 19:41:26 -0400 Subject: [PATCH] doc ros v0.2.1 changelist : - Interface PCB Alim --- Writerside/gu.tree | 14 ++++++ Writerside/topics/Alim-Service-Interface.md | Bin 0 -> 58 bytes Writerside/topics/Alim-Service.md | 3 ++ .../topics/AlimBau-Service-Interface.md | 26 +++++++++++ Writerside/topics/AlimBau-Service.md | 13 ++++++ .../topics/AlimEmg-Service-Interface.md | 26 +++++++++++ Writerside/topics/AlimEmg-Service.md | 13 ++++++ Writerside/topics/AlimIn-Service-Interface.md | 35 +++++++++++++++ Writerside/topics/AlimIn-Service.md | 13 ++++++ .../topics/AlimOut-Service-Interface.md | 41 ++++++++++++++++++ Writerside/topics/AlimOut-Service.md | 13 ++++++ .../topics/AlimTemp-Service-Interface.md | 27 ++++++++++++ Writerside/topics/AlimTemp-Service.md | 13 ++++++ Writerside/topics/Odometry-Speed-Service.md | 2 +- 14 files changed, 238 insertions(+), 1 deletion(-) create mode 100644 Writerside/topics/Alim-Service-Interface.md create mode 100644 Writerside/topics/Alim-Service.md create mode 100644 Writerside/topics/AlimBau-Service-Interface.md create mode 100644 Writerside/topics/AlimBau-Service.md create mode 100644 Writerside/topics/AlimEmg-Service-Interface.md create mode 100644 Writerside/topics/AlimEmg-Service.md create mode 100644 Writerside/topics/AlimIn-Service-Interface.md create mode 100644 Writerside/topics/AlimIn-Service.md create mode 100644 Writerside/topics/AlimOut-Service-Interface.md create mode 100644 Writerside/topics/AlimOut-Service.md create mode 100644 Writerside/topics/AlimTemp-Service-Interface.md create mode 100644 Writerside/topics/AlimTemp-Service.md diff --git a/Writerside/gu.tree b/Writerside/gu.tree index 2629e0a..007ff2b 100644 --- a/Writerside/gu.tree +++ b/Writerside/gu.tree @@ -80,6 +80,13 @@ + + + + + + + @@ -126,6 +133,13 @@ + + + + + + + diff --git a/Writerside/topics/Alim-Service-Interface.md b/Writerside/topics/Alim-Service-Interface.md new file mode 100644 index 0000000000000000000000000000000000000000..7f60f890490a8f5b1549cabd05083a2fcfb22f00 GIT binary patch literal 58 zcmezOpFx>Hfx(d>har<8mw^iigBeN~5*dnsqyi9EG86!1@)**AybOj^pm-{S9tZ*e DWWNgU literal 0 HcmV?d00001 diff --git a/Writerside/topics/Alim-Service.md b/Writerside/topics/Alim-Service.md new file mode 100644 index 0000000..0714edc --- /dev/null +++ b/Writerside/topics/Alim-Service.md @@ -0,0 +1,3 @@ +# Alim + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/AlimBau-Service-Interface.md b/Writerside/topics/AlimBau-Service-Interface.md new file mode 100644 index 0000000..56c17e2 --- /dev/null +++ b/Writerside/topics/AlimBau-Service-Interface.md @@ -0,0 +1,26 @@ +# AlimBau +`` + +## 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 diff --git a/Writerside/topics/AlimBau-Service.md b/Writerside/topics/AlimBau-Service.md new file mode 100644 index 0000000..2bee53c --- /dev/null +++ b/Writerside/topics/AlimBau-Service.md @@ -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 +- diff --git a/Writerside/topics/AlimEmg-Service-Interface.md b/Writerside/topics/AlimEmg-Service-Interface.md new file mode 100644 index 0000000..1de90e7 --- /dev/null +++ b/Writerside/topics/AlimEmg-Service-Interface.md @@ -0,0 +1,26 @@ +# AlimEmg +`` + +## 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 diff --git a/Writerside/topics/AlimEmg-Service.md b/Writerside/topics/AlimEmg-Service.md new file mode 100644 index 0000000..687be7f --- /dev/null +++ b/Writerside/topics/AlimEmg-Service.md @@ -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 +- diff --git a/Writerside/topics/AlimIn-Service-Interface.md b/Writerside/topics/AlimIn-Service-Interface.md new file mode 100644 index 0000000..9945cd2 --- /dev/null +++ b/Writerside/topics/AlimIn-Service-Interface.md @@ -0,0 +1,35 @@ +# AlimIn +`` + +## 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 diff --git a/Writerside/topics/AlimIn-Service.md b/Writerside/topics/AlimIn-Service.md new file mode 100644 index 0000000..afa0974 --- /dev/null +++ b/Writerside/topics/AlimIn-Service.md @@ -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 +- diff --git a/Writerside/topics/AlimOut-Service-Interface.md b/Writerside/topics/AlimOut-Service-Interface.md new file mode 100644 index 0000000..f872b43 --- /dev/null +++ b/Writerside/topics/AlimOut-Service-Interface.md @@ -0,0 +1,41 @@ +# AlimOut +`` + +## 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 diff --git a/Writerside/topics/AlimOut-Service.md b/Writerside/topics/AlimOut-Service.md new file mode 100644 index 0000000..02e3521 --- /dev/null +++ b/Writerside/topics/AlimOut-Service.md @@ -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 +- diff --git a/Writerside/topics/AlimTemp-Service-Interface.md b/Writerside/topics/AlimTemp-Service-Interface.md new file mode 100644 index 0000000..6a58277 --- /dev/null +++ b/Writerside/topics/AlimTemp-Service-Interface.md @@ -0,0 +1,27 @@ +# AlimTemp +`` + +## 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 diff --git a/Writerside/topics/AlimTemp-Service.md b/Writerside/topics/AlimTemp-Service.md new file mode 100644 index 0000000..4b8d1e6 --- /dev/null +++ b/Writerside/topics/AlimTemp-Service.md @@ -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 +- diff --git a/Writerside/topics/Odometry-Speed-Service.md b/Writerside/topics/Odometry-Speed-Service.md index e454552..e9cad53 100644 --- a/Writerside/topics/Odometry-Speed-Service.md +++ b/Writerside/topics/Odometry-Speed-Service.md @@ -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)