Cogniteam Component library for ROS noetic

This library contains open dockerized components for ROS If you wish to use ROS2 check out our ROS2 library

ROSCon 2023

To participate in the contest and stand a chance to win a Leo Rover, start by forking our library. Following this, you have two options to proceed:

Initiate a merge request to include a folder containing your component's Dockerfile. For guidance on this, please refer to these instructions.
Create a merge request to add your git repository details to the ContributedComponents.MD file. Detailed steps can be found here.

Cogniteam’s Components Table

Image	Link
	amcl
	arducam-jetson
	aruco-code-detection
	audio-say
	autopilot-bridge
	autopilot_bridge
	bboxes-to-3d-markers
	bosch-imu-driver
	caffe-object-detection
	cartographer-slam
	circle-detection
	client-service-example
	cogniteam-anomaly-detection
	cogniteam-coverage-exploration
	cogniteam-image-rotate-filp
	cogniteam-merge-videos
	cogniteam-person-follower-depth
	cogniteam-person-follower-rgb
	cogniteam-random-goals
	cogniteam-robot-pose
	cogniteam-skeleton-gestures
	custom-message-talker
	custom-message-listener
	custom-service-client
	custom-service-server
	deegoo-fpv-gps
	depth-2-grayscale
	depth-2-pcloud
	faces-landsmarks-mediapipe
	generic-webcam
	generic-webcam-with-mic
	gmapping
	prokit-driver
	hamster-driver
	hamster-v8-environment
	hamster-wandering
	hands-pose-detection
	hector-mapping-hd
	hector-mapping
	hokuyo
	image-republisher
	image-topic-to-rtsp
	imu-filter-madgwick
	jetson-isaac-skeleton
	joystick-teleop-twist
	kobuki-driver
	laser-filters
	leg-detector
	leo-robot-driver
	leo-robot-gateway
	lizi-driver
	lsd-lidar-c16
	lynx-driver
	lynx-gps-localization
	lynx-navigation
	m-exploration
	map-server
	mir-driver
	move-base-navigation
	novatel-gps
	omron-ld60-driver
	openvino-myriad
	openvino-cpu-detection
	openvino-cpu-segmentation
	orb2-slam
	ouster-driver
	path-publisher
	path-waypoints-navigation
	razor-imu
	realsense-camera-d455
	realsense-camera-l515
	realsense-camera-d435
	realsense-t265
	richbeam-lakibeam
	ros-deep-learning-jetson-inference
	ros-serial-st-python
	ros-tutorials-listener
	ros-tutorials-talker
	ros1-gateway-arm32
	ros1-gateway-launch
	ros1-map-saver
	audio_play
	audio_capture
	rover-driver
	rtsp-camera
	server-service-example
	sick-safety-nanoscan3
	slam-toolbox-mapping
	slam-toolbox-localization
	rplidar-s2
	rplidar-a2
	rplidar-a3
	rplidar-a1
	rplidar-s1
	spot-bridge
	stm-remote-burn
	sweep-lidar
	tflite-object-detection
	theora-encoder
	turtlebot3-slam
	turtlebot3-driver
	turtlebot3-lidar
	turtlebot3-picamera
	turtlebot3-navigation
	ubiquity-driver
	velodyne-vlp-16
	vosk-speech-to-text
	waypoints-navigation
	ydlidar-tmini-pro
	ydlidar-sdm15
	ydlidar-tg30
	yocs-velocity-smoother
	zed-camera-jetson-xavier

Contributed Components Table

Image	Link
	ROS-YDLidar-x4

Contribution

If you wish to contribute by adding a new component to our library as part of our ongoing competition, please follow the instructions below:

Prerequisites

Before you begin, ensure you have met the following requirements:

You have a GitHub account.
You have installed Git.
You have installed Docker.

Forking and Cloning the Repository

Fork the Repository: Click on the 'Fork' button on the upper right-hand side of the page. A copy of the repository will be created on your personal GitHub account.
Clone the Repository: Clone the forked repository to your local machine by running:
```
git clone https://github.com/cognimbus/Nimbus.Library.Components.ROS.git
```

Adding a New Component

Option 1: Add a folder with your component's Dockerfile

1. Prepare Your Component Structure

comp_name: Directory for your component
- docker: Contains code and the Docker file
- img_file: image represents the component

2. Create and Test Your Dockerfile

Navigate to the cloned repository on your local machine.
Create a new Dockerfile with the required configurations for the ROS/ROS2 application you wish to containerize.

Test your Dockerfile locally with:

docker build -t ros_app:<tag> .
docker run --rm -it ros_app:<tag>

3. Place Your Files in the Directory Structure

Place the Dockerfile and code into the appropriate directory structure within comp_name/docker.

4. Commit Your Changes

After testing, commit your changes:

git add .
git commit -m "Your detailed commit message"

Option 2: Add your git repository to ContributedComponents.MD

If you already have a git repository with a Dockerfile, simply add a link in ContributedComponents.MD and request to merge it. Make sure to add a relevant image from your git and make sure your git includes a valid Dockerfile that uses this version of ROS.

Step 1: Prepare Your Image and Repository URL

Before adding a new row to the table, make sure you have the following:

Image URL: The URL of the image that represents your component. This should be hosted inside your Git repository. You can obtain the URL by navigating to the image file in your Git repository (e.g., on GitHub) and copying the URL.
Repository URL: The URL of your Git repository where the component is hosted.

Step 2: Add a New Row to the Table

To add a new component to the table, follow these steps:

Open the Markdown File: Open the markdown file where the table is located.

Add a New Row: Add a new row to the table with the following format:

Image | Link
--- | ---
<img src="IMAGE_URL" alt="COMPONENT_NAME" width="40"/> | [COMPONENT_NAME](REPOSITORY_URL)

Replace Placeholders: Replace IMAGE_URL, COMPONENT_NAME, and REPOSITORY_URL with the actual values:
- IMAGE_URL: The URL of the image you prepared in step 1.
- COMPONENT_NAME: The name of your component.
- REPOSITORY_URL: The URL of your Git repository.

Submitting a Merge Request

Push Your Changes: Push to your forked repository:
```
git push origin <ros-distro>
```
Create a Pull Request: Navigate to your forked repository's GitHub page, click 'Pull request', and write a detailed comment.
Submit: Click 'Submit pull request'.

Support and Contact

If you have questions or encounter issues, open an issue in the repository, and one of our maintainers will get back to you as soon as possible. Thank you for your contribution!

cogniteam / library.components.ros Goto Github PK

library.components.ros's Introduction