Repository Summary
Description | ROS 1 & 2 repos based on Mini Pupper legged robots from MangDang |
Checkout URI | https://github.com/mangdangroboticsclub/mini_pupper_ros.git |
VCS Type | git |
VCS Version | ros2-dev |
Last Updated | 2025-09-26 |
Dev Status | UNKNOWN |
Released | UNRELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
Name | Version |
---|---|
mini_pupper_bringup | 0.1.0 |
mini_pupper_dance | 0.0.0 |
mini_pupper_description | 0.2.0 |
mini_pupper_driver | 0.0.1 |
mini_pupper_fleet | 0.0.1 |
mini_pupper_interfaces | 0.0.0 |
mini_pupper_music | 1.0.0 |
mini_pupper_navigation | 0.1.0 |
mini_pupper_recognition | 0.0.1 |
mini_pupper_simulation | 1.0.0 |
mini_pupper_slam | 1.0.0 |
mini_pupper_tracking | 0.0.0 |
stanford_controller | 1.0.0 |
README
Mini Pupper ROS 2 Humble
A comprehensive ROS 2 robotics platform for autonomous navigation, computer vision, and multi-robot coordination. Built for research, education, and development on Ubuntu 22.04 with ROS 2 Humble.
Key Capabilities
SLAM & Autonomous Navigation
Real-time mapping and path planning with ROS 2 Nav2 stack integration.
Documentation
Computer Vision Tracking
YOLO11-powered person detection and following with multi-object tracking.
Documentation
Multi-Robot Fleet Management
Centralized command and control for coordinated multi-robot operations.
Documentation
Choreographed Movement System
Programmable dance sequences with audio synchronization capabilities.
Documentation
Quick Start
Pre-built Images
Flash the ready-to-use image containing Ubuntu 22.04, ROS 2 Humble, and all Mini Pupper packages:
- Mini Pupper 2: 2024Oct.12.Ubuntu22.04.MD-MiniPupper2-Y.ROS2Humble.zip
- Mini Pupper: 2024Oct.12.Ubuntu22.04.MD-MiniPupper.ROS2Humble.zip
Test Basic Movement
# Terminal 1 (SSH to robot)
source ~/ros2_ws/install/setup.bash
ros2 launch mini_pupper_bringup bringup.launch.py
# Terminal 2 (PC or robot)
source ~/ros2_ws/install/setup.bash
ros2 run teleop_twist_keyboard teleop_twist_keyboard
Note: Refer to the Detailed Setup Guide for network configuration, PC setup, troubleshooting, and full BSP manual installation as an alternative to the pre-built image.
For comprehensive documentation, visit our online guide.
Contributing
Contributions are welcome. Whether it’s reporting a bug, suggesting a new feature, or submitting a pull request, we’d love your help in improving the Mini Pupper ROS 2 project.
- Read our CONTRIBUTING.md guide to get started.
- Explore or work on open issues.
License
Copyright 2022-2024 MangDang
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
CONTRIBUTING
How to Contribute
Thank you for your interest and time spent contributing!
We welcome contributions from everyone, and to ensure our community stays open and healthy
we adhere to the Contributor Covenant, a widely
used code of conduct adopted by many other communities such as
Linux, Autoware, GitLab.
Communication
First, please read through our code of conduct, as we expect all our contributors to follow it.
Second, before starting on a project that you intend to contribute to any of our
projects, we strongly recommend posting on the repository’s
Issues page or
Discord and
briefly outlining the changes you plan to make.
This will enable us to provide
some context that may be helpful for you. This could range from advice and
feedback on how to optimally perform your changes or reasons for not doing it.
Contribution Workflow
- Create an issue or post on Discord defining your intended contribution
- Create a fork
- For more information about the fork-and-pull model, see the GitHub Docs.
- Write code
- Create a pull request
- Fill the template
- For more information about the fork-and-pull model, see the GitHub Docs.
- Finish a pull request
- In order for a pull request to be merged to mini_pupper_ros, it must meet the following criteria:
- All discussions on the pull request must be resolved.
- All items of the pull request checklist are checked off.
- CI jobs for the pull request must have passed successfully.
- In order for a pull request to be merged to mini_pupper_ros, it must meet the following criteria:
Pull Requests
For Pull Requests, please target the ros2
branch for any ROS 2 contributions,
and the ros1
branch for any ROS 1 contributions.
To contribute, please check out the ros2
branch, and then create your feature
branch from there:
git checkout ros2 # start with the ros2 branch
git pull origin ros2 # pull remote repo changes
git checkout your-feature-branch # create your feature branch
Then when you submit a Pull Request, please select the ros2
branch to request
to merge your commits.
If you are interested in understanding this development style a bit further, we follow the GitHub Flow model of branching.
Guildlines for Development
License
mini_pupper_ros is licensed under the Apache 2.0 License, and thus all contributions will be licensed as such as per clause 5 of the Apache 2.0 License:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Code Style
We follow the ROS code style guidelines as closely as possible. Please ensure that any new contributions are compatible with C++17 and Python3.x.
To check Python code style, run the following command in the ROS workspace.
ament_flake8
ament_pep257
To check C++ code style, run the following command in the ROS workspace.
ament_clang_format --reformat
ament_uncrustify --reformat
ament_cpplint
After checking all styles, run the following command to test the ROS package configuration in the ROS workspace.
colcon test --packages-select-regex "mini_pupper*"
colcon test-result --verbose # confirm this shows "0 errors, 0 failures, 0 skipped"
File truncated at 100 lines see the full file