Metadata-Version: 2.1
Name: vzug-api
Version: 0.0.9
Summary: Unofficial python API for V-ZUG devices
Home-page: https://github.com/mico-micic/vzug-api
Author: Mićo Mićić
Author-email: mico@micic.ch
License: GNU General Public License v3.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Home Automation
Description-Content-Type: text/markdown
License-File: LICENSE

# V-ZUG API Library

**Unofficial** python API library for V-ZUG devices. This module provides an API for communication with V-ZUG devices in a local network. Communication with the central V-ZUG services (V-ZUG-Home) is not supported.

## Implemented functions

* Any V-ZUG device with network support:
  * Get basic status information.
  * Support username / password authentication.

* Washing machines:
  * Get power and water consumption data.
  * Get extended information for running program incl. optiDos status. 

## Limitations and Warning
Since I have only one V-ZUG machine (AdoraWash V4000), the library is not tested with other devices.

## How to use
Check [examples (github.com)](https://github.com/mico-micic/vzug-api/tree/main/examples) directory for implementations.

