diff --git a/README.md b/README.md index a4f1b10..0d0cf32 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,42 @@ -# ha-hdhomerun +# HA-HDHomeRun + [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) -Custom component to enable [HDHomeRun](https://www.silicondust.com/hdhomerun/) integration for Home Assistant. +A custom component to view status of [HDHomeRun](https://www.silicondust.com/hdhomerun/) devices from Home Assistant. + +## Installation + +This component requires the [libhdhomerun](https://github.com/Silicondust/libhdhomerun) library to function. + +### Manual Dependency Installation + +Some distros have a prebuilt package available, such as Ubuntu: + +```bash +apt install libhdhomerun4 +``` + +Or Alpine Linux (i.e. Home Assistant docker): + +```bash +apk add libhdhomerun +``` + +Other systems may require building the library from source. + +### Docker Container + +To install the dependency in the HAss docker container, you'll need to connect to the CLI of your container. +This can be done by running `docker exec -it homeassistant /bin/sh` from an SSH session on your host. +Once in, run `apk install libhdhomerun` and then `exit` to disconnect. +Note that this will need periodic reinstallation following big updates. + +## Configuration -See overview and configuration information [here](info.md). +```yml +hdhomerun: + # Host addresses are optional, if none are specified then entities will be populated by network discovery. + sensor: + - host: 192.168.1.10 + - host: 192.168.1.5 +``` diff --git a/custom_components/hdhomerun/__init__.py b/custom_components/hdhomerun/__init__.py index d05ff04..f69215f 100644 --- a/custom_components/hdhomerun/__init__.py +++ b/custom_components/hdhomerun/__init__.py @@ -1,5 +1,4 @@ """The HDHomeRun component.""" -__version__ = '0.0.6' import voluptuous as vol import homeassistant.helpers.config_validation as cv diff --git a/custom_components/hdhomerun/manifest.json b/custom_components/hdhomerun/manifest.json index 5acdf4d..b8ec196 100644 --- a/custom_components/hdhomerun/manifest.json +++ b/custom_components/hdhomerun/manifest.json @@ -2,8 +2,10 @@ "domain": "hdhomerun", "name": "HDHomeRun", "config_flow": true, - "documentation": "https://github.com/burnnat/ha-hdhomerun", + "documentation": "https://github.com/berserkir-wolf/ha-hdhomerun", + "requirements": ["hdhr>=0.0.8"], "dependencies": [], "codeowners": [], - "requirements": ["hdhr==0.0.8"] + "version": "0.1.4", + "beta": false } diff --git a/hacs.json b/hacs.json index 26295ff..8f4ce6d 100644 --- a/hacs.json +++ b/hacs.json @@ -1,5 +1,5 @@ { - "name": "HDHomeRun", + "name": "HDHomeRun Tuners", "content_in_root": false, "domains": ["sensor"], "iot_class": "Local Polling" diff --git a/info.md b/info.md index d0f7c49..2aa5023 100644 --- a/info.md +++ b/info.md @@ -1,19 +1,31 @@ -## Overview -Custom component to view status of [HDHomeRun](https://www.silicondust.com/hdhomerun/) devices from Home Assistant. +# HA-HDHomeRun + +A custom component to view status of [HDHomeRun](https://www.silicondust.com/hdhomerun/) devices from Home Assistant. ## Installation -This component requires the [libhdhomerun](https://github.com/Silicondust/libhdhomerun) library to function. Some distros may have a prebuilt package available, such as Ubuntu: - apt install libhdhomerun4 +This component requires the [libhdhomerun](https://github.com/Silicondust/libhdhomerun) library to function. +See [ReadMe](https://github.com/Berserkir-Wolf/ha-hdhomerun/blob/master/README.md) for full instructions. + +### Manual Dependency Installation + +Some distros have a prebuilt package available, such as Ubuntu: + +```bash +apt install libhdhomerun4 +``` Or Alpine Linux (i.e. Home Assistant docker): - apk add libhdhomerun +```bash +apk add libhdhomerun +``` Other systems may require building the library from source. -## Configuration: -``` +## Configuration + +```yml hdhomerun: # Host addresses are optional, if none are specified then entities will be populated by network discovery. sensor: