Added an example to the README

This commit is contained in:
Julian Müller (ChaoticByte) 2023-07-21 22:46:13 +02:00
parent 66541220bf
commit 70ed602814

View file

@ -1,6 +1,6 @@
# YaHue Lib # YaHue Lib
Yet Another Philips Hue API Library for Python. This project only implements a subset of the API. Yet Another Philips Hue API Library for Python. This project only implements home subset of the API.
## Getting Started ## Getting Started
@ -29,3 +29,23 @@ See https://developers.meethue.com/develop/get-started-2/
## Documentation ## Documentation
see [DOCUMENTATION.md](DOCUMENTATION.md) see [DOCUMENTATION.md](DOCUMENTATION.md)
## Example
```python
#!/usr/bin/env python3
from yahuelib.controller import LightController, GroupController
from yahuelib.utils import rgb_to_hsv
if __name__ == "__main__":
home = GroupController.from_name("Home", "192.168.0.120", "XXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXX")
if not home.all_on:
home.all_on = True
color = rgb_to_hsv(255, 220, 100)
home.hue = color[0]
home.saturation = color[1]
home.brightness = 1.0
home.alert()
```