Metadata-Version: 2.1
Name: skydance
Version: 1.0.0
Summary: A library for communication with Skydance Wi-Fi relays.
Home-page: https://pypi.org/project/skydance
License: MIT
Author: Tomas Bedrich
Author-email: ja@tbedrich.cz
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Hardware
Classifier: Topic :: System :: Networking
Project-URL: Documentation, https://skydance.readthedocs.io
Project-URL: Repository, https://github.com/tomasbedrich/skydance
Description-Content-Type: text/markdown

# Overview

A library for communication with Skydance Wi-Fi relays.

[![Build Status](https://img.shields.io/travis/tomasbedrich/skydance.svg)](https://travis-ci.org/tomasbedrich/skydance)
[![Coverage Status](https://img.shields.io/coveralls/tomasbedrich/skydance.svg)](https://coveralls.io/r/tomasbedrich/skydance)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/tomasbedrich/skydance.svg)](https://scrutinizer-ci.com/g/tomasbedrich/skydance)
[![PyPI Version](https://img.shields.io/pypi/v/skydance.svg)](https://pypi.org/project/skydance)
[![PyPI License](https://img.shields.io/pypi/l/skydance.svg)](https://pypi.org/project/skydance)

The original product is [a Wi-Fi to RF gateway](http://www.iskydance.com/index.php?c=product_show&a=index&id=810) manufactured by Skydance Co. China.

Sometimes, it is re-branded under different names. For example, in the Czech Republic, [it is sold](https://www.t-led.cz/p/ovladac-wifi-dimled-69381) as "dimLED" system.

This aim of this library is to roughly cover capabilities of [the official SkySmart Android application](https://play.google.com/store/apps/details?id=com.lxit.wifirelay&hl=cs&gl=US).

# Setup

## Requirements

* Python 3.8+

## Installation

```text
$ pip install skydance
```

# Usage

The protocol implementation is [Sans I/O](https://sans-io.readthedocs.io/).
You must create the connection and send the byte payloads on your own.
There are some helpers in `skydance.network` built on top of Python's asyncio which helps you to wrap the I/O.

TODO - In meantime, please see `test/test_manual.py`.

# Links
- [Home Assistant reverse engineering forum thread](https://community.home-assistant.io/t/skydance-2-4g-rf/99399)

