Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.83 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.83 KB

YouLess Python Data Bridge

PyPI version Python package

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:

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):

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 🌟

Contributors