Neo Micromouse Project

Table of Contents

• Overview
• Features
• Project Structure
• Installation
• Usage
• Testing
• Libraries
• Contributions

Overview

The Neo Micromouse Project is developed using the Arduino framework and PlatformIO. This project aims to create a sophisticated micromouse capable of navigating mazes efficiently.

Features

• Bluetooth Control: Control the micromouse through MIT App Inventor using HC-05 Bluetooth module.
• Maze Solving: Solve the maze using Floodfill algorithm.

Project Structure

• include/: Contains project header files for declarations and macro definitions.
• lib/: Private libraries for the project.
• src/: Source files for the main application.
• test/: Unit tests for the project using PlatformIO Test Runner.
• .gitignore: Specifies files and directories to be ignored by Git.
• platformio.ini: PlatformIO project configuration file.
• README.md: Project documentation.

Installation

Prerequisites

• VS Code: Ensure you have VS Code installed.
• Arduino IDE: Ensure you have Arduino IDE installed.
• PlatformIO: Ensure you have PlatformIO installed. You can install it as a VS Code extension or as a standalone CLI.

Setup

1. Clone the Repository

   git clone https://github.com/khangronky/micromouse.git
   cd micromouse

2. Install Dependencies

   PlatformIO will automatically handle dependencies specified in the platformio.ini and library directories.

Usage

Building the Project

To build the project, navigate to the project directory and run:

platformio run

Uploading to Arduino UNO

Ensure your Arduino UNO is connected, then upload the firmware:

platformio run --target upload

Monitoring Serial Output

To monitor the serial output from the Arduino UNO:

platformio device monitor

Testing

The project includes unit tests to verify the functionality of individual modules.

Running Tests

Execute the following command to run all unit tests:

platformio test

Test Configuration

Tests are located in the test/ directory and utilize PlatformIO's built-in testing framework.

Libraries

• ArduinoSTL: Support for C++ Standard Library on Arduino.

Contributions

Contributions are welcome! Please follow these steps:

1. Fork the Repository

2. Create a Feature Branch

   git checkout -b feature/YourFeature

3. Commit Your Changes

   git commit -m "Add some feature"

4. Push to the Branch

   git push origin feature/YourFeature

5. Open a Pull Request

---

For any questions or support, please open an issue in the GitHub repository.