{"id":44815983,"url":"https://github.com/21cncstudio/project_aura","last_synced_at":"2026-02-22T15:14:59.148Z","repository":{"id":335120292,"uuid":"1140029257","full_name":"21cncstudio/project_aura","owner":"21cncstudio","description":"ESP32‑S3 air‑quality station with LVGL UI, MQTT, Home Assistant","archived":false,"fork":false,"pushed_at":"2026-02-09T13:14:26.000Z","size":48234,"stargazers_count":109,"open_issues_count":0,"forks_count":8,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-02-09T18:25:55.655Z","etag":null,"topics":["3d-printing","adafruit","air-quality","arduino","diy","esp32","esp32-s3","home-assistant","indoor-air-quality","iot","lvgl","mqtt","open-hardware","platformio","sen66","sensirion","sensors","sfa30","smart-home","waveshare"],"latest_commit_sha":null,"homepage":"https://www.21cncstudio.com/project-aura/","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/21cncstudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":"CLA.md"},"funding":{"custom":["https://makerworld.com/en/crowdfunding/159-project-aura-make-the-invisible-visible"]}},"created_at":"2026-01-22T18:25:52.000Z","updated_at":"2026-02-09T13:14:31.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/21cncstudio/project_aura","commit_stats":null,"previous_names":["21cncstudio/project_aura"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/21cncstudio/project_aura","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/21cncstudio%2Fproject_aura","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/21cncstudio%2Fproject_aura/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/21cncstudio%2Fproject_aura/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/21cncstudio%2Fproject_aura/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/21cncstudio","download_url":"https://codeload.github.com/21cncstudio/project_aura/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/21cncstudio%2Fproject_aura/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29514593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T17:46:34.542Z","status":"ssl_error","status_checked_at":"2026-02-16T17:46:30.907Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-printing","adafruit","air-quality","arduino","diy","esp32","esp32-s3","home-assistant","indoor-air-quality","iot","lvgl","mqtt","open-hardware","platformio","sen66","sensirion","sensors","sfa30","smart-home","waveshare"],"created_at":"2026-02-16T18:01:58.995Z","updated_at":"2026-02-16T18:02:01.501Z","avatar_url":"https://github.com/21cncstudio.png","language":"C","readme":"# Project Aura\n\n[![PlatformIO](https://img.shields.io/badge/platform-PlatformIO-ff7f2a?logo=platformio\u0026logoColor=white)](https://platformio.org/)\n[![ESP32-S3](https://img.shields.io/badge/target-ESP32--S3-323330)](https://www.espressif.com/en/products/socs/esp32-s3)\n[![LVGL](https://img.shields.io/badge/ui-LVGL-00b0f0)](https://lvgl.io/)\n[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)\n[![YouTube Demo](https://img.shields.io/badge/YouTube-Demo-FF0000?logo=youtube\u0026logoColor=white)](https://www.youtube.com/watch?v=TNsyDGNrN-w)\n\nSupport this project: back the crowdfunding to get detailed build instructions, 3D-printable enclosure models, and wiring guides at:\nhttps://makerworld.com/en/crowdfunding/159-project-aura-make-the-invisible-visible\n\nProject Aura is an open-source ESP32-S3 air-quality station built for makers who want a polished,\nreliable device rather than a bare sensor board. It combines a touch-friendly LVGL UI, a local web\nsetup portal, and MQTT with Home Assistant discovery.\n\nThis repository contains the firmware source code and configuration needed to flash and customize the device.\n\n**Join the community:** [GitHub Discussions](https://github.com/21cncstudio/project_aura/discussions)\n\n## Table of Contents\n- [Video Demo](#video-demo)\n- [Highlights](#highlights)\n- [Gallery](#gallery)\n- [UI Screens](#ui-screens)\n- [Hardware and BOM](#hardware-and-bom)\n- [Assembly and Wiring Notice](#assembly-and-wiring-notice)\n- [Pin Configuration](#pin-configuration)\n- [UI Languages](#ui-languages)\n- [Firmware Architecture](#firmware-architecture)\n- [Build and Flash](#build-and-flash-platformio)\n- [Configuration](#configuration)\n- [MQTT + Home Assistant](#mqtt--home-assistant)\n- [Contributing](#contributing)\n- [License and Commercial Use](#license-and-commercial-use)\n- [Tests](#tests)\n- [Repo Layout](#repo-layout)\n\n## Video Demo\nClick the image.\n[![Project Aura demo video](https://img.youtube.com/vi/TNsyDGNrN-w/maxresdefault.jpg)](https://www.youtube.com/watch?v=TNsyDGNrN-w)\n\n## Highlights\n- Professional telemetry: PM2.5/PM10, CO2, VOC, NOx, temperature, humidity, absolute humidity (AH), pressure, HCHO.\n- No soldering required: designed for easy assembly using Grove/QT connectors.\n- Smooth LVGL UI with night mode, custom themes, and status indicators.\n- Easy setup: Wi-Fi AP onboarding + mDNS portal (http://aura.local) for configuration.\n- Home Assistant ready: automatic MQTT discovery and ready-to-use dashboard code.\n- Robust Safe Boot: automatic rollback to the last-known-good config after crashes.\n\n![Project Aura device](docs/assets/device-hero.jpg)\n\n## Gallery\n![Assembly overview](docs/assets/device-assembly.jpg)\n![Internal wiring](docs/assets/device-internals.jpg)\n![Boot and live dashboard](docs/assets/device-boot-ui.jpg)\n\n## UI Screens\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-dashboard.jpg\" alt=\"Dashboard\"/\u003e\u003cbr/\u003eDashboard\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-settings.jpg\" alt=\"Settings\"/\u003e\u003cbr/\u003eSettings\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-theme-presets.jpg\" alt=\"Theme Presets\"/\u003e\u003cbr/\u003eTheme Presets\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-mqtt.jpg\" alt=\"MQTT\"/\u003e\u003cbr/\u003eMQTT\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-time-date.jpg\" alt=\"Date \u0026 Time\"/\u003e\u003cbr/\u003eDate \u0026amp; Time\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"docs/assets/ui-backlight.jpg\" alt=\"Backlight\"/\u003e\u003cbr/\u003eBacklight\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Hardware and BOM\nProject Aura is designed around high-quality components to ensure accuracy. If you are sourcing parts yourself,\nlook for these specific modules:\n\n| Component | Part / Model |\n| :--- | :--- |\n| Core Board | Waveshare ESP32-S3-Touch-LCD-4.3 (800x480) |\n| Main Sensor | Sensirion SEN66 (via Adafruit breakout) |\n| Formaldehyde | Sensirion SFA30 (Grove interface, optional) |\n| Pressure | Adafruit BMP580 or DPS310 |\n| RTC | Adafruit PCF8523 |\n\nSensor note: the SFA30 is fully supported and widely available. Support for the successor model (SFA40) is on the roadmap.\nNote: SEN66 gas indices (VOC/NOx) require about 5 minutes of warmup for reliable readings; the UI shows WARMUP during this period.\n\nRecommended retailers: Mouser, DigiKey, LCSC, Adafruit, Seeed Studio, Waveshare.\n\n## Assembly and Wiring Notice\nPlease pay close attention to the cabling. The pin order on the board is custom and requires modification\nof standard off-the-shelf cables (pin swapping).\n\nBackers: please refer to the comprehensive Build Guide included in your reward for the exact wiring diagram\nand a trouble-free assembly.\n\nDIY: verify pinouts against the pin table below before powering on to avoid damaging components.\n\n## Pin Configuration\n| Component | Pin (ESP32-S3) | Notes |\n| :--- | :--- | :--- |\n| 3V3 | 3V3 | Power for external I2C sensors |\n| GND | GND | Common ground |\n| I2C SDA | GPIO 8 | SEN66, SFA30, BMP580 (external) |\n| I2C SCL | GPIO 9 | Shared bus |\n\nDisplay and touch are integrated on the board; no external wiring is needed for them.\n\n## UI Languages\nProject Aura speaks your language. You can switch languages in the Settings menu:\n- English\n- Deutsch\n- Espanol\n- Francais\n- Italiano\n- Portugues BR\n- Nederlands\n- Simplified Chinese\n\n## Firmware Architecture\nData flow and responsibilities are intentionally split into small managers:\n\n```mermaid\ngraph TD\n    subgraph Hardware\n        Sensors[Sensors\u003cbr/\u003eSEN66, SFA30, BMP580]\n        Touch[Touch\u003cbr/\u003eGT911]\n        RTC[RTC\u003cbr/\u003ePCF8523]\n        LCD[LCD + Backlight]\n    end\n\n    subgraph Core\n        SM[SensorManager]\n        NM[NetworkManager]\n        MM[MqttManager]\n        TM[TimeManager]\n        CoreLogic[BootPolicy / Watchdog / MemoryMonitor]\n    end\n\n    subgraph Data\n        History[PressureHistory]\n        Storage[(LittleFS\u003cbr/\u003econfig/last_good/voc/pressure)]\n    end\n\n    subgraph UI\n        LVGL[LVGL UI]\n        Web[Web Config Portal]\n    end\n\n    Sensors --\u003e|I2C| SM\n    RTC --\u003e|I2C| TM\n    Touch --\u003e|I2C| LVGL\n    LCD --\u003e LVGL\n    SM --\u003e|Data| LVGL\n    SM --\u003e|Data| History\n    History \u003c--\u003e|save/load| Storage\n    Storage \u003c--\u003e|config| NM\n    Storage \u003c--\u003e|config| MM\n    NM --\u003e Web\n    NM --\u003e MM\n    MM --\u003e|Publish| HA[Home Assistant]\n\n    style CoreLogic fill:#f96,stroke:#333,stroke-width:2px\n```\n\nCore modules live in `src/core/` and orchestrate startup (`AppInit`, `BoardInit`).\nFeature managers are in `src/modules/`, UI in `src/ui/`, and web pages in `src/web/`.\n\n## Build and Flash (PlatformIO)\nPrerequisites: PlatformIO CLI or VSCode + PlatformIO extension.\nBuilt with Arduino ESP32 core 3.1.1 (ESP-IDF 5.3.x).\n\n```powershell\ngit clone https://github.com/21cncstudio/project_aura.git\ncd project_aura\npio run -e project_aura\npio run -e project_aura -t upload\npio run -e project_aura -t uploadfs\npio device monitor -b 115200\n```\n\n## Configuration\n1. Wi-Fi setup:\n   On first boot, the device creates a hotspot: `ProjectAura-Setup`.\n   Connect to it and open http://192.168.4.1 to configure Wi-Fi credentials.\n2. Web portal:\n   Once connected to your network, access the device at http://aura.local/. Configure MQTT, timezone, and themes there.\n3. Home Assistant:\n   MQTT discovery is enabled by default. The device appears in HA via MQTT integration automatically.\n   A ready-to-use dashboard YAML is available at `docs/home_assistant/dashboard.yaml`.\n   Setup guide: `docs/home_assistant/README.md`.\n\nOptional compile-time defaults belong in `include/secrets.h`, which is ignored by git.\nCopy and edit:\n\n```text\ncopy include/secrets.h.example include/secrets.h\n```\n\n## MQTT + Home Assistant\n- State topic: `\u003cbase\u003e/state`\n- Availability topic: `\u003cbase\u003e/status`\n- Commands: `\u003cbase\u003e/command/*` (night_mode, alert_blink, backlight, restart)\n- Home Assistant discovery: `homeassistant/*/config`\n\nMQTT stays idle until configured and enabled.\n\n![Home Assistant dashboard](docs/assets/ha-dashboard.jpg)\n\n## Contributing\nContributions are welcome! Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on the process for submitting pull requests and the Contributor License Agreement (CLA).\n\nFound a bug? Open an Issue: https://github.com/21cncstudio/project_aura/issues\nHave a question? Ask in Discussions: https://github.com/21cncstudio/project_aura/discussions\n\n## License and Commercial Use\n- Firmware in this repository is licensed under GPL-3.0-or-later (see `LICENSE`).\n- Commercial use is allowed under GPL. If you distribute firmware (including in devices), you must provide the Corresponding Source under GPL.\n- If you need to sell devices while keeping firmware modifications proprietary, obtain a Commercial License (see `COMMERCIAL_LICENSE_SUMMARY.md`).\n- Enclosure models and the PDF build guide are not in this repository; they are available to backers on MakerWorld under separate terms.\n- Trademark and branding use is covered by `TRADEMARKS.md`.\n\n## Tests\nSee `TESTING.md` for native host tests and `scripts/run_tests.ps1`.\n\n## Repo Layout\n- `src/core/` boot, init, reliability\n- `src/modules/` sensors, storage, network, MQTT, time\n- `src/ui/` LVGL screens, assets, controllers\n- `src/web/` HTML templates and handlers\n- `test/` native tests and mocks\n","funding_links":["https://makerworld.com/en/crowdfunding/159-project-aura-make-the-invisible-visible"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F21cncstudio%2Fproject_aura","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F21cncstudio%2Fproject_aura","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F21cncstudio%2Fproject_aura/lists"}