BirdNET-Pi - My Complete System

[UlrichThiess]

Hi i want to publish my BirdNET configuration in HA to you all. Maybe you find something useful for you. Just ask or tell if you have any hints. And thank you all, you gave me many help for this.

---

1. BirdNET AddOn
2. BirdNET Settings
3. Template to process BirdNET MQTT messages
4. Automation to create CSV-File to import in eBird
5. Automation to send CSV-File every night as eMail and delete it
6. Markdown Card to show todays BirdNET detections
7. Markdown Card to show all BirdNET detections
8. MiniGraphCard to show how many detections in time
9. Microphone Setup as RTSP Stream on a Raspberry Pi

---

1. BirdNET AddOn

I just installed the BirdNET AddOn as it is. I have not made any changes or set any parameters.

---

2. BirdNET Settings

Open BirdNET, goto Tools and Settings:

• Model: BirdNET_GLOBAL_6K_V2.4_Model_FP16
• Location: Enter Site Name, Latitude and Longitude
• BirdWeather: Enter BirdWeather ID
• Notifications:
  • Apprise Notifications Configuration: mailto://domain.tld?smtp=host.domain.tld&from=[email protected]&to=[email protected]
  • Notification Title: BirdNET-Pi: $comname zu $confidencepct%
  • Notification Body: $comname ($sciname) $flickrimage
  • Checked only: Notify each new infrequent species detection (<5 visits per week)
  • Minimum time between notifications of the same species (sec): 0
• Bird Photos from Flickr: Flickr API Key: Enter your key, follow: Get your free key here.
• Localization: Database Language: Choose you language
• Additional Info: Site to pull additional species info from: eBird.org
• Time and Date: Choose your timezone

Press: Update Settings ... wait ...
Press: Advanced Settings

Advanced Settings:

• Disk Management: Purge
• Autio Settings:
  • RTSP Stream: Enter your RTSP Streams (rtsp://192.168.0.126:8554/birdmic see: Microphone Setup as RTSP Stream on a RaspberryPI

Press: Update Settings ... wait ...

---

3. Template to process BirdNET MQTT messages

I wanted to see todays detections in one card and all detections in another card to see the mos common and the rarest. So i need two seperate entities sensor.birdnet and sensor.birdnet_arten. I also want a simple counter with informations of the last detection.

configurations.yaml

template: !include templates.yaml

templates.yaml

################################################################################
### BirdNET ####################################################################
################################################################################

- trigger:
    - platform: mqtt
      topic: birdnet
      id: mqtt
    - platform: time
      at: "00:00:00"
      id: reset
  sensor:
    - name: BirdNET
      unique_id: birdnet
      icon: mdi:bird
      attributes:
        birds: >
          {% if trigger.id == 'reset' %}
            {{ [] }}

          {% elif trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {% set timestamp = as_datetime(trigger.payload_json.Date ~ ' ' ~ trigger.payload_json.Time) | as_timestamp() %}
            {% set date = trigger.payload_json.Date %}
            {% set time = trigger.payload_json.Time %}
            {% set scientificName = trigger.payload_json.ScientificName %}
            {% set commonName = trigger.payload_json.CommonName %}
            {% set confidence = ( trigger.payload_json.Confidence * 100 ) | round(0) %}
            {% set speciesCode = trigger.payload_json.SpeciesCode %}
            {% set clipName = trigger.payload_json.ClipName %}
            {% set url = trigger.payload_json.url.replace('en.', 'de.') %}
            {% set flickrImage = trigger.payload_json.FlickrImage %}
            {% set source = clipName.split('-')[6] %}
            {% set source_map = {
              'RTSP_1': 'Süden',
              'RTSP_2': 'Kamera'
            } %}
            {% set source = source_map.get(source, source) %}
            {% set current_birds = this.attributes.get('birds', []) %}
            {% set new_bird = {
              'timestamp': timestamp,
              'date': date,
              'time': time,
              'scientificName': scientificName,
              'commonName': commonName,
              'confidence': confidence,
              'speciesCode': speciesCode,
              'clipName': clipName,
              'url': url,
              'flickrImage': flickrImage,
              'source': source
            } %}
            {{ current_birds + [new_bird] }}
          {% else %}
            {{ this.attributes.get('birds', []) }}
          {% endif %}
      state: >
        {% if trigger.id == 'reset' %}
          {{ 0 }}
        {% elif trigger.id == 'mqtt' and trigger.payload_json is defined %}
          {{ ( this.attributes.get('birds', []) | length ) +1 }}
        {% else %}
          {{ this.attributes.get('birds', []) | length }}
        {% endif %}
    - name: BirdNET Zähler
      unique_id: birdnet_zahler
      icon: mdi:counter
      state_class: total_increasing
      attributes:
        timestamp: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ as_datetime(trigger.payload_json.Date ~ ' ' ~ trigger.payload_json.Time) | as_timestamp() }}
          {% endif %}
        date: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.Date }}
          {% endif %}
        time: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.Time }}
          {% endif %}
        scientificName: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.ScientificName }}
          {% endif %}
        commonName: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.CommonName }}
          {% endif %}
        confidence: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ (trigger.payload_json.Confidence * 100) | round(0) }}
          {% endif %}
        speciesCode: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.SpeciesCode }}
          {% endif %}
        clipName: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.ClipName }}
          {% endif %}
        url: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.url.replace('en.', 'de.') }}
          {% endif %}
        flickrImage: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {{ trigger.payload_json.FlickrImage }}
          {% endif %}
        source: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {% set source = trigger.payload_json.ClipName.split('-')[6] %}
            {% set source_map = {
              'RTSP_1': 'Süden',
              'RTSP_2': 'Kamera'
            } %}
            {% set source = source_map.get(source, source) %}
            {{ source }}
          {% endif %}
      state: >
        {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
          {{ (this.state | int(0)) + 1 }}
        {% else %}
          {{ this.state | int(0) }}
        {% endif %}
    - name: BirdNET Arten
      unique_id: birdnet_arten
      icon: mdi:bird
      attributes:
        birds: >
          {% if trigger.id == 'mqtt' and trigger.payload_json is defined %}
            {% set timestamp = as_datetime(trigger.payload_json.Date ~ ' ' ~ trigger.payload_json.Time) | as_timestamp() %}
            {% set date = trigger.payload_json.Date %}
            {% set time = trigger.payload_json.Time %}
            {% set scientificName = trigger.payload_json.ScientificName %}
            {% set commonName = trigger.payload_json.CommonName %}
            {% set confidence = (trigger.payload_json.Confidence * 100 ) | round(0) %}
            {% set speciesCode = trigger.payload_json.SpeciesCode %}
            {% set clipName = trigger.payload_json.ClipName %}
            {% set url = trigger.payload_json.url.replace('en.', 'de.') %}
            {% set flickrImage = trigger.payload_json.FlickrImage %}
            {% set source = clipName.split('-')[6] %}
            {% set source_map = {
              'RTSP_1': 'Süden',
              'RTSP_2': 'Kamera'
            } %}
            {% set source = source_map.get(source, source) %}
            {% set current_birds = this.attributes.get('birds', []) %}
            {% set ns = namespace(new_birds=[], found=false) %}

            {% for bird in current_birds %}
              {% if bird.commonName == commonName %}
                {% set updated_bird = {
                  'timestamp': timestamp,
                  'date': date,
                  'time': time,
                  'scientificName': scientificName,
                  'commonName': commonName,
                  'confidence': max(bird.confidence | replace('%', '') | int, confidence),
                  'speciesCode': speciesCode,
                  'clipName': clipName,
                  'url': url,
                  'flickrImage': flickrImage,
                  'source': source,
                  'count': (bird.count + 1)
                } %}
                {% set ns.new_birds = ns.new_birds + [updated_bird] %}
                {% set ns.found = true %}
              {% else %}
                {% set ns.new_birds = ns.new_birds + [bird] %}
              {% endif %}
            {% endfor %}

            {% if not ns.found %}
              {% set updated_bird = {
                'timestamp': timestamp,
                'date': date,
                'time': time,
                'scientificName': scientificName,
                'commonName': commonName,
                'confidence': confidence,
                'speciesCode': speciesCode,
                'clipName': clipName,
                'url': url,
                'flickrImage': flickrImage,
                'source': source,
                'count': 1
              } %}
              {% set ns.new_birds = ns.new_birds + [updated_bird] %}
            {% endif %}

            {{ ns.new_birds }}
          {% else %}
            {{ this.attributes.get('birds', []) }}
          {% endif %}
      state: >
        {{ this.attributes.get('birds', []) | length }}

---

4. Automation to create CSV-File to import in eBird

To import the detections as observations into eBird, the are two automations: One to create a daily CSV-File, and antother to send the daily created CSV-File to an eMailaddress and delete it.

configuration.yaml

notify:
  - platform: smtp
    name: smtp
    sender: [email protected]
    recipient: []
    server: host.domain.tld
    port: 25
    encryption: starttls
    sender_name: Home Assistant
    debug: true
    verify_ssl: false

shell_command: !include shell_commands.yaml

shell_commands.yaml

birdnet_to_ebird: >
  bash -c '
  echo "{{ arg1 }},{{ arg2 }},{{ arg3 }},{{ arg4 }},{{ arg5 }},{{ arg6 }},{{ arg7 }},{{ arg8 }},{{ arg9 }},{{ arg10 }},{{ arg11 }},{{ arg12 }},{{ arg13 }},{{ arg14 }},{{ arg15 }},{{ arg16 }},{{ arg17 }},{{ arg18 }},{{ arg19 }}" >> /config/www/birdnet-to-ebird_{{ now().strftime("%Y-%m-%d") }}.csv
  '

BirdNET zu eBird CSV-Datei schreiben

alias: BirdNET zu eBird CSV-Datei schreiben
description: ""
trigger:
  - platform: mqtt
    topic: birdnet
condition: []
action:
  - action: shell_command.birdnet_to_ebird
    data:
      arg1: "{{ trigger.payload_json.CommonName | default('') }}"
      arg2: ""
      arg3: "{{ trigger.payload_json.ScientificName | default('') }}"
      arg4: ""
      arg5: ""
      arg6: yourCity
      arg7: "onlyYourLongutudeLike:12.1234"
      arg8: "onlyYourLatitudeLike:12.1234"
      arg9: >-
        {{ trigger.payload_json.Date | default('') | as_timestamp |
        timestamp_custom('%m/%d/%Y', true) }}
      arg10: "{{ trigger.payload_json.Time | default('') }}"
      arg11: 2byteStateCode
      arg12: 2byteCountryCode
      arg13: stationary
      arg14: "1"
      arg15: "1"
      arg16: "Y"
      arg17: ""
      arg18: ""
      arg19: ""
mode: single

BirdNET zu eBird CSV-Datei per E-Mail senden und löschen

alias: BirdNET zu eBird CSV-Datei per E-Mail senden und löschen
description: ""
trigger:
  - platform: time
    at: "01:00:00"
condition: []
action:
  - variables:
      filename: >-
        /config/www/birdnet-to-ebird_{{ (now() -
        timedelta(days=1)).strftime('%Y-%m-%d') }}.csv
  - data:
      title: BirdNET zu eBird
      target:
        - [email protected]
      message: >-
        BirdNET zu eBird


        Bitte die beigefügte CSV-Datei aus BirdNET vom {{ ( now() -
        timedelta(days=1)).strftime('%d.%m.%Y') }}

        bei eBird im "eBird Aufzeichnungsformat (erweitert)" hochladen.

        https://ebird.org/import/upload.form
      data:
        images:
          - "{{ filename }}"
        html: >
          <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html
          lang="en" xmlns="http://www.w3.org/1999/xhtml">
            <head>
              <meta charset="UTF-8">
              <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
              <meta name="viewport" content="width=device-width, initial-scale=1.0">
              <title>BirdNET zu eBird</title>
              <style type="text/css">
                h1,h2,h3,h4,h5,h6 {
                font-family: Arial, sans-serif;
                }
              </style>
            </head>
            <body>
              <h3>BirdNET zu eBird</h3>
              Bitte die beigefügte CSV-Datei aus <b>BirdNET</b> vom {{ ( now() - timedelta(days=1)).strftime('%d.%m.%Y') }}
              <br />
              bei <b>eBird</b> im <i>eBird Aufzeichnungsformat (erweitert)</i> hochladen.
              <br />
              https://ebird.org/import/upload.form
            </body>
          </html>
    action: notify.smtp
  - action: shell_command.rm
    data:
      filename: "{{ filename }}"
mode: single

---

6. Markdown Card to show todays BirdNET detections

type: markdown
content: >2
    {% if states('sensor.birdnet') != "unknown" and states('sensor.birdnet') | int(0) > 0 and state_attr('sensor.birdnet', 'birds') is not none %}

    {% set bird_species = state_attr('sensor.birdnet', 'birds') | sort(attribute='time', reverse=true) | map(attribute='commonName') | unique | list %}
    {% set bird_objects = state_attr('sensor.birdnet', 'birds') | sort(attribute='time', reverse=true) %}

    {% set ns = namespace(birds_data=[]) %}

    {% for bird_s in bird_species %}
      {% set bird_list = bird_objects | selectattr("commonName", "equalto", bird_s) | list %}
        {% if bird_list %}

          {% set bird_o = bird_list[0] %}
          {% set bird_o_count = bird_list | length %}
          {% set bird_o_max_confidence = bird_list | map(attribute='confidence') | map('replace', '%', '') | map('int') | max %}

          {% set bird_entry = {
            'time': bird_o.time,
            'source': (bird_o.source | default('?'))[:1],
            'commonName': bird_o.commonName,
            'speciesCode': bird_o.speciesCode,
            'url': bird_o.url,
            'count': bird_o_count,
            'max_confidence': bird_o_max_confidence
          } %}

        {% set ns.birds_data = ns.birds_data + [bird_entry] %}
      {% endif %}
    {% endfor %}

    {% set birds_sorted = ns.birds_data | sort(attribute='count', reverse=true) %}

  Zuletzt |    Art (eBird) | Wiki |    Anzahl |   
  Max.

  :-:|:-|:-:|-:|-:
    {%- for bird in birds_sorted %}
  {{ bird.time[:5] }} {{ bird.source }} |    [{{ bird.commonName
  }}](https://ebird.org/species/{{ bird.speciesCode }}) | [<ha-icon
  icon="mdi:open-in-new"></ha-icon>]({{ bird.url }}) | &nbsp;&nbsp; {{
  bird.count }} | &nbsp;&nbsp; {{ bird.max_confidence }}%

    {%- endfor %}

    #### {{ bird_objects | count }} Erkennungen<br /> {{ bird_species | count }} Arten

    {% else %}

    Noch keine Erkennung vorhanden.

    {% endif %}
card_mod:
  style:
    .: |
      ha-card {
        background: transparent;
        border: none;
        display: flex;
        justify-content: center;
        align-items: center;
        height: 100%;
        text-align: center;

---

7. Markdown Card to show all BirdNET detections

type: markdown
content: >
  {% if states('sensor.birdnet_arten') != "unknown" and
  state_attr('sensor.birdnet_arten', 'birds') is not none %}


  {% set birds = state_attr('sensor.birdnet_arten', 'birds') %}


  {% set grouped_birds = birds | groupby('count') %}


  {% set ns = namespace(total=0) %}


  Zuletzt |    Art (eBird) | Wiki |    Anzahl |   
  Max.

  :-:|:-|:-:|-:|-:


  {%- for group in grouped_birds | sort(attribute='grouper', reverse=true) -%}

    {%- set sorted_group = group.list | sort(attribute='timestamp', reverse=true) -%}

    {%- for bird in sorted_group %}
    {{ bird.timestamp | timestamp_custom('%d.%m.') }} {{ bird.time[:5] }} {{ bird.source[:1] }} | &nbsp;&nbsp; [{{ bird.commonName[:12] ~ ('.' if bird.commonName | length > 12 else '') }}](https://ebird.org/species/{{ bird.speciesCode }}) | [<ha-icon icon="mdi:open-in-new"></ha-icon>]({{ bird.url }}) | &nbsp;&nbsp; {{ bird.count }} | &nbsp;&nbsp; {{ bird.confidence | replace('%', '') | int }}%

      {%- set ns.total = ns.total + bird.count %}
    {%- endfor %}
  {%- endfor %}

  #### {{ ns.total }} Erkennungen<br /> {{ birds | count }} Arten

  {% else %}

  Noch keine Erkennung vorhanden.

  {% endif %}
card_mod:
  style:
    .: |
      ha-card {
        background: transparent;
        border: none;
        display: flex;
        justify-content: center;
        align-items: center;
        height: 100%;
        text-align: center;

---

8. MiniGraphCard to show how many detections in time

type: custom:mini-graph-card
name: BirdNET Erkennungen der letzten 7 Tage
group_by: date
aggregate_func: max
hours_to_show: 168
line_width: 2
hour24: true
show:
  graph: bar
  points: false
entities:
  - sensor.birdnet_anzahl_tag
card_mod:
  style: |
    ha-card {
      background: transparent;
      border: none;
      border-radius: 0;
    }

type: custom:mini-graph-card
name: BirdNET Erkennungen der letzten 30 Tage
group_by: date
aggregate_func: max
hours_to_show: 720
line_width: 2
hour24: true
show:
  graph: bar
  points: false
entities:
  - sensor.birdnet_anzahl_tag
card_mod:
  style: |
    ha-card {
      background: transparent;
      border: none;
      border-radius: 0;
    }

type: custom:mini-graph-card
name: BirdNET Erkennungen der letzten 365 Tage
group_by: date
aggregate_func: max
hours_to_show: 8760
line_width: 2
hour24: true
show:
  graph: bar
  points: false
entities:
  - sensor.birdnet_anzahl_tag
card_mod:
  style: |
    ha-card {
      background: transparent;
      border: none;
      border-radius: 0;
    }

---

9. Microphone Setup as RTSP Stream on a Raspberry Pi

Sadly there are only a few descriptions, so i have many trouble, but now it works.

I bought a Raspberry Pi 4b and 5.
In this example i use a very cheap microphone. (https://www.amazon.de/gp/product/B0CYC9DY4Z/ref=ppx_yo_dt_b_search_asin_title?psc=1)
My SD-Card has 16GB

Install Raspberry OS

• Load the Raspberry Pi Imager from https://www.raspberrypi.com/software/
• Choose your Raspberry Pi Model
• Choose Raspberry Pi OS (64-Bit) (A port Debiad Bookword (Recommended))
• Choose you SD-Card with min. 16GB
• Settings:
  • Enter Hostname
  • Enter Username and Password
  • Enter your WiFi SSID and Password
  • Enable SSH with Password
• Flash it and boot your Raspberry Pi
• ping the hostname ... ok?

Install Software

• use ssh to connect to you Raspberry Pi (pay attention to the case of the username)
• enter on the commandline (cut & paste):

sudo apt-get update
sudo apt-get upgrade -y
command -v ffmpeg >/dev/null 2>&1 || sudo apt-get install ffmpeg -y
wget -c https://github.com/bluenviron/mediamtx/releases/download/v1.9.1/mediamtx_v1.9.1_linux_arm64v8.tar.gz -O - | tar -xz
printf '#!/bin/bash\nDEVICE=$(arecord -l | grep "^card" | head -n1 | awk -F "[ ,:]+" '\''{print "hw:"$2","$9}'\'')\n./mediamtx &\nffmpeg -nostdin -f alsa -channels 1 -ar 48000 -i "$DEVICE" -c:a aac -b:a 128k -f rtsp rtsp://localhost:8554/birdmic -rtsp_transport tcp &\n' > ./birdmic.sh
chmod a+x birdmic.sh
echo "@reboot /home/"$USER"/birdmic.sh" | crontab -
sudo reboot

Now you could use this in the advanced settings as RTSP-Stream in the Settings of the BirdNET-Pi AddOn.
Don't forget to expand the source_mapvaribles in '3. Template to process BirdNET MQTT messages'

---

This works perfect since many days. So use it and have fun with the birds in you garden.

---

Questions? Hints? Please feel free to contact answer.

[UlrichThiess]

[cesa030]

Hallo Ullrich,

deine Config klingt mega spannend. Ich versuche sie gerade nachzuvollziehen. Kannst du vielleicht noch eine Info geben, wie du MQTT unter "Apprise Notifications Configuration:" konfiguriert hast? Ich nehme an mit "mqtt://...../birdnet"? Ich versuche gerade mein Home Assistant dahingehend anzupassen, da ich "mqtt://.../birdpi/apprise" nutze und ich auf einer Karte in HA bereits die letzten 10 erkannten Vogelarten angezeigt werden und ich darauf nicht verzichten möchte :)

Danke,
Gruß Marcus

[alexbelgium]

I just was seeing your post again - it is indeed an amazing work congratulations for having made this work and sharing it !
You should also post on https://github.com/Nachtzuster/BirdNET-Pi it will also reach a broader audience and more people can benefit also from it !

Have fun with birdnet - it is such an amazing tool ! And visualisations such as yours are great also to share even to non-tech people the results