diff --git a/zzz_draft_birdnet-pi/CHANGELOG.md b/zzz_draft_birdnet-pi/CHANGELOG.md new file mode 100644 index 000000000..c1191d36e --- /dev/null +++ b/zzz_draft_birdnet-pi/CHANGELOG.md @@ -0,0 +1,5 @@ +- Feat : Allow to define the /clips folder +- Feat : Allow mounting of SMB and local drives + +## 0.5.1 (22-04-2024) +- Initial build diff --git a/zzz_draft_birdnet-pi/Dockerfile b/zzz_draft_birdnet-pi/Dockerfile new file mode 100644 index 000000000..bd06a49b5 --- /dev/null +++ b/zzz_draft_birdnet-pi/Dockerfile @@ -0,0 +1,124 @@ +#============================# +# ALEXBELGIUM'S DOCKERFILE # +#============================# +# _.------. +# _.-` ('>.-`"""-. +# '.--'` _'` _ .--.) +# -' '-.-';` ` +# ' - _.' ``'--. +# '---` .-'""` +# /` +#=== Home Assistant Addon ===# + +################# +# 1 Build Image # +################# + +ARG BUILD_VERSION +ARG BUILD_FROM +FROM ${BUILD_FROM} +SHELL ["/bin/bash", "-o", "pipefail", "-c"] + +ENV DEBIAN_FRONTEND noninteractive +ENV HOME="/config" +RUN sudo apt-get update -y && sudo apt-get install gcc python3-dev -y +#RUN curl -s https://raw.githubusercontent.com/olipayne/BirdNET-Pi/main/newinstaller.sh | bash +RUN curl -s https://raw.githubusercontent.com/Nachtzuster/BirdNET-Pi/main/newinstaller.sh && \ + sed -i "/sudo reboot/d" newinstaller.sh && \ + bash newinstaller.sh + +################## +# 2 Modify Image # +################## + +# Set S6 wait time +ENV S6_CMD_WAIT_FOR_SERVICES=1 \ + S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 \ + S6_SERVICES_GRACETIME=0 + +################## +# 3 Install apps # +################## + +# Add rootfs +COPY rootfs/ / + +# Uses /bin for compatibility purposes +# hadolint ignore=DL4005 +RUN if [ ! -f /bin/sh ] && [ -f /usr/bin/sh ]; then ln -s /usr/bin/sh /bin/sh; fi && \ + if [ ! -f /bin/bash ] && [ -f /usr/bin/bash ]; then ln -s /usr/bin/bash /bin/bash; fi + +# Modules +ARG MODULES="00-local_mounts.sh 00-smb_mounts.sh" + +# Automatic modules download +ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_automodules.sh" "/ha_automodules.sh" +RUN chmod 744 /ha_automodules.sh && /ha_automodules.sh "$MODULES" && rm /ha_automodules.sh + +# Manual apps +ENV PACKAGES="alsa-utils libasound2-plugins nginx" + +# Automatic apps & bashio +ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_autoapps.sh" "/ha_autoapps.sh" +RUN chmod 744 /ha_autoapps.sh && /ha_autoapps.sh "$PACKAGES" && rm /ha_autoapps.sh + +################ +# 4 Entrypoint # +################ + +# Add entrypoint +ENV S6_STAGE2_HOOK=/ha_entrypoint.sh +ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint.sh" "/ha_entrypoint.sh" + +# Entrypoint modifications +ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint_modif.sh" "/ha_entrypoint_modif.sh" +RUN chmod 777 /ha_entrypoint.sh /ha_entrypoint_modif.sh && /ha_entrypoint_modif.sh && rm /ha_entrypoint_modif.sh + +# Avoid config.yaml interference +RUN sed -i "s|config.yaml|config_env.yaml|g" /etc/cont-init.d/01-config_yaml.sh +ENTRYPOINT [ "/usr/bin/env" ] +CMD [ "/ha_entrypoint.sh" ] +SHELL ["/bin/bash", "-o", "pipefail", "-c"] + +############ +# 5 Labels # +############ + +ARG BUILD_ARCH +ARG BUILD_DATE +ARG BUILD_DESCRIPTION +ARG BUILD_NAME +ARG BUILD_REF +ARG BUILD_REPOSITORY +ARG BUILD_VERSION +LABEL \ + io.hass.name="${BUILD_NAME}" \ + io.hass.description="${BUILD_DESCRIPTION}" \ + io.hass.arch="${BUILD_ARCH}" \ + io.hass.type="addon" \ + io.hass.version=${BUILD_VERSION} \ + maintainer="alexbelgium (https://github.com/alexbelgium)" \ + org.opencontainers.image.title="${BUILD_NAME}" \ + org.opencontainers.image.description="${BUILD_DESCRIPTION}" \ + org.opencontainers.image.vendor="Home Assistant Add-ons" \ + org.opencontainers.image.authors="alexbelgium (https://github.com/alexbelgium)" \ + org.opencontainers.image.licenses="MIT" \ + org.opencontainers.image.url="https://github.com/alexbelgium" \ + org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \ + org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \ + org.opencontainers.image.created=${BUILD_DATE} \ + org.opencontainers.image.revision=${BUILD_REF} \ + org.opencontainers.image.version=${BUILD_VERSION} + +################# +# 6 Healthcheck # +################# + +ENV HEALTH_PORT="80" \ + HEALTH_URL="" +HEALTHCHECK \ + --interval=5s \ + --retries=5 \ + --start-period=30s \ + --timeout=25s \ + CMD curl --fail "http://127.0.0.1:${HEALTH_PORT}${HEALTH_URL}" &>/dev/null || exit 1 diff --git a/zzz_draft_birdnet-pi/README.md b/zzz_draft_birdnet-pi/README.md new file mode 100644 index 000000000..70bb29f94 --- /dev/null +++ b/zzz_draft_birdnet-pi/README.md @@ -0,0 +1,81 @@ +# Home assistant add-on: birdnet-pi + +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) + +![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json) +![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json) +![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json) + +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) +[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) +[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white + +_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) + +![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/birdnet-pi/stats.png) + +## About + +--- + +[birdnet-pi](https://github.com/tphakala/birdnet-pi/tree/main) is an AI solution for continuous avian monitoring and identification developed by @tphakala + +This addon is based on their docker image. + +## Configuration + +Install, then start the addon a first time +Webui can be found at . + +You'll need a microphone : either use one connected to HA or the audio stream of a rstp camera. + +Options can be configured through three ways : + +- Addon options + +```yaml +ALSA_CARD : number of the card (0 or 1 usually), see https://github.com/tphakala/birdnet-pi/blob/main/doc/installation.md#deciding-alsa_card-value +TZ: Etc/UTC specify a timezone to use, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List +COMMAND : realtime --rtsp url # allows to provide arguments to birdnet-pi +``` + +- Config.yaml +Additional variables can be configured using the config.yaml file found in /config/db21ed7f_birdnet-pi/config.yaml using the Filebrowser addon + +- Config_env.yaml +Additional environment variables can be configured there + +## Installation + +--- + +The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. + +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) + [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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. Click the `Save` button to store your configuration. +1. Set the add-on options to your preferences +1. Start the add-on. +1. Check the logs of the add-on to see if everything went well. +1. Open the webUI and adapt the software options + +## Integration with HA + +Not yet available + +## Common issues + +Not yet available + +## Support + +Create an issue on github + +--- + +![illustration](https://raw.githubusercontent.com/tphakala/birdnet-pi/main/doc/birdnet-pi-dashboard.webp) diff --git a/zzz_draft_birdnet-pi/apparmor.txt b/zzz_draft_birdnet-pi/apparmor.txt new file mode 100644 index 000000000..8fcd2487c --- /dev/null +++ b/zzz_draft_birdnet-pi/apparmor.txt @@ -0,0 +1,66 @@ +#include + +profile birdnet-pi_addon flags=(attach_disconnected,mediate_deleted) { + #include + + capability, + file, + signal, + mount, + umount, + remount, + network udp, + network tcp, + network dgram, + network stream, + network inet, + network inet6, + network netlink raw, + network unix dgram, + + capability setgid, + capability setuid, + capability sys_admin, + capability dac_read_search, + # capability dac_override, + # capability sys_rawio, + +# S6-Overlay + /init ix, + /run/{s6,s6-rc*,service}/** ix, + /package/** ix, + /command/** ix, + /run/{,**} rwk, + /dev/tty rw, + /bin/** ix, + /usr/bin/** ix, + /usr/lib/bashio/** ix, + /etc/s6/** rix, + /run/s6/** rix, + /etc/services.d/** rwix, + /etc/cont-init.d/** rwix, + /etc/cont-finish.d/** rwix, + /init rix, + /var/run/** mrwkl, + /var/run/ mrwkl, + /dev/i2c-1 mrwkl, + # Files required + /dev/fuse mrwkl, + /dev/sda1 mrwkl, + /dev/sdb1 mrwkl, + /dev/nvme0 mrwkl, + /dev/nvme1 mrwkl, + /dev/mmcblk0p1 mrwkl, + /dev/* mrwkl, + /tmp/** mrkwl, + + # Data access + /data/** rw, + + # suppress ptrace denials when using 'docker ps' or using 'ps' inside a container + ptrace (trace,read) peer=docker-default, + + # docker daemon confinement requires explict allow rule for signal + signal (receive) set=(kill,term) peer=/usr/bin/docker, + +} diff --git a/zzz_draft_birdnet-pi/build.yaml b/zzz_draft_birdnet-pi/build.yaml new file mode 100644 index 000000000..a7f1c36c3 --- /dev/null +++ b/zzz_draft_birdnet-pi/build.yaml @@ -0,0 +1,6 @@ +--- +build_from: + aarch64: ghcr.io/hassio-addons/debian-base/aarch64:7.3.3 + amd64: ghcr.io/hassio-addons/debian-base/amd64:7.3.3 +codenotary: + signer: alexandrep.github@gmail.com diff --git a/zzz_draft_birdnet-pi/config.json b/zzz_draft_birdnet-pi/config.json new file mode 100644 index 000000000..f6209108d --- /dev/null +++ b/zzz_draft_birdnet-pi/config.json @@ -0,0 +1,94 @@ +{ + "arch": [ + "aarch64", + "amd64" + ], + "audio": true, + "codenotary": "alexandrep.github@gmail.com", + "devices": [ + "/dev/dri", + "/dev/dri/card0", + "/dev/dri/card1", + "/dev/dri/renderD128", + "/dev/vchiq", + "/dev/video10", + "/dev/video11", + "/dev/video12", + "/dev/video13", + "/dev/video14", + "/dev/video15", + "/dev/video16", + "/dev/ttyUSB0", + "/dev/sda", + "/dev/sdb", + "/dev/sdc", + "/dev/sdd", + "/dev/sde", + "/dev/sdf", + "/dev/sdg", + "/dev/nvme", + "/dev/nvme0n1p1", + "/dev/nvme0n1p2", + "/dev/mmcblk", + "/dev/fuse", + "/dev/sda1", + "/dev/sdb1", + "/dev/sdc1", + "/dev/sdd1", + "/dev/sde1", + "/dev/sdf1", + "/dev/sdg1", + "/dev/sda2", + "/dev/sdb2", + "/dev/sdc2", + "/dev/sdd2", + "/dev/sde2", + "/dev/sdf2", + "/dev/sdg2", + "/dev/sda3", + "/dev/sdb3", + "/dev/sda4", + "/dev/sdb4", + "/dev/sda5", + "/dev/sda6", + "/dev/sda7", + "/dev/sda8", + "/dev/nvme0", + "/dev/nvme1", + "/dev/nvme2" + ], + "description": "Realtime BirdNET soundscape analyzer", + "environment": { + }, + "image": "ghcr.io/alexbelgium/birdnet-pi-{arch}", + "init": false, + "map": [ + "addon_config:rw", + "media:rw", + "share:rw" + ], + "name": "zzz Do not use", + "options": { + "COMMAND": "realtime" + }, + "panel_icon": "mdi:bird", + "ports": { + "80/tcp": 80 + }, + "ports_description": { + "80/tcp": "web ui" + }, + "schema": { + "ALSA_CARD": "int?", + "COMMAND": "str", + "TZ": "str?", + "cifsdomain": "str?", + "cifspassword": "str?", + "cifsusername": "str?", + "localdisks": "str?", + "networkdisks": "str?" + }, + "slug": "birdnet-pi", + "url": "https://github.com/alexbelgium/hassio-addons/tree/master/birdnet-pi", + "version": "0.1" +} diff --git a/zzz_draft_birdnet-pi/icon.png b/zzz_draft_birdnet-pi/icon.png new file mode 100644 index 000000000..7e056b6ff Binary files /dev/null and b/zzz_draft_birdnet-pi/icon.png differ diff --git a/zzz_draft_birdnet-pi/logo.png b/zzz_draft_birdnet-pi/logo.png new file mode 100644 index 000000000..7e056b6ff Binary files /dev/null and b/zzz_draft_birdnet-pi/logo.png differ diff --git a/zzz_draft_birdnet-pi/rootfs/etc/cont-init.d/99-run.sh b/zzz_draft_birdnet-pi/rootfs/etc/cont-init.d/99-run.sh new file mode 100644 index 000000000..d6adc367e --- /dev/null +++ b/zzz_draft_birdnet-pi/rootfs/etc/cont-init.d/99-run.sh @@ -0,0 +1,25 @@ +#!/command/with-contenv bashio +# shellcheck shell=bash +set -e + +################# +# INITALISATION # +################# + +bashio::log.info "ALSA_CARD option is set to $(bashio::config "ALSA_CARD"). If the microphone doesn't work, please adapt it" +echo " " + +######################## +# CONFIGURE birdnet-pi # +######################## + +bashio::log.info "Starting app..." +COMMAND="$(bashio::config "COMMAND")" +# shellcheck disable=SC2086 +/usr/bin/birdnet-pi $COMMAND & true + +# Wait for app to become available to start nginx +bashio::net.wait_for 8080 localhost 900 +bashio::log.info "Starting NGinx..." +exec nginx + diff --git a/zzz_draft_birdnet-pi/stats.png b/zzz_draft_birdnet-pi/stats.png new file mode 100644 index 000000000..203519791 Binary files /dev/null and b/zzz_draft_birdnet-pi/stats.png differ