Sanity Receiver

This repository contains the code for the sanity receiver, an ESP32-based device for receiving and processing data.

Getting Started

Prerequisites

• ESP-IDF v5.5.1
• A working Wi-Fi connection

ESP-IDF Installation

It is recommended to use the v5.5.1 of the ESP-IDF.

macOS & Linux

# Create a directory for esp-idf
mkdir -p ~/esp
cd ~/esp
# Clone the specific version
git clone --recursive https://github.com/espressif/esp-idf.git -b v5.5.1
# Install the tools
cd ~/esp/esp-idf
./install.sh
# Add the environment variables to your shell
source ./export.sh

Configuration

Update the main/config.h file with your Wi-Fi credentials:

#define WIFI_SSID "your_wifi_ssid"
#define WIFI_PASS "your_wifi_password"

Usage

The scripts/ directory contains several example scripts to interact with the sanity receiver.

• udp_broadcast.py: This script broadcasts a UDP control packets.
• ros2_example.py: This script provides an example of how to integrate the sanity receiver with ROS2.
• batch_flash.sh: This script is used to flash multiple devices in batch.

ROS2 Example

The ros2_example.py script demonstrates how to publish the received data to a ROS2 topic. To run the example, you will need to have a ROS2 environment sourced.