https://github.com/dhbw-smart-rollerz/ros2_example_package
Example package for ROS2
https://github.com/dhbw-smart-rollerz/ros2_example_package
example ros2
Last synced: 3 months ago
JSON representation
Example package for ROS2
- Host: GitHub
- URL: https://github.com/dhbw-smart-rollerz/ros2_example_package
- Owner: DHBW-Smart-Rollerz
- License: mit
- Created: 2024-08-16T06:58:00.000Z (over 1 year ago)
- Default Branch: jazzy
- Last Pushed: 2024-11-26T15:18:12.000Z (about 1 year ago)
- Last Synced: 2024-12-29T23:56:21.717Z (about 1 year ago)
- Topics: example, ros2
- Language: Python
- Size: 27.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROS2 Example Package
[](https://github.com/DHBW-Smart-Rollerz/ros2_example_package/actions/workflows/build-test.yaml)
This repository contains an example package for ros2 (python).
## Usage
This repository can be used as template. Simply select this repo when creating a new repository under template.
Alternatively, you can create python ros packages with:
```bash
# If not already created
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
# Create package
ros2 pkg create my_package --build-type ament_python --dependencies rclpy
# Build
cd ~/ros2_ws/src
colcon build --symlink-install --packages-select my_package
```
## Structure
- `config/`: All configurations (most of the time yaml files)
- `launch/`: Contains all launch files. Launch files can start multiple nodes with yaml-configurations
- `models/`: Contains all models (optional) and only necessary for machine learning nodes
- `resource/`: Contains the package name (required to build with colcon)
- `ros2_example_package`: Contains all nodes and sources for the ros package
- `test/`: Contains all tests
- `package.xml`: Contains metadata about the package
- `setup.py`: Used for Python package configuration
- `setup.cfg`: Additional configuration for the package
- `requirements.txt`: Python dependencies
## Contributing
Thank you for considering contributing to this repository! Here are a few guidelines to get you started:
1. Fork the repository and clone it locally.
2. Create a new branch for your contribution.
3. Make your changes and ensure they are properly tested.
4. Commit your changes and push them to your forked repository.
5. Submit a pull request with a clear description of your changes.
We appreciate your contributions and look forward to reviewing them!
## License
This repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.