Adding BirdWeather integration to allow for PUC data processing

kahst commented 2 months ago

          I'm very interested in the dedicated integration with BirdWeather as it's something I've been considering implementing myself.  Has any progress been made on this? Did you have any thoughts on how this should be implemented? Would you accept a pull request?

Originally posted by @PeteLawrence in https://github.com/kahst/BirdNET-Analyzer/issues/69#issuecomment-1616685218

kahst commented 2 months ago

Is this something we could implement? Meaning, if people have a BirdWeather ID, can they upload detection results to BirdWeather after analyzing the files from PUC SD cards.

What do people think would be the best way of doing this?

Josef-Haupt commented 2 months ago

Yes this could work. we add a flag to upload results to birdweather automatically and people save their BirdWeather ID in dot environment for example.

tphakala commented 2 months ago

There are few considerations for BirdWeather integration:

Integration is based on soundscapes, which is a wav file uploaded to BirdWeather API.
- BirdNET analyzer would need to extract some length clip from analyzed file for submission, uploading hours long recordings would be pointless I think and could also pose a privacy risk.
API submissions require start time and end time for each soundscape and time of actual detection, this has to be evaluated from recordings, I don't know if PUC recordings contain timestamp in a filename of in some external metadata
BirdWeather API documentation is incomplete, it does not contain request needed to submit detections
- When I added BirdWeather integration to BirdNET-Go I reverse engineered API requests from BirdNET-Pi code. I notified Tim about documentation lacking some key requests but seems that they have ignored it.

timsterc commented 1 month ago

As I'd love to see this work - I'm happy to offer whatever level of support is needed.

kahst commented 1 month ago

Thanks Tim, can you please take a look at the missing API doc? We probably also want some kind of filter to reduce the number of submissions to AWS S3, right?

timsterc commented 1 week ago

API docs have been updated as requested.

kahst / BirdNET-Analyzer

Adding BirdWeather integration to allow for PUC data processing #324