Metadata-Version: 2.1
Name: servodoor-app
Version: 0.1.1
Summary: A simple GUI for controlling upto 18 (RC servo) t-maze doors.
Home-page: https://github.com/willdickson/servodoor-app
License: MIT
Author: Will Dickson
Author-email: wbd@caltech.edu
Requires-Python: >=3.10,<3.12
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: adafruit-ampy (>=1.1.0,<2.0.0)
Requires-Dist: pyserial (>=3.5,<4.0)
Requires-Dist: pyside6 (>=6.5.2,<7.0.0)
Requires-Dist: servodoor (>=0.1,<0.2)
Project-URL: Repository, https://github.com/willdickson/servodoor-app
Description-Content-Type: text/markdown

# Servodoor-app: RC servo based door control application  

A simple GUI for controlling up to 18 (RC servo) doors. Designed for use
with an automated T-Maze system. 

## Installing
Install using pip 

```bash
$ pip install servodoor-app 
```

## Installing from source

This package uses the [poetry](https://python-poetry.org/) dependency manager.
The installation instructions for poetry can be found
[here](https://python-poetry.org/docs/#installation)

Once poetry is installed the serovodoor-app package can be installed using

```bash
$ poetry install
```
Additional documentation on using poetry can be found
[here](https://python-poetry.org/docs/)

## GUI images

![connect_tab](images/connect_tab.png)

![control_tab](images/control_tab.png)

![config_tab](images/config_tab.png)

![config_dialog](images/config_dialog.png)


Example door configuration file.
```json
{
    "front" : { 
        "servo"   : 1, 
        "open"    : 1375, 
        "close"   : 1987,
        "max_vel" : 40000.0,
        "max_acc" : 40000.0 
    }, 
    "left" : { 
        "servo" : 2,   
        "open"  : 1340, 
        "close" : 1947, 
        "max_vel" : 40000.0,
        "max_acc" : 40000.0 
    }, 
    "right" : { 
        "servo" : 3, 
        "open"  : 1300, 
        "close" : 1890,
        "max_vel" : 40000.0,
        "max_acc" : 40000.0 
    },
    "sleep_front" : { 
        "servo" : 4, 
        "open"  : 1300, 
        "close" : 1890,
        "max_vel" : 7000.0,
        "max_acc" : 2000.0 
    },
    "sleep_back" : { 
        "servo" : 5, 
        "open"  : 1300, 
        "close" : 1890,
        "max_vel" : 7000.0,
        "max_acc" : 2000.0 
    }
}
```


