Metadata-Version: 2.2
Name: youless_api
Version: 2.2.0
Summary: A bridge for python to the YouLess sensor
Home-page: https://github.com/gjong/youless-python-bridge
Author: G. Jongerius
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: summary

# YouLess Python Data Bridge
[![PyPI version](https://badge.fury.io/py/youless-api.svg)](https://badge.fury.io/py/youless-api)
![Python package](https://github.com/gjong/youless-python-bridge/actions/workflows/python-package.yml/badge.svg?branch=master)

This package contains support classes to fetch data from the YouLess sensors. The current implementation
supports the following YouLess devices:

* LS120, both the Enologic and the PVOutput firmware
* LS110

Experimental support for authentication was added in v0.15 of the youless-python-bridge.

## Getting started

To use the API use the following code:

```python
from youless_api.youless_api import YoulessAPI

if __name__ == '__main__':
    api = YoulessAPI("192.168.1.2")  # use the ip address of the YouLess device
    api.initialize()
    api.update()

    # from this point on on you should be able to access the sensors through the YouLess bridge
    gasUsage = api.gas_meter.value
```

To use authentication please use the snippet below (this is still experimental):

```python
from youless_api.youless_api import YoulessAPI

if __name__ == '__main__':
    api = YoulessAPI("192.168.1.2", "my-user-name", "my-password")  # use the ip address of the YouLess device
    api.initialize()
    api.update()

    # from this point on on you should be able to access the sensors through the YouLess bridge
    gasUsage = api.gas_meter.value
```

## Contributing

The Youless Python Data Bridge is an open-source project and welcomes any additions by the community.

If you would like to contribute, please fork this repository and make your desired changes.
You can then offer those changes using a pull request into this repository.

### The contributors :star2:

[![Contributors](https://contrib.rocks/image?repo=gjong/youless-python-bridge)](https://github.com/gjong/youless-python-bridge/graphs/contributors)