Welcome to the Wheelie robot project! This guide will help you get started, understand the project structure, and point you to the most important documentation for building, wiring, programming, calibrating, and operating your robot.
- Wheelie is an open-source, modular robot platform based on the ESP32 microcontroller.
- Features include: motor control, multiple sensors (ToF, IMU, encoders, sound, ultrasonic), WiFi, OTA updates, and more.
- Read the Assembly Guide
- Wire your hardware using the Wiring Guide
- Flash the firmware using PlatformIO
- Calibrate your sensors (Calibration Guides)
- Test and operate your robot!
/docs/— All documentation/assembly/— Hardware setup, wiring, shopping list/calibration/— Sensor calibration guides/components/— Guides for each hardware module/sensors/— Sensor integration and usage/power/— Power system documentation
/src/— Main firmware source code/include/— Header files/tests/— Test programs/data/— Web server files
- Assembly:
SETUP_GUIDE.md,SHOPPING_LIST.md - Wiring:
WIRING.md,HARDWARE_PIN_MAPPING.md - Power:
POWER_MANAGEMENT_SYSTEM.md,XL4015_POWER_GUIDE.md - Motors:
MOSFET_MOTOR_DRIVER_GUIDE.md - Sensors:
- WiFi/OTA:
WIFI_CONNECTIVITY_GUIDE.md,OTA_GUIDE.md
- Install PlatformIO in VS Code.
- Open the project folder.
- Edit
platformio.iniif needed for your board. - Use the PlatformIO sidebar to Build and Upload the firmware.
- Calibrate all sensors for best performance:
- Check the relevant guide in
/docs/for your issue. - Review the serial monitor output for errors.
- Visit the project repository for updates and community support.
- See
CONTRIBUTING.mdfor guidelines.
Happy building!