diff --git a/README.md b/README.md index 70a85a0..96febce 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,26 @@ This aims to control a Libratone Zipp speaker within [Home Assistant](https://www.home-assistant.io/) using [this Python library](https://github.com/Chouffy/python_libratone_zipp). -Prerequisites: - -* the [python-libratone-zipp](https://pypi.org/project/python-libratone-zipp/) library -* you may need to forward `3333/udp` and `7778/udp` - ## Usage ### Installation via [HACS](https://hacs.xyz/) -1. Either - * HACS installation: add `https://github.com/Chouffy/home_assistant_libratone_zipp` as a custom repository with *integration* type - * Manual installation: Copy `/custom_components/*` in your `/config/custom_components/` directory of Home Assistant. +1. Add this repository `https://github.com/Chouffy/home_assistant_libratone_zipp` as a custom repository with *integration* type 1. Click *Install* 1. Add the following in your `/config/configuration.yaml`: ```yaml media_player: - - platform: libratone_zipp - host: 192.168.X.X - name: "Zipp" + - platform: libratone_zipp + host: 192.168.XX.XX + name: Zipp + scan_interval: 2 ``` - * You can also add `scan_interval: 2` below `name` if you want higher refresh rate + * I suggest `scan_interval: 2` to get 2 seconds refresh rate 1. Restart the server +1. You need to forward `3333/udp` and `7778/udp` if you're using Docker/devcontainer ## Features @@ -85,10 +80,14 @@ Other functionalities: This work is based on the following: -* The Libratone command list is [coming from this work from Benjamin Hanke](https://www.loxwiki.eu/display/LOX/Libratone+Zipp+WLan+Lautsprecher) +* The first Libratone command list is [coming from this work from Benjamin Hanke](https://www.loxwiki.eu/display/LOX/Libratone+Zipp+WLan+Lautsprecher) * Entity to use: [Media Player](https://developers.home-assistant.io/docs/core/entity/media-player) * Example of [integrations](https://www.home-assistant.io/integrations/#media-player): * Simple: [Harman Kardon AVR integration](https://www.home-assistant.io/integrations/harman_kardon_avr/) which use [this module](https://github.com/Devqon/hkavr) * Simple: [Clementine Music Player integration](https://github.com/home-assistant/core/blob/dev/homeassistant/components/clementine/media_player.py) which use [this module]() * Async: [Frontier Silicon integration](https://github.com/home-assistant/core/tree/dev/homeassistant/components/frontier_silicon) with [this module](https://github.com/zhelev/python-afsapi/tree/master/afsapi) * Async with extended features: [Yamaha integration](https://github.com/home-assistant/core/blob/dev/homeassistant/components/yamaha/) with [this module](https://github.com/wuub/rxv) + +## License + +See LICENSE file.