Rerun Installation and Setup Guide

Installing Rerun

Rrerun can be installed with pip, follow the instructions below, skipping the python installation if you already have it.

macOS

1. Install Homebrew (if not already installed):
   Open Terminal and run:

   Bash

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install Python:

   Bash

   brew install python

3. Install Rerun:

   Bash

   pip install rerun-sdk

Ubuntu

1. Update Package List:
   Open Terminal and run:

   Bash

   sudo apt update

2. Install Python and Pip:

   Bash

   sudo apt install python3 python3-pip

3. Install Rerun:

   Bash

   pip3 install rerun-sdk

Running the Rerun Viewer

1. Navigate to the Project Directory:
   On the robot raspberry PI, open a terminal and navigate to the directory containing node_rerun.py:

   Bash

   cd path/to/your/project

2. Run the Rerun Viewer:
   Execute the following command to start the Rerun logging:

   Bash

   python3 nodes/node_rerun.py

Configuration

Setting Your Local IP Address

1. Locate thebot_quickstart.toml File:
   Find the bot_quickstart.toml file in your project directory.

2. Edit the File:
   Open the file in a text editor and set your local IP address:

   TOML

   [RERUN]
     HOST_IP_ADDRESS = "10.147.17.44"

   Replace YOUR_LOCAL_IP_ADDRESS with your actual local IP address.

You can reference the following to get your IP address on mac: https://www.security.org/vpn/find-mac-ip-address/

You can reference the following to get your IP address on ubuntu: https://linuxconfig.org/how-to-find-my-ip-address-on-ubuntu-20-04-focal-fossa-linux

Viewing Data in Rerun

• When you run node_rerun.py, the data will be displayed in your local Rerun instance. Ensure that your Rerun server is running and accessible at the IP address specified in the bot_quickstart.toml file.
• Ensure that our local rerun instance is started before running the node
• Other nodes as part of the start_all_nodes.py script will have to be run for data to be displayed, otherwise the messages will not be on the mqtt network for the rerun node to consume
• An example of the rerun view with the map and robot pose is shown below:

Troubleshooting

• If you encounter any issues, ensure that all dependencies are installed and that your Python environment is correctly set up.
• Verify that your local IP address is correctly configured in the bot_quickstart.toml file.

For further assistance, refer to the Rerun Documentation.