Skip to content

Adds documentation for new integration BirdNET-Go - #47934

Open
TN-1 wants to merge 8 commits into
home-assistant:nextfrom
TN-1:birdnet_go
Open

Adds documentation for new integration BirdNET-Go#47934
TN-1 wants to merge 8 commits into
home-assistant:nextfrom
TN-1:birdnet_go

Conversation

@TN-1

@TN-1 TN-1 commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Proposed change

Adds documentation for new integration BirdNET-Go

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@home-assistant home-assistant Bot added has-parent This PR has a parent PR in another repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Sep 6, 2026
@home-assistant

home-assistant Bot commented Sep 6, 2026

Copy link
Copy Markdown

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@netlify

netlify Bot commented Sep 6, 2026

Copy link
Copy Markdown

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 9090d0a
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6a9db637276e5400089d6d71
😎 Deploy Preview https://deploy-preview-47934--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@home-assistant home-assistant Bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Sep 6, 2026
@TN-1
TN-1 marked this pull request as ready for review September 6, 2026 14:24
Copilot AI lite review requested due to automatic review settings September 6, 2026 14:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The added integration page follows existing Home Assistant integration doc structure and includes the key setup, entity, update, and removal details.

Pull request overview

Adds a new integration documentation page for the BirdNET-Go integration, describing setup via config flow and the sensors it provides.

Changes:

  • Added a new integration page with front matter (domain, platforms, iot class, quality scale, release).
  • Documented config flow fields (host/port/SSL/auth) using config_flow and configuration_basic.
  • Documented provided sensors, polling interval, and standard removal steps.
File summaries
File Description
source/_integrations/birdnet_go.markdown New documentation page covering configuration, sensors, polling cadence, and removal for the BirdNET-Go integration.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The integration page is missing the required “BirdNET-Go automation examples” section expected by the current integration documentation template.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

source/_integrations/birdnet_go.markdown:52

  • The integration documentation template expects an automation examples section ("## BirdNET-Go automation examples") before Data updates, with example headings starting with "### Automation:". Adding this section helps readers understand practical ways to use the provided sensors in automations.
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The added automation YAML examples include a template that can error and hard-coded entity IDs that likely won’t match reader installations.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

source/_integrations/birdnet_go.markdown:94

  • This entity ID is unlikely to match a reader’s installation because BirdNET-Go entities are named from the config entry title/device name. Use a placeholder entity ID so readers know they must select their own entity.
    - trigger: numeric_state
      entity_id: sensor.birdnet_go_station_detection_streak
      above: 6
  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Lite

Comment thread source/_integrations/birdnet_go.markdown Outdated
Comment thread source/_integrations/birdnet_go.markdown
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

One of the included automation YAML examples is invalid due to a condition being placed under triggers: instead of conditions:.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

source/_integrations/birdnet_go.markdown:80

  • This message: line is long for an example block and is hard to read; using a folded scalar keeps the YAML within typical line-length rules and makes the template clearer.
        title: "New bird species identified"
        message: "A new bird species was recorded! Total lifetime species: {{ trigger.to_state.state }}."
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread source/_integrations/birdnet_go.markdown
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

has-parent This PR has a parent PR in another repo in-progress This PR/Issue is currently being worked on new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants