KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

hass_hdhomerun

★ 52 Open GitHub ↗

Home Assistant integration for HDHomeRun

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub Release][badge_github_release_version]][github_release_link]
![GitHub Downloads (latest release)][badge_github_release_downloads]
[![GitHub Pre-release][badge_github_prerelease_version]][github_prerelease_link]
![GitHub Downloads (pre-release)][badge_github_prerelease_downloads]

# HDHomeRun

Home Assistant integration for the Silicondust HDHomeRun network tuners.

## Installation

The integration can be installed using HACS.  The integrations is not available
in the default repositories, so you will need to add the URL of this repository
as a custom repository to HACS (see here).

Alternatively you can use the button below.

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=uvjim&repository=hass_hdhomerun&category=Integration)

## Description

This integration can be used to get basic information on each HDHomeRun
device in the network. The integration can use the UDP broadcast discovery
protocol, the TCP control protocol and the HTTP API.

## Entities Provided

Where applicable the sub-items in the list detail the additional attributes
available. All entities may not be available to you depending on how the
device was discovered and what its capabilities are.

### Binary Sensors

| Location | Name | Enabled by default | Additional Information |
|---|---|:---:|---|
| Device | Channel Scanning | ✔️ | Percentage progress of the channel scan |

### Button

| Location | Name | Enabled by default | Comments |
|---|---|:---:|---|
| Device | Channel Scan | ✔️ | Requires the source to be selected first (see [here](#select)) |
| Device | Restart | ✔️ |  |

### Select

| Location | Name | Enabled by default | Comments |
|---|---|:---:|---|
| Device | Channel Sources | ✔️ | Selects the channel source to be used when carrying out a channel scan |

### Sensors

| Location | Name | Enabled by default | Primary value | Additional Information | Comments |
|---|---|:---:|---|---|---|
| Device | Channel Count | ✔️ | Number of channels currently tuned on the device | | |
| Device | Disabled Channels | ✔️ | Number of channels marked as disabled in the channel list | List of channel names | |
| Device | Favourite Channels | ✔️ | Number of channels marked as favorites in the channel list | List of channel names | |
| Device | Tuner Count | ✔️ | Number of tuners the device has | | |
| Tuner | Tuner X | ✔️ | Status of the tuner; `Idle`, `In use`, `Scanning` or the channel being watched | Frequency, signal strength, signal quality, symbol quality, network rate and target IP (as applicable) | X is the tuner number. |
| Tuner | Frequency | ✔️ | | | |
| Tuner | Network Rate | ✔️ | | | |
| Tuner | Signal Quality | ✔️ | | | |
| Tuner | Symbol Strength | ✔️ | | | |
| Tuner | Target IP | ✔️ | | |  |

### Update

| Location | Name | Enabled by default | Comments |
|---|---|:---:|---|
| Device | Firmware | ✔️ | |

# Setup

## `Add Integration` button

If adding the integration by clicking the `Add Integration` button the
following information will be requested.

![Initial Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/step_user.png)

* `Host`: The IP of an HDHomeRun device on the network. Leave
  blank to carry out discovery.

* If you provide a valid IP address, and you will be prompted for
    a friendly name.

![Initial Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/friendly_name.png)

### HTTP/UDP Discovery

This section is only applicable if you did not provide a host in the
[Add Integration](#add-integration-button) section.

![HTTP/UDP Discovery](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/http_udp_discovery.png)

Click `NEXT` and you will be prompted for a friendly name.

![Initial Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/friendly_name.png)

### Setup Complete

On successful set up the following screen will be seen detailing the device.

![Final Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/setup_finish.png)

## SSDP Discovery

The integration can also detect the HDHomeRun devices on the network using
SSDP. When found they will look like this on your devices screen.

![Initial Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/ssdp_discovery.png)

Clicking `CONFIGURE` you will be prompted for a friendly name.

![Initial Setup Screen](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/friendly_name.png)

## Configurable Options

It is possible to configure the following options for the integration.

### Timeouts

![Configure Options](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/config_timeouts.png)

* `Scan Interval`: the frequency of updates for the sensors, default `300s`
* `Tuner status update`: the frequency of updates for tuners, default `10s`

### Options

![Configure Options](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/config_options.png)

* `Channel logo path` - the path to a directory containing channel logos,
  e.g. `/local/channel_logos`. The default is to have no logo. If previously
  set, you can clear this option by just entering a space

You can also select which format should be used for the sensor. The
default is `Channel name`.

_This setting is only effective when a tuner is actively tuned to a channel._

## Troubleshooting

### Debug Logging

Debug logging can be enabled in Home Assistant using the [`logger`
integration](https://www.home-assistant.io/integrations/logger/).

```yaml
logger:
  default: warning
  logs:
    custom_components.hdhomerun: debug
```

### Diagnostics Integration

Starting with Home Assistant 2022.2, a new diagnostics integration can be
used to provide troubleshooting for integrations.

The highlighted area in the image below shows where the link for downloading
diagnostics can be found.

![Diagnostics](https://raw.githubusercontent.com/uvjim/hass_hdhomerun/main/images/diagnostics.png)

An [example output](examples/diagnostics_output.json) can be found in this repo.

[badge_github_release_version]: https://img.shields.io/github/v/release/uvjim/hass_hdhomerun?display_name=release&style=for-the-badge&logoSize=auto
[badge_github_release_downloads]: https://img.shields.io/github/downloads/uvjim/hass_hdhomerun/latest/total?style=for-the-badge&label=downloads%40release
[badge_github_prerelease_version]: https://img.shields.io/github/v/release/uvjim/hass_hdhomerun?include_prereleases&display_name=release&style=for-the-badge&logoSize=auto&label=pre-release
[badge_github_prerelease_downloads]: https://img.shields.io/github/downloads-pre/uvjim/hass_hdhomerun/latest/total?style=for-the-badge&label=downloads%40pre-release
[github_release_link]: https://github.com/uvjim/hass_hdhomerun/releases/latest
[github_prerelease_link]: https://github.com/uvjim/hass_hdhomerun/releases

hass_hdhomerun

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README