| Name | elite-ec-sdk JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | SDK for Elite EC Series Cobots |
| upload_time | 2024-02-05 07:21:56 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.1 |
| license | MIT License Copyright (c) 2024 Tushar Gaurav Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
elite-sdk
elite-ec
elite-robots
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Elite EC Series Python SDK
## Introduction
There was no Python SDK for the Elite EC Series of Cobots, so I decided to make one. This SDK is based on the ELITE ROBOTS EC Series Programming Manual, provided by Elite Robots. The official manual provides functions that establish socket communication for controlling the robot. This SDK is the more pythonic version of the official manual.
## Usage
> Please insure that the robot is in remote mode when using this SDK.
You can instantiate a robot class for each robot, the robot class requires IP address at the time of object creation.
```python
warehouse_bot = Robot("192.168.0.1")
```
You need to follow these steps to send commands to the robot.
1. Instantiate a new robot object with IP and Port (by default Robot class uses Port 8055).
2. Make connection to the robot.
3. Send commands to the robot using the execute function or set variables using setVariable function.
4. After usage is over, You should ideally disconnect the robot using disconnect function.
### Example Program
```python
import robot
warehouse_bot = Robot("192.168.0.1")
# Connect to the robot
connection, message = warehouse_bot.connect()
print(message)
if connection:
# Accessing the value of System Variable B at address 1
_, result = warehouse_bot.getVariable("SysVarB", 1)
print("Value of SysVarB at addr 1: ", result)
# Executing pause_trajectory command mentioned in the Programming Manual
_, result = warehouse_bot.execute("pause_trajectory")
print(result)
# Disconnection the robot
result, message = warehouse_bot.disconnect()
print(message)
```
## Further Development
This SDK was made for the sole purpose of making my projects using this robot, easy to read and understand, the official "SDK", requires many lines of code to be written each time and it is difficult to understand.
Raw data
{
"_id": null,
"home_page": "",
"name": "elite-ec-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.1",
"maintainer_email": "",
"keywords": "elite-sdk,elite-ec,elite-robots",
"author": "",
"author_email": "Tushar Gaurav <tushar.gaurav416@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/60/505ea9da79b4ae2e8abee1482cbc60615ff88386f8b38492236e851b08ae/elite-ec-sdk-0.0.2.tar.gz",
"platform": null,
"description": "# Elite EC Series Python SDK\n\n## Introduction\nThere was no Python SDK for the Elite EC Series of Cobots, so I decided to make one. This SDK is based on the ELITE ROBOTS EC Series Programming Manual, provided by Elite Robots. The official manual provides functions that establish socket communication for controlling the robot. This SDK is the more pythonic version of the official manual.\n\n## Usage\n> Please insure that the robot is in remote mode when using this SDK.\n\nYou can instantiate a robot class for each robot, the robot class requires IP address at the time of object creation.\n\n```python\nwarehouse_bot = Robot(\"192.168.0.1\")\n```\n\nYou need to follow these steps to send commands to the robot.\n1. Instantiate a new robot object with IP and Port (by default Robot class uses Port 8055).\n2. Make connection to the robot.\n3. Send commands to the robot using the execute function or set variables using setVariable function.\n4. After usage is over, You should ideally disconnect the robot using disconnect function.\n\n### Example Program\n\n```python\nimport robot\n\nwarehouse_bot = Robot(\"192.168.0.1\")\n\n# Connect to the robot\nconnection, message = warehouse_bot.connect()\nprint(message)\n\nif connection:\n # Accessing the value of System Variable B at address 1\n _, result = warehouse_bot.getVariable(\"SysVarB\", 1)\n print(\"Value of SysVarB at addr 1: \", result)\n\n # Executing pause_trajectory command mentioned in the Programming Manual\n _, result = warehouse_bot.execute(\"pause_trajectory\")\n print(result)\n\n # Disconnection the robot\n result, message = warehouse_bot.disconnect()\n print(message)\n```\n\n## Further Development\nThis SDK was made for the sole purpose of making my projects using this robot, easy to read and understand, the official \"SDK\", requires many lines of code to be written each time and it is difficult to understand.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Tushar Gaurav Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "SDK for Elite EC Series Cobots",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/tushgaurav/EliteECSeriesSDK"
},
"split_keywords": [
"elite-sdk",
"elite-ec",
"elite-robots"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3cbecb6765b1f7a307bc1c8d66cec6ebab4250ecfa8459523df47918ccea25f",
"md5": "63454f7d1bd87fad20006c40deda4e52",
"sha256": "b300c6ad3c277627d0474ac317c506265f21769c24cb501a47840f684e003bb2"
},
"downloads": -1,
"filename": "elite_ec_sdk-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63454f7d1bd87fad20006c40deda4e52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.1",
"size": 8432,
"upload_time": "2024-02-05T07:21:53",
"upload_time_iso_8601": "2024-02-05T07:21:53.920566Z",
"url": "https://files.pythonhosted.org/packages/c3/cb/ecb6765b1f7a307bc1c8d66cec6ebab4250ecfa8459523df47918ccea25f/elite_ec_sdk-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0160505ea9da79b4ae2e8abee1482cbc60615ff88386f8b38492236e851b08ae",
"md5": "c9a2e41de9a8ee0ac7779d4d3baaddc8",
"sha256": "859bd4d0333b0cf37dda0ae6de1befc4952f7729ee403e8d6148842388aecc32"
},
"downloads": -1,
"filename": "elite-ec-sdk-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c9a2e41de9a8ee0ac7779d4d3baaddc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.1",
"size": 7016,
"upload_time": "2024-02-05T07:21:56",
"upload_time_iso_8601": "2024-02-05T07:21:56.037871Z",
"url": "https://files.pythonhosted.org/packages/01/60/505ea9da79b4ae2e8abee1482cbc60615ff88386f8b38492236e851b08ae/elite-ec-sdk-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 07:21:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tushgaurav",
"github_project": "EliteECSeriesSDK",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "elite-ec-sdk"
}
