From ab6d0f2e016b16043831cb974e79bbc68449f3cd Mon Sep 17 00:00:00 2001 From: "Leonid V. Fedorenchik" Date: Thu, 12 Jan 2023 18:52:34 +0800 Subject: [PATCH 1/9] Add support for noetic in docker --- Dockerfile | 11 ++++++----- docker-compose.yml | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index 010464f..903e7ae 100644 --- a/Dockerfile +++ b/Dockerfile @@ -15,13 +15,14 @@ ENTRYPOINT ["/bin/bash", "-c"] # Install build dependencies RUN apt-get update && apt-get install -y curl -RUN curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | apt-key add - && \ +RUN PY_PKG_V=""; if [ "${ROS_DISTRO}" == "noetic" ]; then PY_PKG_V="3"; fi && \ + curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | apt-key add - && \ apt-get install -y \ sudo \ # ROS Build dependencies - python-rosinstall \ - python-rosinstall-generator \ - python-wstool \ + python${PY_PKG_V}-rosinstall \ + python${PY_PKG_V}-rosinstall-generator \ + python${PY_PKG_V}-wstool \ build-essential \ python3-pip @@ -49,7 +50,7 @@ RUN rosdep install -r -y -i --from-paths . USER er # Build the project WORKDIR /home/er/catkin_ws -RUN . /opt/ros/melodic/setup.bash && catkin_make +RUN catkin_make # Let ROS know about the projects launch options RUN echo "source /home/er/catkin_ws/devel/setup.bash" >> $BASH_ENV diff --git a/docker-compose.yml b/docker-compose.yml index 24a62d2..71d39d8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -32,3 +32,22 @@ services: args: <<: *common-args BASE_IMAGE: ubuntu:18.04 + + nvidia-ros-noetic: + <<: *common + runtime: nvidia + build: + context: . + args: + <<: *common-args + ROS_DISTRO: "noetic" + BASE_IMAGE: nvidia/opengl:1.1-glvnd-runtime-ubuntu18.04 + + ros-noetic: + <<: *common + build: + context: . + args: + <<: *common-args + ROS_DISTRO: "noetic" + BASE_IMAGE: ubuntu:20.04 From c1c9aff8ebfe592707f3a03ba27f77da7d18d935 Mon Sep 17 00:00:00 2001 From: "Leonid V. Fedorenchik" Date: Thu, 12 Jan 2023 18:58:46 +0800 Subject: [PATCH 2/9] Add docker noetic info to README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 853ba86..beddfbb 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,29 @@ is new enough. Once docker is installed, run the following command, and the project should show up. -without NVIDIA GPU: +#### Without NVIDIA GPU: + +**ROS Noetic**: + +``` +docker-compose build ros-noetic && xhost +local:root && docker-compose up ros-noetic +``` + +**ROS Melodic**: ``` docker-compose build ros && xhost +local:root && docker-compose up ros ``` -with NVIDIA GPU +#### With NVIDIA GPU + +**ROS Noetic**: + +``` +docker-compose build nvidia-ros-noetic && xhost +local:root && docker-compose up nvidia-ros-noetic +``` + +**ROS Melodic**: ``` docker-compose build nvidia-ros && xhost +local:root && docker-compose up nvidia-ros From 903e9ab9afde2850ce55fa0d54eb2e0250a36230 Mon Sep 17 00:00:00 2001 From: "Leonid V. Fedorenchik" Date: Fri, 13 Jan 2023 11:05:42 +0800 Subject: [PATCH 3/9] Add CONTRIBUTING.md --- CONTRIBUTING.md | 155 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 +++- 2 files changed, 165 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..775371f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,155 @@ + +# Contributing to mycobot_ros + +First off, thanks for taking the time to contribute! ❤️ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + +## Table of Contents + +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Your First Code Contribution](#your-first-code-contribution) + - [Improving The Documentation](#improving-the-documentation) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) +- [Code of Conduct](#code-of-conduct) + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.elephantrobotics.com/docs/gitbook-en/). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/elephantrobotics/mycobot_ros/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/elephantrobotics/mycobot_ros/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. + +We will then take care of the issue as soon as possible. + + + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://docs.elephantrobotics.com/docs/gitbook-en/). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/elephantrobotics/mycobot_rosissues?q=label%3Abug). +- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: + - Stack trace (Traceback) + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. + - Possibly your input and the output + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/elephantrobotics/mycobot_ros/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed: + +- The project team will label the issue accordingly. +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. +- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). + + + + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for mycobot_ros, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation](https://docs.elephantrobotics.com/docs/gitbook-en/) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/elephantrobotics/mycobot_ros/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/elephantrobotics/mycobot_ros/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +- **Explain why this enhancement would be useful** to most mycobot_ros users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + + + +### Your First Code Contribution + + +### Improving The Documentation + + +## Styleguides +### Commit Messages + + + +## Code of Conduct + +This project and everyone participating in it is governed by the +[mycobot_ros Code of Conduct](CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior +to . + + +## Attribution +This guide is based on the [contributing-gen](https://github.com/bttger/contributing-gen). diff --git a/README.md b/README.md index beddfbb..5e28641 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Control or simulate myCobot series robots in ROS. +![Demo](./demo_img/Screenshot-1.png) + **Notes**: * Make sure that `Atom` is flashed into the top Atom and `Transponder` or `minirobot` is flashed into the base Basic .The tool download address: [https://github.com/elephantrobotics/myCobot/tree/main/Software](https://github.com/elephantrobotics/myCobot/tree/main/Software) @@ -117,9 +119,15 @@ There is documentation in the [ElephantRobotics Docs](https://docs.elephantrobot * [User Guide](https://docs.elephantrobotics.com/docs/gitbook-en/12-ApplicationBaseROS/) -## Screenshots +## Contributing -![Demo](./demo_img/Screenshot-1.png) +Contributions are always welcome! + +See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started. + +Please adhere to this project's [code of conduct](CODE_OF_CONDUCT.md). + +## Screenshots ![Demo](./demo_img/Screenshot-2.png) From c3e948f94a9e0708ecd1dba5b201f70fdde9a303 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 13 Jan 2023 03:58:03 +0000 Subject: [PATCH 4/9] docs: update README.md [skip ci] --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e28641..e8b0fb6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mycobot_ros -[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-) [![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/chinese.svg)](https://docs.elephantrobotics.com/docs/gitbook/12-ApplicationBaseROS/) @@ -167,6 +167,9 @@ Thanks goes to these people ([Emoji Key](https://allcontributors.org/docs/en/emo Akihiro Komori
Akihiro Komori
💻 Jason Skowronski
Jason Skowronski
💻 + + 2929ss
2929ss
💻 + From 72f886b1dc6f66070292eec61e3d340f0b0a2fdb Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 13 Jan 2023 03:58:04 +0000 Subject: [PATCH 5/9] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index b339087..6d5d05f 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -134,6 +134,15 @@ "contributions": [ "code" ] + }, + { + "login": "2929ss", + "name": "2929ss", + "avatar_url": "https://avatars.githubusercontent.com/u/51234222?v=4", + "profile": "https://github.com/2929ss", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, From df4ede24a1886600b4370ec1439c397d06df9d95 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 13 Jan 2023 04:03:25 +0000 Subject: [PATCH 6/9] docs: update README.md [skip ci] --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e8b0fb6..2f71d01 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mycobot_ros -[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) [![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/chinese.svg)](https://docs.elephantrobotics.com/docs/gitbook/12-ApplicationBaseROS/) @@ -169,6 +169,7 @@ Thanks goes to these people ([Emoji Key](https://allcontributors.org/docs/en/emo 2929ss
2929ss
💻 + TAKASU Masakazu
TAKASU Masakazu
📣 From f256b446c7fbcd0135f07a43661aabbaf56045e3 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 13 Jan 2023 04:03:26 +0000 Subject: [PATCH 7/9] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 6d5d05f..8ad1bf3 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -143,6 +143,15 @@ "contributions": [ "code" ] + }, + { + "login": "takasumasakazu", + "name": "TAKASU Masakazu", + "avatar_url": "https://avatars.githubusercontent.com/u/1667148?v=4", + "profile": "https://medium.com/@tks/takasu-profile-c50feee078ac", + "contributions": [ + "promotion" + ] } ], "contributorsPerLine": 7, From 48ad3b84991b2c54c642bd30b4f29ccba4232b67 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 17 Jan 2023 01:50:59 +0000 Subject: [PATCH 8/9] docs: update README.md [skip ci] --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f71d01..b848638 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mycobot_ros -[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors-) [![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/chinese.svg)](https://docs.elephantrobotics.com/docs/gitbook/12-ApplicationBaseROS/) @@ -170,6 +170,7 @@ Thanks goes to these people ([Emoji Key](https://allcontributors.org/docs/en/emo 2929ss
2929ss
💻 TAKASU Masakazu
TAKASU Masakazu
📣 + SAITO, Tetsuya
SAITO, Tetsuya
📣 From 381a186b638acb425e69b0a44b75ed38760b39e2 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 17 Jan 2023 01:51:00 +0000 Subject: [PATCH 9/9] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 8ad1bf3..414e8f3 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -152,6 +152,15 @@ "contributions": [ "promotion" ] + }, + { + "login": "3110", + "name": "SAITO, Tetsuya", + "avatar_url": "https://avatars.githubusercontent.com/u/114928?v=4", + "profile": "https://scrapbox.io/saitotetsuya/", + "contributions": [ + "promotion" + ] } ], "contributorsPerLine": 7,