Metadata-Version: 2.4
Name: telekinesis-synapse
Version: 0.2.2
Summary: Official Telekinesis SDK for controlling and communication with industrial robot manipulators and tools.
Author-Email: Telekinesis <support@telekinesis.ai>
License-Expression: LicenseRef-Proprietary
License-File: LICENSE.txt
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Project-URL: Homepage, https://telekinesis.ai
Project-URL: Documentation, https://docs.telekinesis.ai
Requires-Python: <3.13,>=3.11
Requires-Dist: typing_extensions>=4.0.0
Requires-Dist: pybind11>=2.13.6
Requires-Dist: scikit-build-core>=0.10
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: loguru
Requires-Dist: pymodbus==2.5.3
Provides-Extra: dev
Requires-Dist: ruff==0.15.8; extra == "dev"
Requires-Dist: pylint==4.0.5; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: ninja>=1.5; extra == "dev"
Provides-Extra: dev-macos
Requires-Dist: ruff==0.15.8; extra == "dev-macos"
Requires-Dist: pylint==4.0.5; extra == "dev-macos"
Requires-Dist: build; extra == "dev-macos"
Requires-Dist: twine; extra == "dev-macos"
Requires-Dist: ninja>=1.5; extra == "dev-macos"
Requires-Dist: delocate; extra == "dev-macos"
Provides-Extra: dev-linux
Requires-Dist: ruff==0.15.8; extra == "dev-linux"
Requires-Dist: pylint==4.0.5; extra == "dev-linux"
Requires-Dist: build; extra == "dev-linux"
Requires-Dist: twine; extra == "dev-linux"
Requires-Dist: ninja>=1.5; extra == "dev-linux"
Requires-Dist: auditwheel; extra == "dev-linux"
Provides-Extra: dev-windows
Requires-Dist: ruff==0.15.8; extra == "dev-windows"
Requires-Dist: pylint==4.0.5; extra == "dev-windows"
Requires-Dist: build; extra == "dev-windows"
Requires-Dist: twine; extra == "dev-windows"
Requires-Dist: ninja>=1.5; extra == "dev-windows"
Requires-Dist: delvewheel; extra == "dev-windows"
Provides-Extra: docs
Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
Requires-Dist: mkdocstrings[python]<1,>=0.25; extra == "docs"
Requires-Dist: mkdocs-awesome-pages-plugin<3,>=2; extra == "docs"
Requires-Dist: mkdocs-multirepo-plugin<0.9.0,>=0.7.0; extra == "docs"
Description-Content-Type: text/markdown

<div align="center">
  <p>
    <a align="center" href="" target="_blank">
      <img
        width="100%"
        src="https://telekinesis-public-assets.s3.us-east-1.amazonaws.com/Telekinesis+Banner.png"
      >
    </a>
  </p>

  <br>

[Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples) | [Documentation](https://docs.telekinesis.ai)
<br>

[![PyPI version](https://img.shields.io/pypi/v/telekinesis-synapse)](https://pypi.org/project/telekinesis-synapse/)
[![License](https://img.shields.io/pypi/l/telekinesis-synapse)](https://pypi.org/project/telekinesis-synapse/)
[![Python versions](https://img.shields.io/pypi/pyversions/telekinesis-synapse)](https://pypi.org/project/telekinesis-synapse/)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue)](https://pypi.org/project/telekinesis-synapse/)

</div>

<p align="center">
  <a href="https://github.com/telekinesis-ai">GitHub</a>
  &nbsp;•&nbsp;
  <a href="https://www.linkedin.com/company/telekinesis-ai/">LinkedIn</a>
  &nbsp;•&nbsp;
  <a href="https://x.com/telekinesis_ai">X</a>
  &nbsp;•&nbsp;
  <a href="https://discord.gg/7NnQ3bQHqm">Discord</a>
</p>

# Telekinesis Synapse

**Telekinesis Synapse** is a python package for controlling and communication with industrial robot manipulators and tools. It provides a unified API across multiple robot and tool brands.

## Installation

Telekinesis Synapse depends on `telekinesis-urdfs` for robot model data, which must be installed first. Follow the steps below to install both packages.

1. Create and activate a Conda environment:

   ```bash
   conda create -n telekinesis-synapse python=3.11
   conda activate telekinesis-synapse
   ```
2. Install `telekinesis-urdfs` (robot model data):

   ```bash
   cd /path/to/working/directory
   git clone --depth 1 https://github.com/telekinesis-ai/telekinesis-urdfs.git
   cd telekinesis-urdfs
   pip install .
   ```

   > **Note:** `telekinesis-urdfs` is a large repository containing robot model data. The initial clone and wheel build are expected to take several minutes — do not interrupt the process.

3. Install Telekinesis Synapse:

   ```bash
   pip install telekinesis-synapse
   ```

## Getting Started

```python
from telekinesis.synapse.robots.manipulators import universal_robots

robot = universal_robots.UniversalRobotsUR10E()
print("Robot created successfully!")
```

To connect to a real robot, pass its IP address and enable remote control on the
teach pendant:

```python
robot.connect("192.168.1.100")

joint_positions = robot.get_joint_positions()
print("Joint positions:", joint_positions)
```

To disconnect:
```python
robot.disconnect()
```

## Example Usage for real robot and real tool

For all real robot and tools examples, ensure:

1. The robot/tool is powered on and connected to the same network as your machine.
   - Ethernet cable is securely connected to both robot/tool and network switch.
   - PC network IP is on the same subnet as the robot/tool (e.g., robot/tool at `192.168.1.100`, PC in `192.168.1.0/24`).
   - Verify connectivity: `ping 192.168.1.100`
2. The robot's/tool's IP address is correctly set in the example script.
3. For robot, remote control is enabled on the teach pendant.

More examples soon will be available in the [Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples) repository.

## Resources

- **Examples** — Runnable examples for every supported robot and skill will soon be available on: [Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples)
- **Documentation** — Full SDK reference: [Telekinesis Documentation](https://docs.telekinesis.ai)

## Support

For issues and questions:

- Create an [issue](https://github.com/telekinesis-ai/telekinesis-examples/issues) in the GitHub repository.
- Contact the Telekinesis development team at support@telekinesis.ai or on [Discord](https://discord.com/invite/7NnQ3bQHqm).

## License

Proprietary — © Telekinesis. All rights reserved.
