Metadata-Version: 2.1
Name: aioswitcher
Version: 2.0.1
Summary: Switcher Unofficial Integration.
Home-page: https://pypi.org/project/aioswitcher/
License: Apache-2.0
Keywords: home,automation,switcher,smart
Author: Tomer Figenblat
Author-email: tomer.figenblat@gmail.com
Requires-Python: >=3.8.0,<4.0.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Provides-Extra: docs
Requires-Dist: insegel (==1.1.0); extra == "docs"
Requires-Dist: sphinx (==4.0.2); extra == "docs"
Requires-Dist: sphinxcontrib-autoprogram (==0.1.7); extra == "docs"
Requires-Dist: sphinxcontrib-spelling (==7.2.1); extra == "docs"
Requires-Dist: toml (==0.10.1); extra == "docs"
Project-URL: Documentation, https://aioswitcher.tomfi.info
Project-URL: Repository, https://github.com/tomerfi/aioswitcher
Description-Content-Type: text/markdown

<!-- markdownlint-disable MD013 -->
# Switcher Unofficial Integration</br>[![pypi-version]][11] [![pypi-downloads]][11] [![license-badge]][4]
<!-- markdownlint-enable MD013 -->

[![gh-build-status]][7] [![read-the-docs]][8] [![codecov]][3]

PyPi module named [aioswitcher][11] for integrating with the [Switcher Devices](https://www.switcher.co.il/).</br>
Please check out the [documentation][8].

## Install

```shell
pip install aioswitcher
```

## Usage Example

Please check out the [documentation][8] for the full usage section.

```python
async with SwitcherApi(device_ip, device_id) as api:
    # get the device state
    state_response = await swapi.get_state()

    # control the device on for 15 minutes and then turn it off
    await api.control_device(Command.ON, 15)
    await api.control_device(Command.OFF)
```

## Command Line Helper Scripts

- [discover_devices.py](scripts/discover_devices.py) can be used to discover devices
  and their states.
- [control_device.py](scripts/control_device.py) can be used to control a device.

## Contributing

The contributing guidelines are [here](.github/CONTRIBUTING.md)

## Code of Conduct

The code of conduct is [here](.github/CODE_OF_CONDUCT.md)

<!-- Real Links -->
[2]: https://github.com/TomerFi/aioswitcher/releases
[3]: https://codecov.io/gh/TomerFi/aioswitcher
[4]: https://github.com/TomerFi/aioswitcher
[7]: https://github.com/TomerFi/aioswitcher/actions/workflows/pre_release.yml
[8]: https://aioswitcher.tomfi.info/
[11]: https://pypi.org/project/aioswitcher
<!-- Badges Links -->
[codecov]: https://codecov.io/gh/TomerFi/aioswitcher/graph/badge.svg
[gh-build-status]: https://github.com/TomerFi/aioswitcher/actions/workflows/pre_release.yml/badge.svg
[license-badge]: https://img.shields.io/github/license/tomerfi/aioswitcher
[pypi-downloads]: https://img.shields.io/pypi/dm/aioswitcher.svg?logo=pypi&color=1082C2
[pypi-version]: https://img.shields.io/pypi/v/aioswitcher?logo=pypi
[read-the-docs]: https://readthedocs.org/projects/aioswitcher/badge/?version=stable

