# mycobot_ros [![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/) [![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/english.svg)](https://docs.elephantrobotics.com/docs/gitbook-en/12-ApplicationBaseROS/) [δΈ­ζ–‡ζ–‡ζ‘£](https://docs.elephantrobotics.com/docs/gitbook/12-ApplicationBaseROS/) | [English Documentation](https://docs.elephantrobotics.com/docs/gitbook-en/12-ApplicationBaseROS/) 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) * Supported ROS versions: * Ubuntu 16.04 / ROS Kinetic * Ubuntu 18.04 / ROS Melodic * Ubuntu 20.04 / ROS Noetic ## Installation ### Option 1: Docker There are two ways to run this project. The first is by running the project in a container, and this requires [installing docker](https://docs.docker.com/engine/install/ubuntu/) and [installing docker-compose](https://docs.docker.com/compose/install/). The benefit of running in the container is that you can run the project in any version of linux, as long as your kernel is new enough. Once docker is installed, run the following command, and the project should show up. #### 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 **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 ``` This command does three things: 1) `docker-compose build ros` This builds the project in a container. That means nothing is installed on your host machine! The first time this runs, this command will take a long while. After running it once, caching will allow this command to run quickly. 2) `xhost +local:root` This command gives X the ability to display GUI's from within the docker container 3) `docker-compose up ros` This runs the image specified in the `docker-compose.yml`, which by default runs the command `roslaunch mycobot_320 mycobot_320_slider.launch` within the container. To run other tutorials, set the LAUNCH_TARGET environment variable. For example, to the run the MoveIt tutorial run: ``` export LAUNCH_TARGET=mycobot_320_moveit mycobot320_moveit.launch docker-compose up ros ``` ### Option 2: Local #### 2.1 Pre-Requriements For using this package, the [Python api](https://github.com/elephantrobotics/pymycobot.git) library should be installed first. ```bash pip install pymycobot --user ``` #### 2.2 Package Download and Install Install ros package in your src folder of your Catkin workspace. ```bash $ cd ~/catkin_ws/src $ git clone --depth 1 https://github.com/elephantrobotics/mycobot_ros.git $ cd ~/catkin_ws $ catkin_make $ source ~/catkin_ws/devel/setup.bash $ sudo echo 'source ~/catkin_ws/devel/setup.bash' >> ~/.bashrc ``` #### 2.3 Test Python API ```bash cd ~/catkin_ws/src/mycobot_ros python test.py ``` ## Where to get help There is documentation in the [ElephantRobotics Docs](https://docs.elephantrobotics.com/docs/gitbook-en/). Please check the ROS chapter. ## Important Links & Docs * [User Guide](https://docs.elephantrobotics.com/docs/gitbook-en/12-ApplicationBaseROS/) ## Contributing 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) ![Demo](./demo_img/Screenshot-3.png) ![Demo](./demo_img/Screenshot-4.png) ![Demo](./demo_img/Screenshot-5.png) ![Demo](./demo_img/320_slider.png) ![Demo](./demo_img/320_moveit.png) ## URDF Model Graph [mycobot 280 m5](./mycobot_description/urdf/mycobot_280_m5/mycobot_280_m5.urdf) ![280 m5](./demo_img/280m5/280_m5.png) [mycobot 280 m5 gripper](./mycobot_description/urdf/mycobot_280_m5/mycobot_280m5_with_gripper_parallel.urdf) ![280 m5 gripper](./demo_img/280m5/280_m5_gripper.png) [mycobot 280 m5 pump](./mycobot_description/urdf/mycobot_280_m5/mycobot_280m5_with_pump.urdf) ![280 m5 pump](./demo_img/280m5/280_m5_pump.png) [mycobot 280 m5 camera flange](./mycobot_description/urdf/mycobot_280_m5/mycobot_280m5_with_camera_flange.urdf) ![280 m5 camera flange](./demo_img/280m5/280_m5_camera_flange.png) [mycobot 280 m5 camera flange & pump](./mycobot_description/urdf/mycobot_280_m5/mycobot_280m5_with_camera_flange_pump.urdf) ![280 m5 camera flange & pump](./demo_img/280m5/280_m5_camera_flange_pump.png) [mycobot 280 pi](./mycobot_description/urdf/mycobot_280_pi/mycobot_280_pi.urdf) ![280 pi](./demo_img/280pi/280_pi.png) [mycobot 280 pi pump](./mycobot_description/urdf/mycobot_280_pi/mycobot_280pi_with_pump.urdf) ![280 pi pump](./demo_img/280pi/280_pi_pump.png) [mycobot 280 pi camera flange](./mycobot_description/urdf/mycobot_280_pi/mycobot_280pi_with_camera_flange.urdf) ![280 pi camera flange](./demo_img/280pi/280_pi_camera_flange.png) [mycobot 280 pi camera flange & pump](./mycobot_description/urdf/mycobot_280_pi/mycobot_280pi_with_camera_flange_pump.urdf) ![280 pi camera flange pump](./demo_img/280pi/280_pi_camera_flange_pump.png) [mycobot 280 JetsonNano](./mycobot_description/urdf/mycobot_280_jn/mycobot_280_jn.urdf) ![280 jn](./demo_img/280jn/280jn.png) [mycobot 280 Arduino](./mycobot_description/urdf/mycobot_280_arduino/mycobot_280_arduino.urdf) ![280 ar](./demo_img/280arduino/280_arduino.png) [mechArm 270 m5](./mycobot_description/urdf/mecharm_270_m5/mecharm_270_m5.urdf) ![270 m5](./demo_img/270m5/270m5.png) [mechArm 270 pi](./mycobot_description/urdf/mecharm_270_pi/mecharm_270_pi.urdf) ![270 pi](./demo_img/270pi/270pi.png) [myPalletizer 260 m5](./mycobot_description/urdf/mypalletizer_260_m5/mypalletizer_260_m5.urdf) ![260 m5](./demo_img/260m5/260m5.png) [myPalletizer 260 pi](./mycobot_description/urdf/mypalletizer_260_pi/mypalletizer_260_pi.urdf) ![260 pi](./demo_img/260pi/260pi.png) [mycobot 320 m5 2020](./mycobot_description/urdf/mycobot_320_m5_2020/mycobot_pro_320_m5_2020.urdf) ![320 m5 2020](./demo_img/320m5_2020/320m5_2020.png) [mycobot 320 m5 2022](./mycobot_description/urdf/mycobot_320_m5_2022/new_mycobot_pro_320_m5_2022.urdf) ![320 m5 2022](./demo_img/320m5_2022/320m5_2022.png) [mycobot 320 m5 2022 gripper](./mycobot_description/urdf/mycobot_320_m5_2022/new_mycobot_pro_320_m5_2022_gripper.urdf) ![320 m5 2022 gripper](./demo_img/320m5_2022/320m5_gripper_2022.png) [mycobot 320 pi 2022](./mycobot_description/urdf/mycobot_320_pi_2022/new_mycobot_pro_320_pi_2022.urdf) ![320 pi 2022](./demo_img/320pi_2022/320pi_2022.png) [ultraArm P340](./mycobot_description/urdf/ultraArm_p340/ultraArm_p340.urdf) ![p340](./demo_img/ultraArm_p340/ultraArmp340.png) [mycobot 280 pi aikit](./mycobot_description/urdf/mycobot_280_pi/mycobot_280pi_with_vision_v2.urdf) ![aikit 280pi](./demo_img/aikit/aikit_280pi.png) [mycobot 320 pi aikit](./mycobot_description/urdf/mycobot_320_pi_2022/new_mycobot_vision_v2_2022.urdf) ![aikit 320pi](./demo_img/aikit/aikit_320pi.png) [mybuddy](./mycobot_description/urdf/mybuddy/mybuddy.urdf) ![mybuddy](./demo_img/mybuddy/mybuddy.png) [mycobot pro 600](./mycobot_description/urdf/mycobot_pro_600/mycobot_pro_600.urdf) ![pro600](./demo_img/pro600/pro600.png) [myArm 300 Pi](./mycobot_description/urdf/myarm_300_pi/myarm_300_pi.urdf) ![myarm](./demo_img/myarm300/myarm300.png) [mycobot pro 630](./mycobot_description/urdf/mycobot_pro_630/mycobot_pro_630.urdf) ![pro630](./demo_img/pro630/pro630.png) ## Contributors Thanks goes to these people ([Emoji Key](https://allcontributors.org/docs/en/emoji-key)):
Alex Thiele
Alex Thiele
πŸ’»		 Shinya Nishimoto
Shinya Nishimoto
πŸ’» πŸ“–		 Takashi Ogura
Takashi Ogura
πŸ’»		 Ryuichiro Toyoshi
Ryuichiro Toyoshi
πŸ“–		 Ryo Kabutan
Ryo Kabutan
🎨		 Takafumi Watanabe
Takafumi Watanabe
πŸ’» πŸ“–		 Yoshiaki Watanabe
Yoshiaki Watanabe
πŸ’»
Masato Kobayashi
Masato Kobayashi
πŸ’»		 Daisuke Sato
Daisuke Sato
πŸ“– πŸ’»		 Eric Cousineau
Eric Cousineau
πŸ’»		 thandal
thandal
πŸ’»		 nakano16180
nakano16180
πŸ“–		 Akihiro Komori
Akihiro Komori
πŸ’»		 Jason Skowronski
Jason Skowronski
πŸ’»
2929ss
2929ss
πŸ’»		 TAKASU Masakazu
TAKASU Masakazu
πŸ“£		 SAITO, Tetsuya
SAITO, Tetsuya
πŸ“£
This project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind are welcome! ## License Licensed under standard three-clause BSD license (same as ROS Core), Copyright 2020-2023 Elephant Robotics. [Copy of the license](LICENSE).