Skip to content

Installation and Usage

Clone the repository and start the software stack using the recommended docker compose.

IMPORTANT: Make sure to also clone the ric-messages git submodule located in src folder.

Running

Docker Compose

  1. Install Docker and Docker Compose for your operating system
  2. Inside the repository run docker compose up
    • Specify the file parameter -f with compose.cpu.yaml if there is no Nvidia GPU present on your system.
    • This will first build or pull the required docker images and then download the model defined in the .env file and start a whisper.cpp server and the speech to text ROS2 node that provides the /stt service.
    • Do note that the ROS2 node makes use of rmw_zenoh for ROS2 communication.
  3. Send ROS2 messages to /stt service using audio parameter for uint8[] array containing the audio data.
  4. Stop the server either by aborting using CTRL-C or docker compose stop if started detached -d.

Manual

Follow the relevant documentation on whisper.cpp for how to compile and run the webserver and the ROS2 documentation on how to build packages and run nodes.

Note: The recommended way to build the ROS2 node as of writing is using colcon.