Joren/dispatcharr_sensor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Lyfesaver
2025-10-03 15:50:39 -05:00
committed by GitHub
parent f800140643
commit 340edda655
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -6,34 +6,34 @@ This is a custom integration for Home Assistant that monitors active streams fro
- Provides a sensor showing the total number of active streams (`sensor.total_active_streams`). - Provides a sensor showing the total number of active streams (`sensor.total_active_streams`).
- Dynamically creates a unique sensor for each active stream, which is automatically removed when the stream stops. - Dynamically creates a unique sensor for each active stream, which is automatically removed when the stream stops.
- Pulls detailed Electronic Program Guide (EPG) information for each active stream, including: - Pulls detailed program guide (EPG) information for each active stream, including program/episode titles and numbers.
- Program Title - Displays stream-specific details like resolution, codecs, and client count.
- Episode Title (Subtitle) - Includes an option to disable EPG fetching to reduce server load.
- Episode Number
- Description
- Start and End times
- Displays stream-specific details like client count, resolution, codecs, and bitrate as sensor attributes.
## Installation and Configuration ## Installation and Configuration
### Installation ### Initial Setup
1. Copy the `dispatcharr_sensor` directory into your Home Assistant `<config>/custom_components/` directory. 1. Copy the `dispatcharr_sensor` directory into your Home Assistant `<config>/custom_components/` directory.
2. Restart Home Assistant. 2. Restart Home Assistant.
3. Go to **Settings** > **Devices & Services** > **Add Integration**.
### Configuration 4. Search for "Dispatcharr" and select it.
5. In the configuration dialog, enter the following information:
Configuration is done via the UI.
1. Go to **Settings** > **Devices & Services**.
2. Click the **Add Integration** button in the bottom right.
3. Search for "Dispatcharr" and select it.
4. In the configuration dialog, enter the required information:
- **Host:** The IP address of your Dispatcharr server (e.g., `192.168.0.121`). - **Host:** The IP address of your Dispatcharr server (e.g., `192.168.0.121`).
- **Port:** The port your Dispatcharr server is running on (e.g., `9191`). - **Port:** The port your Dispatcharr server is running on (e.g., `9191`).
- **Username:** Your Dispatcharr username. - **Username:** Your Dispatcharr username.
- **Password:** Your Dispatcharr password. - **Password:** Your Dispatcharr password.
### Optional Settings
To reduce the load on your Dispatcharr server, especially on systems with limited resources, you can disable the fetching of detailed EPG (program guide) data. When disabled, sensors for active streams will still be created, but program-related attributes (`program_title`, `episode_title`, etc.) will not be populated.
To change this setting:
1. Navigate to **Settings** > **Devices & Services**.
2. Find your Dispatcharr integration and click **Configure**.
3. A dialog box will appear. Uncheck the box labeled **"Enable EPG Program Data"** to disable it.
4. Click **Submit**.
## Sensors Provided ## Sensors Provided
### Total Active Streams Sensor ### Total Active Streams Sensor
@@ -83,4 +83,4 @@ content: |
*** ***
{% else %} {% else %}
No active streams. No active streams.
{% endfor %} {% endif %}