robotcomponents / robotcomponents Goto Github PK

Robot Components is a plugin for intuitive robot programming for ABB robots inside Rhinoceros Grasshopper. Robot Components offers a wide set of tools to create toolpaths, simulate robotic motion and generate RAPID code within Grasshopper. Some of the main features include:

• 40+ predefined ABB robot models
• Possibility to add your own robot models
• Support for external axes (both linear and rotational)
• Possibility to define custom strategies for all external axis values
• Support for work objects (including movable work objects)
• Efficient forward and inverse kinematics
• Possibility to add your own custom code lines
• Real-time connection with IRC5 and OmniCore controllers
• Robot Components API to develop your custom components using either Python or C#

If you use Rhino 7 or higher you can install Robot Components via the package manager. For other versions, you can download the latest release directly from this repository's releases page or Food4Rhino. Unzip the downloaded archive and copy all files in the Grasshopper Components folder (in GH, File > Special Folders > Components Folder). Make sure that all the files are unblocked (right-click on the file and select Properties from the menu. Click Unblock on the General tab). Restart Rhino and you are ready to go!

In case you want to use the components from the Controller Utility section you additionally have to install Robot Studio or the ABB Robot Communication Runtime (you can download it by clicking here). The latest release is built and tested against the ABB PC SDK version 2024.1 (ABB Robot Communication Runtime 2024.1). We do not guarantee that the Controller Utility components work with older versions of the ABB Robot Communication Runtime. Besides that, the components from the Controller Utility section are only supported on Windows operating systems. Please contact us if you have problems with establishing a real-time connection from Grasshopper.

You can find a collection of example files demonstrating the main features of Robot Components in this repository in the folder Example Files. You can find the Grasshopper documentation website here. The documentation website of the API here.

For easy sharing of the download link and the documentation (with e.g. students) you can also use our linktree.

Robot Components is an open-source project that was initiated by the chair of Experimental and Digital Design and Construction of the University of Kassel. The plugin is currently further developed and maintained by Arjen Deetman. All developers and contributors are listed here.

Robot Components uses the ABB PC SDK for real-time connection to ABB Robots, you can find the SDK used in this project here.

Robot Components uses the OPW kinematics solver as described in the paper 'An Analytical Solution of the Inverse Kinematics Problem of Industrial Serial Manipulators with an Ortho-parallel Basis and a Spherical Wrist' by Mathias Brandstötter, Arthur Angerer, and Michael Hofbaur.

We would like to acknowledge Jose Luis Garcia del Castillo and Vicente Soler for making their Grasshopper plugins RobotExMachina and Robots available. Even our approach is different it was helpful for us to see how you implemented certain functionalities and approached certain issues.

Known issues are listed here. If you find a bug, please help us solve it by filing a report.

Please have a look at the open issues and projects to know what we are currently developing and what we want to add and change in the future.

Bug reports: Please report bugs at our issue page.

Feature requests: Feature requests can be proposed on our issue page. Please include how this feature should work by explaining it in detail and if possible by adding relevant documentation (from e.g. ABB).

Code contributions: We accept code contributions through pull requests. For this you have to fork or clone this repository. To compile the code all necessary references are placed in the folder DLLs. We only accept code contributions if they are commented. We use XML comments to auto-generate our API documentation. You can read more about this topic here and here. If you want to make a significant contribution, please let us know what you want to add or change to avoid doing things twice. For questions or if you want to discuss your contribution you can reach out to one of the developers. Feel free to add your name to the list with contributors before you make a pull request.

Adding support for other brands: Robot Components is developed to intuitively program ABB robots inside Grasshopper. At the moment we have no plans to implement the support for other robot brands. However, we have a few ideas about how to implement this and since we want to keep Robot Components as intuitive as possible we kindly ask you to contact one of the developers first in case if you want to implement other robot brands. We are happy to contribute to and support this development.

Robot Components is a free-to-use Grasshopper plugin and does not legally bind you to cite it. However, we have invested time and effort in creating Robot Components, and we would appreciate it if you would cite if you used it. Please use our DOI from Zenodo. To cite all versions of Robot Components in publications use:

Arjen Deetman, Gabriel Rumpf, Benedikt Wannemacher, Mohamed Dawod, Zuardin Akbar, & Andrea Rossi (2024). 
Robot Components: Intuitive Robot Programming for ABB Robots inside of Rhinoceros Grasshopper.
Zenodo. https://doi.org/10.5281/zenodo.5773814

Note that there are two reasons for citing the software used. One is giving recognition to the work done by others which we already addressed. The other is giving details on the system used so that experiments can be replicated. For this, you should cite the version of Robot Components that is used. On our Zenodo page you can find how to cite specific versions. See How to cite and describe software for more details and an in-depth discussion.

Robot Components uses the following Semantic Versioning scheme:

0.x.x ---> MAJOR version when you make incompatible API changes
x.0.x ---> MINOR version when you add functionality in a backward-compatible manner
x.x.0 ---> PATCH version when you make backward-compatible bug fixes

Versions that were not released on Food4Rhino are marked as pre-release.

An overview of the projects wherein the software is used can be found here.

Copyright (c) 2018-2020 EDEK Uni Kassel
Copyright (c) 2020-2024 Arjen Deetman

Robot Components is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation.

Robot Components is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Robot Components; If not, see http://www.gnu.org/licenses/.

@license GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html