-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
Adds documentation for new integration BirdNET-Go #47934
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TN-1
wants to merge
8
commits into
home-assistant:next
Choose a base branch
from
TN-1:birdnet_go
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8e979dc
Add BirdNET-Go integration documentation
TN-1 743c24e
Update docs:
TN-1 7960438
Update docs
TN-1 0ab1457
Update docs
TN-1 8572c0a
Implement review feedback
TN-1 60a02a4
Update docs
TN-1 671c439
Apply batched suggestions from code review
TN-1 9090d0a
Add conditions to birdnet_go integration
TN-1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| title: BirdNET-Go | ||
| description: Instructions on how to integrate BirdNET-Go with Home Assistant. | ||
| ha_category: | ||
| - Sensor | ||
| ha_release: 2026.10 | ||
| ha_iot_class: Local Polling | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@TN-1' | ||
| ha_domain: birdnet_go | ||
| ha_platforms: | ||
| - sensor | ||
| ha_integration_type: service | ||
| ha_quality_scale: bronze | ||
| works_with: | ||
| - local | ||
| --- | ||
|
|
||
| The **BirdNET-Go** {% term integration %} allows you to monitor bird detections and headline statistics from your local [BirdNET-Go](https://github.com/tphakala/birdnet-go) station. | ||
|
|
||
| BirdNET-Go is an acoustic monitoring system that identifies bird species in real time from audio streams using AI classifier models. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| This integration connects to BirdNET-Go version 2.0 or newer and requires the `/api/v2/dashboard/kpis` endpoint. Ensure your BirdNET-Go station is running with the V2 database manager and has completed any pending database migrations. | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| {% configuration_basic %} | ||
| Host: | ||
| description: "The IP address or hostname of the BirdNET-Go station." | ||
| Port: | ||
| description: "The port BirdNET-Go is running on (default: 8080)." | ||
| Use SSL: | ||
| description: "Whether to connect using HTTPS." | ||
| {% endconfiguration_basic %} | ||
|
|
||
| ## Supported functionality | ||
|
|
||
| ### Sensors | ||
|
|
||
| This integration provides the following sensors for your BirdNET-Go station: | ||
|
|
||
| - **Today's detections**: Total number of bird vocalizations identified today. | ||
| - **Lifetime species**: Cumulative count of distinct bird species recorded by the station. | ||
| - **Detection streak**: Current streak of consecutive days with at least one bird detection. | ||
| - **Best day detections (past year)**: Highest single-day record for bird detections within the past year. | ||
|
|
||
| ## BirdNET-Go automation examples | ||
|
|
||
| Here are a few automation examples to get you started. | ||
|
|
||
| {% include docs/paste_yaml_tip.md %} | ||
|
|
||
| ### Automation: Notification when a new bird species is detected | ||
|
|
||
| Send a notification whenever your BirdNET-Go station records a new bird species. | ||
|
|
||
| {% details "Example YAML configuration" %} | ||
|
|
||
| {% example %} | ||
| automation: | | ||
| alias: "Notify when a new bird species is detected" | ||
| description: "Send a notification when the lifetime species counter increases." | ||
| triggers: | ||
| - trigger: state | ||
| entity_id: sensor.birdnet_go_station_lifetime_species | ||
| conditions: | ||
| - condition: template | ||
| value_template: "{{ trigger.to_state.state | int(0) > trigger.from_state.state | int(0) }}" | ||
|
TN-1 marked this conversation as resolved.
Outdated
|
||
| actions: | ||
|
TN-1 marked this conversation as resolved.
|
||
| - action: notify.persistent_notification | ||
| data: | ||
| title: "New bird species identified" | ||
| message: "A new bird species was recorded! Total lifetime species: {{ trigger.to_state.state }}." | ||
| {% endexample %} | ||
|
|
||
| {% enddetails %} | ||
|
|
||
| ### Automation: Notification when reaching a detection streak milestone | ||
|
|
||
| Send a notification when your BirdNET-Go station reaches a 7-day detection streak. | ||
|
|
||
| {% details "Example YAML configuration" %} | ||
|
|
||
| {% example %} | ||
| automation: | | ||
| alias: "Notify on 7-day detection streak" | ||
| description: "Send a notification when the detection streak reaches 7 consecutive days." | ||
| triggers: | ||
| - trigger: numeric_state | ||
| entity_id: sensor.birdnet_go_station_detection_streak | ||
| above: 6 | ||
| actions: | ||
| - action: notify.persistent_notification | ||
| data: | ||
| title: "BirdNET-Go streak milestone" | ||
| message: "Your BirdNET-Go station has reached a 7-day bird detection streak!" | ||
| {% endexample %} | ||
|
|
||
| {% enddetails %} | ||
|
|
||
| ## Data updates | ||
|
|
||
| The integration {% term polling polls %} the BirdNET-Go station every 30 seconds for updated dashboard statistics. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. No extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.