https://github.com/scout064/esp32-dht22-monitoring
Monitor Temperature and Humidity via ESP32-C6 and DHT22.
https://github.com/scout064/esp32-dht22-monitoring
dht22 esp32 esp32-c6
Last synced: 2 months ago
JSON representation
Monitor Temperature and Humidity via ESP32-C6 and DHT22.
- Host: GitHub
- URL: https://github.com/scout064/esp32-dht22-monitoring
- Owner: Scout064
- Created: 2025-04-17T09:20:22.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-17T17:55:42.000Z (2 months ago)
- Last Synced: 2025-04-18T00:17:44.754Z (2 months ago)
- Topics: dht22, esp32, esp32-c6
- Language: C++
- Homepage:
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# ESP32 DHT22 Sensor API Server
Firmware for ESP32 that exposes a web server and REST API to access DHT22 sensor readings (temperature, humidity), configure WiFi and interval settings, and control device reboot or reset securely.
## 🔧 Features
- Read temperature and humidity from DHT22
- Async web server with fast response
- Configurable via REST API (WiFi, polling rate, admin key)
- Swagger UI at `/docs` for interactive API documentation
- Prometheus metrics at `/metrics` for Grafana
- CORS-enabled for frontend apps
- Web OTA updates via `/update` (admin protected)
- Admin key protected endpoints for sensitive operations
## 🌐 Endpoints
### Sensor Data
| Method | Path | Auth | Description |
|--------|------------------|------|----------------------------------|
| GET | `/temperature` | ❌ | Returns current temperature (°C) |
| GET | `/humidity` | ❌ | Returns current humidity (%) |
### Configuration
| Method | Path | Auth | Description |
|--------|-------------------------|------|--------------------------------------------|
| POST | `/api/update-wifi` | ✅ | Change WiFi credentials |
| POST | `/api/update-interval` | ✅ | Update sensor polling interval (≥500ms) |
| POST | `/api/update-key` | ✅ | Change admin key securely |
### Device Management
| Method | Path | Auth | Description |
|--------|---------------------|------|------------------------------------|
| POST | `/api/reboot` | ✅ | Reboots the ESP32 device |
| POST | `/api/factory-reset`| ✅ | Clears all preferences and restarts |
| POST | `/update` | ✅ | Web-based OTA firmware upload |
### Logging & Monitoring
| Method | Path | Auth | Description |
|--------|----------------|------|-------------------------------------|
| GET | `/api/logs` | ✅ | Returns last 10 log events |
| GET | `/metrics` | ❌ | Prometheus metrics format for scrape |
| GET | `/api/status` | ❌ | JSON with temp, humidity, uptime, IP, SSID, FW Version, Buildtime |
### API Docs (Swagger)
| Method | Path | Auth | Description |
|--------|----------|------|---------------------------|
| GET | `/docs` | ❌ | Swagger UI API explorer |
## 🔐 Authentication
> **Note:** For protected endpoints, use `?key=...` query param.
- Default admin key: `secret123`
**Example:**
```bash
curl -X POST http://192.168.1.200/api/reboot?key=secret123
```
## 💾 Preferences Structure
| Namespace | Key | Purpose |
|-----------|-------------|---------------------------------|
| `wifi` | `ssid` | Stored WiFi SSID |
| `wifi` | `password` | Stored WiFi Password |
| `config` | `interval` | Sensor polling interval (ms) |
| `auth` | `adminKey` | Admin key for auth-protected routes |
## 📌 Requirements
- ESP32 (DevKit or equivalent)
- DHT22 sensor (wired to GPIO5)
- Arduino IDE or PlatformIO
- WiFi access
## :electric_plug: Connection Diagram
## 🚀 Getting Started
1. Connect DHT22 sensor to GPIO 5.
2. Flash firmware to ESP32.
3. Monitor Serial for IP (115200 baud).
4. Access your ESP32 via browser: `http:///docs`
## 📊 Prometheus Integration
Add this to your `prometheus.yml` scrape config:
```yaml
scrape_configs:
- job_name: 'esp32-dht'
metrics_path: /metrics
static_configs:
- targets: [':80']
```
> Then import metrics like `esp32_temperature`, `esp32_humidity`, `esp32_uptime_seconds` in Grafana
## 🔁 Web OTA Update Instructions
1. Navigate to: `http:///update?key=secret123`
2. Upload compiled `.bin` file from Arduino IDE/PlatformIO
3. Wait for confirmation and auto-reboot
## Build Instructions
1. In Arduino IDE: Sketch > Export compiled Binary
2. Locate the `.bin` file in sketch folder
3. Navigate to http:///update?key=secret123
4. Upload the .bin file to update firmware
## 📂 File Overview
- `esp32-c6-hdt22-monitor.ino`: main firmware logic
- `OpenAPI.json`: file to import into Postman for example
---
Built with ❤️ using [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
> For issues or contributions, feel free to ([open a GitHub issue](https://github.com/Scout064/esp32-dht22-monitoring))