A API to communicate with a KEBA PLC via WebSockets
Project description
KeApi
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()
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file keapi_robotics-1.0.0.tar.gz.
File metadata
- Download URL: keapi_robotics-1.0.0.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da8090450507ab32ddb53680f144f20306173ce24c5c7ce1987c82bfe70465a1
|
|
| MD5 |
35b5a98512daa1bb36b326f3beb0c3d9
|
|
| BLAKE2b-256 |
464e0f81f6b360f183dcb59b337930976a8844116571ef921f290c71b8d77068
|
File details
Details for the file keapi_robotics-1.0.0-py3-none-any.whl.
File metadata
- Download URL: keapi_robotics-1.0.0-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1c390d483364362073ce62e6f74d3d4475db309c407ac99df724042980ab784d
|
|
| MD5 |
e1714f36d632f9823ded8be62600bec9
|
|
| BLAKE2b-256 |
c0d73f2367b19ed407160e68b71231c74d5457bdc36238ca5684a55b3d78469f
|