Hannes
279a5ea61a
Add an Acknowledgements section to the README and a matching CHANGELOG line noting that the v1.0.0 documentation and repository tooling were drafted with OpenCode running the Qwen3.8 Flash Next model, reviewed by the maintainer.
41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project are documented here.
|
|
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|
|
|
## [1.0.0] - 2026-10-19
|
|
|
|
First public release of the ESP32-C3 CO₂ & environment sensor board (prototype v1).
|
|
|
|
### Added
|
|
|
|
- **Hardware design** (KiCad 10): schematic, 2-layer board layout, custom symbol
|
|
library (`esp_sensair_stuff.kicad_sym`) and footprint library
|
|
(`esp_sensair_stuff.pretty/`) for the ESP32-C3 module, Sensirion S8 and BME280.
|
|
- Project-local library tables (`fp-lib-table`, `sym-lib-table`) so the design
|
|
opens with all custom parts resolved on a fresh clone.
|
|
- **Fabrication data**: Gerber X2 plot, Excellon PTH/NPTH drills, Gerber
|
|
job/stackup file, packaged as a ready-to-upload `esp-sensair.zip`. These are
|
|
derived artifacts published as GitHub Release assets (not committed to the tree).
|
|
- **Bill of materials** (`bom/esp-sensair-bom.csv`) plus the human-readable BOM
|
|
in the README.
|
|
- **Documentation** in `docs/`: schematic PDF, top/bottom layer plots, 3D render.
|
|
- **Firmware** (`firmware/`): ESPHome configuration and secrets templates
|
|
(`*.example`) for the ESP32-C3 (esp-idf), BME280 over I²C and Sensirion S8
|
|
over UART, with Home Assistant API (noise encryption) and OTA.
|
|
- **Licensing**: CERN-OHL-S-2.0 for hardware (`LICENSE`), MIT for firmware, BOM
|
|
and docs (`LICENSE.MIT`).
|
|
- `.gitignore` covering KiCad local history/backups/lock files, ESPHome build
|
|
artifacts, live firmware credentials, and OS/editor noise.
|
|
- Documentation and repository tooling for this release (README, changelog,
|
|
library tables, `.gitignore`, release packaging) drafted with OpenCode running
|
|
the Qwen3.8 Flash Next model, reviewed by the maintainer.
|
|
|
|
### Known issues
|
|
|
|
See the "Known issues and lessons learned (v1 → v2)" section of the
|
|
[README](README.md). Highlights: power delivered through the module's USB-C 5 V
|
|
path, single decoupling capacitor, no mounting holes, no populated I²C pull-ups,
|
|
unannotated schematic, and leaded HASL. (The `+` that was in the project name has
|
|
been removed; the project and fabrication files are now `esp-sensair`.)
|