avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-29 16:07:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2412 from alexbelgium/codex/align-birdnet-pipy-documentation-options

Browse Source 
Document add-on options and configuration for BirdNET-PiPy
This commit is contained in:
Alexandre
2026-01-29 11:43:39 +01:00
committed by GitHub
parent dcc30aaa8f 732827b191
commit 5d3632a147
2 changed files with 41 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
birdnet-pipy/DOCS.md
View File

@@ -12,6 +12,17 @@
- **Ingress:** Use the Home Assistant sidebar entry.
- **Direct:** `http://<host>:8099`
## 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
```
## Audio
The add-on expects audio via PulseAudio (default) or an RTSP stream configured in the BirdNET-PiPy settings.

32
birdnet-pipy/README.md
View File

@@ -9,13 +9,41 @@ BirdNET-PiPy is a self-hosted system that uses the BirdNET deep-learning model t
## Configuration
Install, then start the add-on a first time. Open the Web UI from Home Assistant (Ingress) or directly at `http://<host>:8099`.
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
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
```
After starting, open the add-on web UI. Use the BirdNET-PiPy settings page to configure location, audio source, and other options.
- 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