sortion/BirdNET-stream
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
BirdNET powered soundscape analysis for bird song identification
58 Commits 2 Branches 0 Tags 573 KiB
PHP 31.9%
Shell 29.9%
Twig 14.1%
JavaScript 8.2%
CSS 6.3%
Other 9.6%
39233fe937
Go to file
Samuel ORTION 39233fe937 install: Fix merge
2022-08-24 08:03:26 +02:00
.github/ISSUE_TEMPLATE Update issue templates 2022-08-14 09:10:53 +02:00
.ideas Update install.sh 2022-08-21 06:13:15 +02:00
analyzer@cb3707813f Switch submodule git address to http 2022-08-20 05:49:42 +02:00
config install: Fix several bugs 2022-08-21 08:17:16 +02:00
daemon install: Adding loginctl enable-linger for user recording using pulseaudio 2022-08-22 05:48:45 +02:00
docker docker: Symfony seems to be running (still mysql issues) 2022-08-23 17:15:40 +02:00
docs docker: Symfony seems to be running (still mysql issues) 2022-08-23 17:15:40 +02:00
media Generate favicon 2022-08-14 08:10:53 +02:00
utils Update install.sh 2022-08-21 06:13:15 +02:00
www www: Add try catch to avoid exception on missing database 2022-08-24 07:23:47 +02:00
.dockerignore docker: Working on mysql database and symfony dependencies 2022-08-23 13:25:10 +02:00
.env.example docker: Working on mysql database and symfony dependencies 2022-08-23 13:25:10 +02:00
.gitignore Remove instance specific .env file 2022-08-23 05:06:17 +02:00
.gitmodules Switch submodule git address to http 2022-08-20 05:49:42 +02:00
CHANGELOG.md docs: Updated CHANGELOG and README for better installation méthod 2022-08-24 08:01:52 +02:00
CONTRIBUTING.md Trying to port BirdNET-stream to Docker 2022-08-20 05:22:07 +02:00
docker-compose.yml docker: Symfony seems to be running (still mysql issues) 2022-08-23 17:15:40 +02:00
INSTALL.md install: Adding loginctl enable-linger for user recording using pulseaudio 2022-08-22 05:48:45 +02:00
install.sh install: Fix merge 2022-08-24 08:03:26 +02:00
LICENSE Initial commit 2022-08-12 17:57:54 +02:00
README.md docs: Updated CHANGELOG and README for better installation méthod 2022-08-24 08:01:52 +02:00
requirements.txt Add plotter and fix miner 2022-08-16 05:21:53 +02:00
TODO docker: Working database creation 2022-08-23 06:06:18 +02:00
uninstall.sh Spliiting to far may not be the solution 2022-08-22 06:22:30 +02:00

README.md

BirdNET-stream

Realtime BirdNET powered soundscape analysis for bird song identification.

BirdNET-stream logo image IA generated

Introduction

BirdNET-stream records sound 24/7 on any Linux computer with a microphone and analyze it using BirdNET algorithm by @kahst.

Bird contacts are stored in a database and are made accessible in a webapp.

Features

  • 24/7 recording and BirdNET-Analyzer analysis of sound
  • Live audio streaming and live spectrogram visualization from web browser
  • Bird contacts saved into a SQL database
  • Web Interface for system monitoring, data analysis and visualization

Requirements

BirdNET-stream aims to be able to run on any 64-bit Linux computer. It has been tested on Fedora and Debian.

It should work on a Raspberry Pi (or other Single Board Computer) with a USB microphone or Sound Card (not tested yet).

Installation

Warning

BirdNET-stream is in early development, and may not work properly...

On debian based systems (tested on Debian Bullseye), the following command should allow you to install the base components without too much trouble:

# Change to your installation directory here, /home/$USER/Documents/BirdNET-stream for instance, or /opt/birdnet-stream, or whatever
cd /path/to/installation/directory
# Download installation script 
curl -0 https://raw.githubusercontent.com/UncleSamulus/BirdNET-stream/main/install.sh
# Run installation script:
chmod +x ./install.sh
./install.sh

I recommend to add DEBUG=1 before this command to see the installation steps:

DEBUG=1 ./install.sh

To install from a specific git branch, add BRANCH=<branch> before the command, for instance:

BRANCH=dev DEBUG=1 ./install.sh

For finer control, or to adapt to your system, you can follow the instructions in the INSTALL.md file (it may unfortunatly not be accurate for your system).

Usage

  • BirdNET-stream web application can be accessed on any web browser at https://birdnet.home, from your local network, or at any other hostname you set in nginx configuration, if your public IP is accessible from the internet.

  • See the species detected

Acknoledgments

  • BirdNET on which this project relies
  • BirdNET-Pi the great inspiration of this project

License

BirdNET-stream is licensed under the GNU General Public License v3.0, see ./LICENSE for more details.