Skip to main content

A API to communicate with a KEBA PLC via WebSockets

Project description

KeApi

Documentation Status Publish 📦 to PyPI PyPI version

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keapi_robotics-1.0.0.tar.gz (9.0 kB view hashes)

Uploaded Source

Built Distribution

keapi_robotics-1.0.0-py3-none-any.whl (9.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page