All in one package for complete control of your UR robot.
Project description
__author__ = "Beck Isakov"
__copyright__ = "Beck isakov"
__credits__ = "Martin Huus Bjerge"
__contact__ = "https://github.com/Jp-Beck"
__license__ = "GPL v3"
__version__ = "0.2.4"
__maintainer__ = "Beck Isakov"
__email__ = "jp-beck@outlook.com"
__status__ = "Development"
For full documentation visit jp-beck.github.io.
Documentation Guide
Introduction
- Overview: This is the all in one package to control or get data from the Universal robots.
- Features:
- Supported Versions/Platforms:
- Python 3.6+ (will later support 2.7)
- Universal Robots e-Series, tested on UR3e, UR5e, UR10e, UR16e
- Windows, Linux, Mac OS X
Quick Start or Getting Started
pip install OpenUr
- Install the latest version of OpenUr package.openur make .
- Create a new rtde_configuartion.xml file in your project directory to enable the use of RTDE.import openur
- Import the package in your project.openur = OpenUR('ROBOT_IP_ADDRESS')
- Connect to the robot and access all the features of the package via theopenur
object.- For example:
openur.get_actual_tcp_pose()
- Get the current TCP pose of the robot.
Installation Guide
pip install OpenUr
- Easiest way to install the package.- Source Code - You can source it from the github repository.
- Docker - You can also use the docker image to run the package (In the future)
User Guide or Manual
- Getting Started in User Guide
- Refer to the Examples/Tutorials
API Reference
- This section will be update in the future.
Examples/Tutorials
- Step-by-step guides or use-case driven tutorials.
- Helps users understand real-world applications of your package.
FAQs
- Common questions or issues that users might encounter.
Troubleshooting
- Common issues, error messages, and their resolutions.
- Tips for diagnosing issues.
Contribution Guide
- Feel free to request pulls and collaborate.
- Please read the contribution guide before making pull requests.
Changelog or Release Notes
- Document the changes made in each release.
License
- Clearly state the license under which your software is released.
Contact/Support
- Provide information on how users can get support.
Glossary
- Technical terms or jargon used.
Project layout
.
├── build
├── CHANGELOG
├── dist
├── docs
│ ├── examples.md
│ ├── glossary.md
│ ├── installation_guide.md
│ ├── migration_guide.md
│ ├── quick_start.md
│ ├── support.md
│ ├── troubleshooting.md
│ └── user_guide.md
├── LICENSE
├── MANIFEST.in
├── openur
│ ├── cli.py
│ ├── connections
│ │ ├── connection_state.py
│ │ ├── __init__.py
│ │ ├── realTimeClient.py
│ │ └── robotConnector.py
│ ├── dashboard
│ │ ├── dashboard.py
│ │ └── __init__.py
│ ├── __init__.py
│ ├── kinematics
│ │ ├── __init__.py
│ │ ├── kinematic.py
│ │ └── manipulation.py
│ ├── rtde
│ │ ├── csv_binary_writer.py
│ │ ├── csv_reader.py
│ │ ├── csv_writer.py
│ │ ├── __init__.py
│ │ ├── rtde_config.py
│ │ ├── rtde.py
│ │ └── serialize.py
│ ├── rtde_command
│ │ ├── __init__.py
│ │ ├── rtde_commands.py
│ │ └── rtde_connect.py
│ ├── urscript
│ │ ├── freedrive.py
│ │ ├── __init__.py
│ │ ├── script.txt
│ │ ├── urScriptExt.py
│ │ ├── urscript.py
│ │ └── urScript.py
│ └── utils
│ ├── dataLogging.py
│ ├── data_log.py
│ ├── dataLog.py
│ ├── __init__.py
│ └── logConfig.xml
├── openur.py
├── README.md
├── requirements.txt
├── rtde_configuration.xml # This file is created by the command `openur make .` and must have the name rtde_configuration.xml
├── setup.py
└── TODO.MD
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
OpenUr-0.2.4.tar.gz
(89.9 kB
view hashes)
Built Distribution
OpenUr-0.2.4-py3-none-any.whl
(103.2 kB
view hashes)