mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-03-12 16:10:41 +01:00
8a0f15413c
Add the "Add repository to my Home Assistant" blue button to all addon README files that were missing it. This makes it easier for new HA users to add the repository with a single click. Updated 59 addon READMEs: - 51 with standard Installation section format - 8 with non-standard or missing Installation sections Co-authored-by: alexbelgium <44178713+alexbelgium@users.noreply.github.com>
60 lines
3.1 KiB
Markdown
60 lines
3.1 KiB
Markdown
# Home assistant add-on: BirdNET-PiPy
|
|
|
|
BirdNET-PiPy is a self-hosted system that uses the BirdNET deep-learning model to identify birds from their sounds, with a modern web dashboard for monitoring detections. This add-on packages the upstream project for Home Assistant with ingress support.
|
|
|
|
## About
|
|
|
|
- Upstream project: https://github.com/Suncuss/BirdNET-PiPy
|
|
- This add-on runs the BirdNET-PiPy backend services, Icecast audio stream, and Vue.js frontend in a single container.
|
|
|
|
## Installation
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
|
|
## Configuration
|
|
|
|
Install, then start the add-on a first time. Open the Web UI from Home Assistant (Ingress) or directly at `http://<host>:8011` (or the port you configure).
|
|
Configure location, audio source, and other settings in the BirdNET-PiPy UI after the container starts.
|
|
|
|
Options can be configured through three ways:
|
|
|
|
- Add-on options
|
|
|
|
```yaml
|
|
TZ: Etc/UTC # Timezone, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
|
|
ICECAST_PASSWORD: "" # Optional: set a persistent password for the audio stream
|
|
STREAM_BITRATE: 320k # Bitrate for the mp3 stream
|
|
RECORDING_MODE: rtsp # pulseaudio | http_stream | rtsp
|
|
RTSP_URL: "" # Required if RECORDING_MODE is rtsp
|
|
data_location: /config/data # Persistent data location for BirdNET-PiPy
|
|
```
|
|
|
|
- Config.yaml
|
|
Additional variables can be configured using the config.yaml file found in `/config/birdnet-pipy/config.yaml` using the Filebrowser add-on.
|
|
|
|
- Config_env.yaml
|
|
Additional environment variables can be configured there.
|
|
|
|
### Mounting Drives
|
|
|
|
This add-on supports mounting both local drives and remote SMB shares:
|
|
|
|
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
|
|
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
|
|
|
|
### Custom Scripts and Environment Variables
|
|
|
|
This add-on supports custom scripts and environment variables through the `addon_config` mapping:
|
|
|
|
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
|
- **env_vars option**: Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
## Notes
|
|
|
|
- Audio input uses Home Assistant's PulseAudio server by default.
|
|
- Ingress is enabled; direct access is available on the configured port.
|