Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Broadcastify Monitor for Home Assistant

A Home Assistant custom integration for monitoring Broadcastify feeds using the Broadcastify Feed Owner API.

Broadcastify Monitor logo

Broadcastify Monitor provides feed status, listener statistics, configurable outage confirmation, manual status checks, and purpose-built Home Assistant dashboard cards.

Features

  • Monitor one or more Broadcastify feeds
  • Feed connected/disconnected status
  • Listener count
  • Feed bitrate
  • Manual feed status refresh
  • Timestamp of the most recent successful feed check
  • Configurable polling interval
  • Configurable outage confirmation
  • Distinguishes a confirmed feed outage from a Broadcastify API failure
  • UI-based configuration
  • Built-in Home Assistant dashboard cards
  • Visual dashboard card editor
  • Automatic dashboard resource registration

Dashboard Cards

Broadcastify Monitor includes a custom Home Assistant dashboard card with three layouts.

The card is automatically registered when the integration is installed. No manual JavaScript resource configuration is required.

Full

Displays the feed name, connection status, listener count, bitrate, time of the most recent check, and a manual refresh button.

Broadcastify full card

Status

A compact card showing the feed name and current connection status.

Broadcastify status card

Listeners

A compact card showing the feed's current listener count.

Broadcastify listeners card

Cards can be added using Home Assistant's normal Add Card interface and configured using the included visual editor.

Requirements

This integration uses the Broadcastify Feed Owner API and requires a Broadcastify account that owns the feeds being monitored.

You will need:

  • Broadcastify username
  • Broadcastify password
  • Broadcastify feed ID(s)

Installation

HACS

  1. Open HACS.
  2. Add this repository as a custom repository.
  3. Select Integration as the repository type.
  4. Install Broadcastify.
  5. Restart Home Assistant.
  6. Go to Settings → Devices & services → Add Integration.
  7. Search for Broadcastify.

Configuration

During setup, enter your Broadcastify username, password, and one or more feed IDs.

Multiple feed IDs should be separated by commas.

A feed ID can be found in the URL of the Broadcastify feed. For example:

https://www.broadcastify.com/listen/feed/47776

The feed ID in this example is 47776.

After setup, select Configure on the Broadcastify integration to change:

  • Feed IDs
  • Polling interval
  • Confirmation checks
  • Confirmation interval

Outage Confirmation

Broadcastify can occasionally report a feed offline for a single check even though the stream is healthy.

The integration can perform additional confirmation checks before changing the feed status to disconnected.

For example:

  • Polling interval: 300 seconds
  • Confirmation checks: 2
  • Confirmation interval: 30 seconds

If the normal poll reports the feed offline, the integration waits 30 seconds and checks again. If the feed is still offline, it waits another 30 seconds and performs a final check.

Only after all three checks report the feed offline will the Home Assistant feed status change to disconnected.

If any confirmation check reports the feed online, no outage is reported.

Setting Confirmation checks to 0 disables confirmation and reports the feed disconnected after the first offline response.

API Failures vs. Feed Outages

Broadcastify Monitor distinguishes between a feed being offline and being unable to contact the Broadcastify API.

If the API successfully reports that a feed is offline, the configured outage confirmation process is used.

If the Broadcastify API cannot be reached, a request times out, or another communication error occurs, the integration becomes unavailable rather than reporting the feed as disconnected.

This distinction is particularly useful when the feed status is used for automated recovery. A Broadcastify API outage should not cause Home Assistant to incorrectly assume that the scanner or streaming equipment has failed.

When a disconnected feed comes back online, the connected state is accepted immediately without additional confirmation checks.

Entities

Each Broadcastify feed is represented as a Home Assistant device with:

  • Feed status — connectivity binary sensor indicating whether the feed is connected or disconnected
  • Listeners — current listener count
  • Bitrate — current feed bitrate
  • Refresh — immediately checks the feed using the Broadcastify API

The Feed status entity also includes the time of the most recent successful API check.

The Refresh button can be pressed manually or from an automation. Refreshing one feed only checks that feed and does not force an update of other configured feeds.

Automations

The Feed status binary sensor can be used to trigger automations after a feed outage has been confirmed.

For example, a recovery automation could:

  1. Trigger when the feed changes from connected to disconnected.
  2. Send a notification.
  3. Restart or power-cycle the scanner or streaming equipment.
  4. Wait for the equipment to restart.
  5. Press the feed's Refresh button.
  6. Check whether the feed has returned online.

Because outage confirmation is handled by Broadcastify Monitor, automations do not need to implement their own repeated Broadcastify status checks.

Screenshots

Screenshots used by this README are stored in:

docs/images/

Expected files:

  • card-full.png
  • card-status.png
  • card-listeners.png

Development

Release Checklist

Before creating a release:

  1. Verify the integration loads successfully in the Home Assistant development environment.
  2. Verify the Broadcastify dashboard card loads and the visual editor works.
  3. Check the repository for temporary/test version strings or other development changes.
  4. Create a new PR/change to the final staging branch and update the version in manifest.json to the release version.
  5. Commit the release and create a matching Git tag (for example, v0.1.3).

Disclaimer

This is an unofficial integration and is not affiliated with or endorsed by Broadcastify.

Broadcastify and related names and trademarks are the property of their respective owners.

About

HomeAssistant HACS plugin for Broadcastify feed owners to monitor their feeds

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages