ROS2 Services
In deze workshop leer je de basis van ROS2 services. De theorie hiervan wordt gedoceerd, maar kun je ook vinden op deze website van ROS
In deze workshop ga je de gemeten hoogte van de doos uit de topics workshop omrekenen van meters naar inches. We gebruiken hiervoor het ROS services mechanisme. Deze service is al voorbereid. Je kunt de service starten met het volgende commando:
ros2 run range_sensor metres_to_inches_server
Om een lijst te verkrijgen van services die actief zijn gebruik je het commando
ros2 service list
Je krijgt nu een list met alle services die actief zijn. Voor deze opdrachten is alleen de service /metres_to_inches van belang. Er zijn nog een aan services aanwezig die beginnen met /metres_to_inches en gevolgd door worden door service/…., deze zijn voor ROS2 intern gebruik.
Elke service wordt gedefineerd door een type. Dit type kun je als volgt opvragen:
ros2 service type /metres_to_inches
Ook van de service kun je het protoptype opvragen:
ros2 interface proto <service_type>
Dit prototype, dat de request/response-structuur van de service beschrijft, is gedefinieerd in een servicebeschrijving welke je kunt vinden in het volgende bestand: ~/ros2_industrial_ws/src/ROS2_industrial/1_basics/range_sensors_interfaces/srv/ConvertMetresToInches.srv
gedit ~/ros2_industrial_ws/src/ROS2_industrial/1_basics/range_sensors_interfaces/srv/ConvertMetresToInches.srv
In deze service beschrijving vind je een opdeling in twee delen gescheiden door “—”_:
1e deel: De service-aanvraag (request) vereist slechts één parameter:
float64 distance_metres
2e deel: Parameters die de service na behandeling terug geeft, response genoemd:
float64 distance_inches
bool success (deze wordt gebruikt om aan te geven dat er tijdens de service-afhandeling geen fouten zijn opgetreden; deze is altijd aanwezig in de response, maar het gebruik en de waarde worden bepaald door de implementatie)
Je kunt de service met een shell-commando testen, zie voorbeeld hieronder
ros2 service call /metres_to_inches range_sensors_interfaces/srv/ConvertMetresToInches "{distance_metres : 1.0}"
Opdracht 1: Service client programmeren
In deze opdracht ga je een service-aanvraag naar de ConvertMetresToInches-service programmeren.
Je gaat daartoe het Python programma assignment2.py bewerken op bepaalde aangeven plaatsen. Zoek in het bestand naar commentaarregels met “Todo x” en voeg de gevraagde code direct onder elke commentaarregel toe.
In dit programma gebeurt er het volgende:
Er wordt een subscriber aangemaakt op het topic /box_height_info
Als er een bericht op het topic wordt ontvangen dan wordt de self.box_height_callback geactiveerd
In de callback wordt een service-aanvraag gemaakt naar de ConvertMetresToInches-service door de send_request(self, metres) member-fuctie aan te roepen
In de response van de service-aanvraag is de hoogte in inches verwerkt. Deze wordt vervolgens afgedrukt in een terminal
Opdracht 2: Entry point toevoegen
Om een python programma met het ros2 run commando te starten dient het python programma in ros2 geregistreerd te worden. Deze registratie wordt opgenomen in de setup.py van een ros package.
Open daartoe het setup.py bestand in de package vn de range_sensor
gedit ~/ros2_industrial_ws/src/ROS2_industrial/1_basics/range_sensor/setup.py
Voeg het entry point van assignment2.py toe aan de entry_points–>console_scripts sectie. Tip: Gebruik als voorbeeld assignment1
Bijvoorbeeld, voeg in setup.py onder ‘entry_points’ het volgende toe:
Referentie:Python Packages
Nadat setup.py gewijzigd is moet je de package opnieuw bouwen met colcon build:
cd ~/ros2_industrial_ws/
colcon build --symlink-install
source install/setup.bash
*Let op: De laatste regel dien je daarna in ieder openstaand terminal uit te voeren.
Opdracht 3: Programmeren
In het bestand assignment2.py vind je op een aantal plaatsen een Todo x. Vul onder deze regels de code in die in de Todo beschreven is.
Laat je inspireren door Writing a simple service and client Python, met name de secties over het aanmaken van een service client, het versturen van een request, en het verwerken van de response. Specifiek, implementeer een ROS2 service client met rclpy door:
Het aanmaken van een client voor de ConvertMetresToInches-service.
Het aanmaken van een request-object en het instellen van de benodigde parameter(s).
Het versturen van de aanvraag met send_request (gebruik async als voorbeeld).
Het afhandelen van de response in een callback, waarbij je de ontvangen waarde afdrukt.
Zie Writing a simple service and client Python voor voorbeeldcode en patronen.
Laat je inspireren door Writing a simple service and client Python
Opdracht 4: Testen
Om het programma te testen dien je achtereenvolgens de volgende node’s te starten
Uit opdracht over topics
Sensor info publisher
Box hoogte berekeningen (assignment1.py)
Deze opdracht (assignment2.py)
Opdracht 5: Cirkel Service (uitdaging)
Maak een eigen service welke de volgende functionaliteit heeft:
De service ontvangt een radius van een cirkel als parameter
De service berekent de oppervlakte van de cirkel en on de omtrek van de cirkel
De service geeft de oppervlakte en de omtrek terug in de response
Voer de volgende stappen uit:
Definieer een nieuwe servicebeschrijving in een .srv bestand waarin de request en response worden gespecificeerd. De request moet een parameter bevatten voor de radius van de cirkel, en de response moet parameters bevatten voor zowel de oppervlakte als de omtrek van de cirkel. Bou deze servicebeschrijving in een ROS2 package, bijvoorbeeld in de package range_sensor of in een nieuwe package die je aanmaakt voor deze service. Controleer dat de servicebeschrijving correct is en dat deze kan worden gebruikt om een service server en client te implementeren. Je kunt de servicebeschrijving testen door het command line commando ros2 interface proto te gebruiken om de request/response-structuur van de service te bekijken. Zie hiervoor opdracht 1 van deze workshop.
Implementeer een service server die de berekeningen uitvoert op basis van de ontvangen radius en de resultaten teruggeeft in de response.
Implementeer een service client die een radius naar de service stuurt en de ontvangen oppervlakte en omtrek afdrukt.
Voeg de service server en client toe als entry points in de setup.py van je package, zodat je ze kunt starten met ros2 run.
Hint
Vergeet niet om de package opnieuw te bouwen met colcon build nadat je de servicebeschrijving hebt toegevoegd en nadat je de service server en client hebt geïmplementeerd.
Opdracht 6: Testen van de cirkel service (uitdaging)
Test de service door gebruik te maken van het command line commando ros2 service call om je service te testen.
ros2 service call /circle_service <service_type> "{radius: 5.0}"
Opdracht 7: Client programmeren voor cirkel service (uitdaging)
Programmeer een client die een radius naar de cirkel service stuurt en de ontvangen oppervlakte en omtrek afdrukt. Gebruik hiervoor de stappen beschreven in opdracht 3, maar pas deze aan voor de cirkel service. Maak een nieuw Python programma aan, bijvoorbeeld circle_client.py, en implementeer hierin de service client functionaliteit voor de cirkel service. Maak het programma zodanig dat je de radius kunt invoeren vanaf de terminal. Gebruik hiervoor het Python input() functie om de radius van de gebruiker te verkrijgen voordat je de service-aanvraag verstuurt. Zorg ervoor dat je de ontvangen oppervlakte en omtrek correct afdrukt in de terminal.