37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# Elite Skills Arena Equipment - Python SDK
|
|
|
|
[](https://pypi.org/project/your-sdk-package/)
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://www.python.org/)
|
|
|
|
Official Python SDK for interacting with Elite Skills Arena products. This library provides a high-level interface to configure, control, and monitor your hardware devices programmatically.
|
|
|
|
## Table of Contents
|
|
- [Installation](#installation)
|
|
- [Getting Started](#getting-started)
|
|
- [Documentation](#documentation)
|
|
- [Examples](#examples)
|
|
- [API Reference](#api-reference)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
- [Support](#support)
|
|
|
|
## Installation
|
|
Install the SDK using pip:
|
|
|
|
```bash
|
|
pip install -e .
|
|
```
|
|
|
|
#### how ?
|
|
* connection manager - control list of machine connections and states
|
|
* machines - a machine object representing an ESA machine
|
|
* commands - websocket commands sent to the machine
|
|
|
|
### why?
|
|
The current state of websocket commands requires careful execution and forethought.
|
|
We can make this easier by abstracting into an SDK.
|
|
|
|
* user class - user / player
|
|
* machine class - A machine and its connection. State is stored on machine.
|
|
* game class - A game instance, to be uploaded and played. |