| Name | keapi-robotics JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A API to communicate with a KEBA PLC via WebSockets |
| upload_time | 2024-04-24 10:41:11 |
| maintainer | None |
| docs_url | None |
| author | Sebastian Redinger |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
keapi
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# KeApi
[](https://keapi.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/SebastianRedinger/keapi/actions/workflows/python-publish-to-pypi.yml)
[](https://pypi.org/project/keapi-robotics/)
KeApi is a Python package for communicating and
sending commands to your KEBA PLC via Web Sockets.
Note: This package is not affiliated with KEBA AG
## Who is this package for?
If you have a KEBA PLC and want to send commands to
it or monitor the state of it.
### Requirements
**RobotControl WebAPI 1.2.0**
**RobotControl API 1.2.0**
## Key Features
- Start and execute commands on the PLC
- Set and receive variables on the PLC
- Subscribe to cyclic and event based topics
## Documentation
The full documentation can be found at https://keapi.readthedocs.io
## Getting Started
### Installation
To install this package you can either use `python3 setup.py install` or `pip3 install keapi-robotics`
### Usage
To get startet you first need to connect to the applicalbe web sockets.
```
auth = ka.AuthMgr()
auth.login("IP", "ROBOT", "USERNAME", "PASSWORD")
# Connect to Servers
cmdserver = ka.connect_commands(auth)
subserver = ka.connect_subscriber(auth)
```
Once connected you are all set to send commands or subscribe to events.
#### Example
```
cmdserver.exec('set_active_client')
pos = {
'joints': {
'main_joints': [0, 0, 120, 0, 0, 0]
}
}
ticket = cmdserver.start('path_ptp', position=pos)
ticket.wait()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "keapi-robotics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "keapi",
"author": "Sebastian Redinger",
"author_email": "sebastian.redinger@fsbondtec.at",
"download_url": "https://files.pythonhosted.org/packages/46/4e/0f81f6b360f183dcb59b337930976a8844116571ef921f290c71b8d77068/keapi_robotics-1.0.0.tar.gz",
"platform": null,
"description": "# KeApi\n[](https://keapi.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/SebastianRedinger/keapi/actions/workflows/python-publish-to-pypi.yml)\n[](https://pypi.org/project/keapi-robotics/)\n\n\n\nKeApi is a Python package for communicating and\nsending commands to your KEBA PLC via Web Sockets.\n\nNote: This package is not affiliated with KEBA AG\n\n## Who is this package for?\nIf you have a KEBA PLC and want to send commands to\nit or monitor the state of it.\n\n### Requirements\n**RobotControl WebAPI 1.2.0** \n**RobotControl API 1.2.0** \n\n## Key Features\n- Start and execute commands on the PLC\n- Set and receive variables on the PLC\n- Subscribe to cyclic and event based topics\n\n## Documentation\nThe full documentation can be found at https://keapi.readthedocs.io\n\n## Getting Started\n### Installation\nTo install this package you can either use `python3 setup.py install` or `pip3 install keapi-robotics`\n\n### Usage\nTo get startet you first need to connect to the applicalbe web sockets.\n\n```\nauth = ka.AuthMgr()\nauth.login(\"IP\", \"ROBOT\", \"USERNAME\", \"PASSWORD\")\n\n# Connect to Servers\ncmdserver = ka.connect_commands(auth)\nsubserver = ka.connect_subscriber(auth)\n```\n\nOnce connected you are all set to send commands or subscribe to events.\n\n#### Example\n```\ncmdserver.exec('set_active_client')\n\npos = {\n 'joints': {\n 'main_joints': [0, 0, 120, 0, 0, 0]\n }\n}\nticket = cmdserver.start('path_ptp', position=pos)\nticket.wait()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A API to communicate with a KEBA PLC via WebSockets",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"keapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c0d73f2367b19ed407160e68b71231c74d5457bdc36238ca5684a55b3d78469f",
"md5": "e1714f36d632f9823ded8be62600bec9",
"sha256": "1c390d483364362073ce62e6f74d3d4475db309c407ac99df724042980ab784d"
},
"downloads": -1,
"filename": "keapi_robotics-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1714f36d632f9823ded8be62600bec9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9626,
"upload_time": "2024-04-24T10:41:10",
"upload_time_iso_8601": "2024-04-24T10:41:10.749553Z",
"url": "https://files.pythonhosted.org/packages/c0/d7/3f2367b19ed407160e68b71231c74d5457bdc36238ca5684a55b3d78469f/keapi_robotics-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "464e0f81f6b360f183dcb59b337930976a8844116571ef921f290c71b8d77068",
"md5": "35b5a98512daa1bb36b326f3beb0c3d9",
"sha256": "da8090450507ab32ddb53680f144f20306173ce24c5c7ce1987c82bfe70465a1"
},
"downloads": -1,
"filename": "keapi_robotics-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "35b5a98512daa1bb36b326f3beb0c3d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8985,
"upload_time": "2024-04-24T10:41:11",
"upload_time_iso_8601": "2024-04-24T10:41:11.660779Z",
"url": "https://files.pythonhosted.org/packages/46/4e/0f81f6b360f183dcb59b337930976a8844116571ef921f290c71b8d77068/keapi_robotics-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 10:41:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "keapi-robotics"
}
