fugleramme README

The project's README from github.com/arnegiacomo/fugleramme. As one markdown file: README.md.

fugleramme

E-ink bird frame for Raspberry Pi - real-time bird detection by audio, fully local AI, rendered as real, hand-cut 1800s bird illustrations.

The frame on a kitchen windowsill showing six birds heard in the garden, a window feeder on the glass behind it
Sorry about the dirty window - squirrels have been stealing the bird food.

Live demo Latest release CI Last commit
Stars Contributors License: MIT, artwork CC BY-SA 4.0
Artwork Species

[!IMPORTANT] Fugleramme has been selected for the GOSIM Spotlight at GOSIM Shenzhen 2026. If you're there, come by and say hi!

[!NOTE] Still in early development: expect the odd bug and a few unpolished edges, with plenty more features to come.

Live on fugleramme.arnegiacomo.dev running from my kitchen window and displaying the actual birds currently heard in my garden (Bergen, Norway). See other frames from around the world here!

Hardware, install and operations docs: arnegiacomo.dev/fugleramme

How it works

BirdNET-Go listens on a mic and handles the classifier. Fugleramme polls its api, matches each species to an illustration, then packs them onto a page, and redraws only when the birds change - on an Inky Impression e-ink panel, and as a web kiosk serving the same view. There's an admin page that lets you configure what to show, and automatic updates and such.

If you already run BirdNET-Go, point the frame at it instead - on the same machine or anywhere else reachable from your network.

[!TIP] The e-ink panel is not required, although it's recommended for the intended experience. Without one, Fugleramme runs web-only - show the kiosk on a display over HDMI, or open it from any device on the network.

Hardware

A Raspberry Pi 5, an Inky Impression 13.3" (Spectra 6), a mic and an A4 frame. Full parts list, recommendations and alternatives: Hardware.

I'm affiliated with Pimoroni - buying through the Pimoroni links or using the code ARNE at checkout supports this project.

Art

Half the point of this project is showing off some amazing public-domain natural-history illustrations. Over 800 cut-outs covering more than 400 species, every one taken from a real plate and hand-curated for this project (no art is AI-generated, though some has been retouched with AI).

Each detected species is matched to its illustration, background-removed, and packed onto a textured paper page with the larger birds toward the centre, sized by body mass. An empty window shows a bare perch.

The plates are Scandinavian, British and central European, so the Nordics, the British Isles and Germany are best covered. Elsewhere not so much (yet). Broader European and North American coverage is in the works!

Species coverage has a searchable list of all currently supported species. See Adding artwork for manual cutout steps.

No detections A few visitors A full garden
No birds detected A few garden birds Many garden birds

The look came from a WWF Verdens naturfond poster by Axel Thorenfeldt hanging on my wall, the live-frame idea from AvianVisitors that I saw on Instagram, and the detection from BirdNET-Go - I wanted a version of that poster showing the actual birds in my garden.

Similar projects:

Fugleramme shares no code or art with them.

Run locally (for development)

uv sync                                       # set up venv
uv run fugleramme-fake-detector               # stand-in BirdNET-Go on :8090
uv run fugleramme-dev                         # start service on :8080 with hot-reload

The fake detector's flags, and working against a real station instead: Running it without a Pi.

Install on a Raspberry Pi

From the pi (assuming you have the hardware up and running):

curl -fsSL https://raw.githubusercontent.com/arnegiacomo/fugleramme/main/install.sh | bash

Asks where BirdNET-Go should live and which ports to use, clones the repo, installs the required deps, and starts the frame as a systemd service. NB! Will probably require a reboot on a fresh system.

From a blank SD card, see the full install guide.

Run in a container

docker run -d -p 8080:8080 -v fugleramme:/data \
  -e FUGLERAMME_DETECTOR_URL=http://birdnet.local:8080 \
  ghcr.io/arnegiacomo/fugleramme

Or build the image from a checkout:

docker build -t fugleramme .
docker run --rm -p 8080:8080 -v fugleramme:/data \
  -e FUGLERAMME_DETECTOR_URL=http://birdnet.local:8080 fugleramme

Kiosk on :8080, admin on :8080/admin, everything it persists in /data.

On a Linux box with a USB mic, this brings up BirdNET-Go alongside it:

curl -fsSL https://raw.githubusercontent.com/arnegiacomo/fugleramme/main/examples/docker-compose.yml -o docker-compose.yml
docker compose up -d

See Container for more info.

Contributing

Contributions are very welcome and encouraged - fixes, docs and artwork most of all. Thanks to everyone who has contributed so far ❤️

See Contributing for more info.

License

Contact

Questions and ideas about the project belong in Discussions. For anything else, you can reach me through arnegiacomo.dev. I've built a few of these frames, but I currently don't have the capacity to build them for others.

fugleramme (arnegiacomo/fugleramme)

Searching Database…

3.8K ·GitHub
Fugleramme
Что это такое?Рамка для фотографий с e-ink дисплеем для Raspberry Pi, показывающая птиц: она в реальном времени определяет птиц по их голосам с помощью полностью локального ИИ и показывает вырезанные вручную иллюстрации XIX века тех птиц, что поют вокруг. Веб-киоск показывает то же самое на любом экране.
То есть картинка сама меняется, когда птицы прилетают и улетают - как это работает?BirdNET-Go слушает микрофон и определяет, какие птицы поют. Fugleramme опрашивает его API, сопоставляет каждый обнаруженный вид с иллюстрацией, собирает их на одну страницу и перерисовывает её только когда набор птиц меняется.
Как установить её на Raspberry Pi?Запустите на Raspberry Pi установочный скрипт: он спросит, где разместить BirdNET-Go и какие порты использовать, склонирует репозиторий, установит зависимости и запустит рамку как systemd-сервис - на чистой системе ожидайте перезагрузки. Можно также запустить как Docker-контейнер.
Какое железо нужно, чтобы собрать такую?Raspberry Pi 5, e-ink панель Inky Impression 13,3 дюйма (Spectra 6), микрофон и рамка формата A4. На сайте документации есть полный список комплектующих с рекомендациями и альтернативами.
А она будет работать с птицами моего региона?Лучше всего покрытие для Скандинавии, Британских островов и Германии, поскольку таблички скандинавские, британские и из Центральной Европы. Иллюстрации для остальной Европы и Северной Америки в работе, а список уже поддерживаемых видов можно посмотреть в поиске.
Обязательно покупать именно ту e-ink панель?Нет. Панель рекомендована для задуманного впечатления, но без неё fugleramme работает только через веб - покажите киоск на экране по HDMI или откройте его с любого устройства в вашей сети.
Микрофон слушает мой сад круглосуточно - уходит ли куда-то звук из моей сети?Нет. Распознавание - полностью локальный ИИ: BirdNET-Go обрабатывает звук с микрофона на вашем собственном железе, а fugleramme лишь опрашивает его API.
Есть ли подводные камни с лицензиями?Код - под MIT, но распознаванием занимается BirdNET-Go под лицензией CC BY-NC-SA 4.0 - только некоммерческое использование. У каждой папки с иллюстрациями свои условия, а классический стиль - CC BY-SA 4.0.
А что такое BirdNET-Go во всей этой истории?Это open-source приложение, которое непосредственно распознаёт пение птиц; оно устанавливается отдельно (обычно как контейнер) рядом с fugleramme. Его модель BirdNET создана Корнеллской лабораторией орнитологии и Хемницким техническим университетом.
Откуда взяты иллюстрации птиц?Более 800 вырезанных изображений, покрывающих свыше 400 видов; каждое вырезано из настоящей естественно-научной таблички XIX века и отобрано вручную - никакого ИИ-арта, хотя часть изображений была подправлена с помощью ИИ.
У меня уже стоит BirdNET-Go - устанавливать его заново не нужно?Нет, просто укажите рамке на ваш существующий экземпляр - работает ли он на той же машине или где-то ещё в вашей сети.
Можно посмотреть, как она работает, до покупки железа?Да - рамка самого автора работает вживую на fugleramme.arnegiacomo.dev и показывает птиц, которых сейчас слышно за его кухонным окном в Бергене, а в README есть ссылки на рамки, собранные по всему миру.
What are similar projects?core, DocsGPT, EchoMuse, RuView, reticle, techo5, local_roborock_server, CasaOS
Which topics is it in?art, homelab, iot, raspberry-pi, local-first, hacktoberfest, privacy, machine-learning, docker, self-hosted, ai, python
Creator
arnegiacomo
Size
1.5 GB
Stars
3.8K
Updated
CommitOct 16Releasev0.28.1Oct 15
Age
3mo
Commits · 90 Days