honney/esp_sensair
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Integrate board photos into README, photos index, and changelog

Browse Source
This commit is contained in:
Hannes committed 2026-10-26 18:32:21 +01:00
1 parent 64d704cf4f
commit 8ba00076dc
3 files changed
+45 -12
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CHANGELOG.md
+9
View File
@@ -3,6 +3,15 @@
All notable changes to this project are documented here.
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [Unreleased]
### Added
- **Photos** (`photos/`): assembled-board photos (front/back, assembled and
soldered), an active CO₂ measurement shot, and a Home Assistant dashboard
screenshot. Committed to the tree, embedded in the README, and attached as
assets to the v1.0.0 release.
## [1.0.0] - 2026-10-19
First public release of the ESP32-C3 CO₂ & environment sensor board (prototype v1).
README.md
+24 -1
View File
@@ -18,6 +18,29 @@ running.
![3D render](docs/esp-sensair-3d-top.png)
## Photos
Photos of the assembled prototype are in [`photos/`](photos/) and attached to the
[latest release](https://git.honney333.work/honney/esp_sensair/releases/latest).
| | |
|---|---|
| ![Assembled board, front side](photos/frontside.jpg) | ![Assembled board, back side](photos/backside.jpg) |
| Front side (assembled) | Back side (assembled) |
| | |
|---|---|
| ![Front side, soldered](photos/frontside_soldered.jpg) | ![Back side, soldered](photos/backside_soldered.jpg) |
| Front side, soldered | Back side, soldered |
Running, with an active CO₂ measurement:
![Active CO₂ measurement](photos/active_co2_measurement.jpg)
Live values on the Home Assistant dashboard:
![Home Assistant dashboard](photos/sensor_current_homeassistant.png)
## Block diagram
```
@@ -177,7 +200,7 @@ ESPHome on `esp32-c3-devkitm-1`, framework **esp-idf**. Config template:
├── bom/ bill of materials (CSV)
├── docs/ schematic PDF, layer plots, 3D render
├── firmware/ ESPHome config templates, secrets templates, notes
├── photos/ photographs of the assembled board
├── photos/ photographs of the assembled board (also release assets)
├── CHANGELOG.md release history
├── LICENSE CERN-OHL-S-2.0 (hardware)
└── LICENSE.MIT MIT (firmware config, BOM, docs)
photos/README.md
+12 -11
View File
@@ -1,13 +1,14 @@
Photographs of the assembled board.
# Photos
Suggested shots for the README (top-down, evenly lit, plain background, 1600 px wide):
Photographs of the assembled prototype board (v1). The same files are attached as
assets on the [latest release](https://git.honney333.work/honney/esp_sensair/releases/latest)
and embedded in the [README](../README.md).
- `top.jpg` assembled board, front side, all parts visible
- `bottom.jpg` solder side
- `installed.jpg` board in its final location / enclosure
- `running.jpg` Home Assistant dashboard showing live values
Add them to the README once taken:
![Assembled board, top](photos/top.jpg)
![Assembled board, bottom](photos/bottom.jpg)
| File | Description |
|---|---|
| `frontside.jpg` | assembled board, front side |
| `backside.jpg` | assembled board, back side |
| `frontside_soldered.jpg` | front side, soldered |
| `backside_soldered.jpg` | back side, soldered |
| `active_co2_measurement.jpg` | board running, active CO₂ measurement |
| `sensor_current_homeassistant.png` | Home Assistant dashboard with live values |