Metadata-Version: 2.1
Name: windfreak
Version: 0.3.0
Summary: Python package for Windfreak Technologies devices.
Home-page: https://github.com/christian-hahn/windfreak-python
Author: Christian Hahn
Author-email: christianhahn09@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown

# windfreak-python [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/christian-hahn/windfreak-python/blob/master/LICENSE)

## Abstract

**windfreak** is a pure Python package to facilitate the use of [Windfreak Technologies](https://windfreaktech.com) devices.

**windfreak** requires Python 3.

**windfreak** is MIT licensed.

## Supported devices

* SynthHD v1.4
* SynthHD PRO v1.4
* SynthHD v2
* SynthHD PRO v2

## Installation

Using `pip`:
```text
pip install windfreak
```

Using `setup.py`:
```text
git clone https://github.com/christian-hahn/windfreak-python.git
cd windfreak-python
python setup.py install
```

## Example

### SynthHD

```python
from windfreak import SynthHD

synth = SynthHD('/dev/ttyACM0')
synth.init()

# Set channel 0 power and frequency
synth[0].power = -10.
synth[0].frequency = 2.e9

# Enable channel 0
synth[0].enable = True
```

## License
windfreak-python is covered under the MIT licensed.


