Hello World!

This commit is contained in:
John Varghese
2025-06-03 17:32:25 +05:30
committed by GitHub
commit 35bd33ad1b

85
README.md Normal file
View File

@@ -0,0 +1,85 @@
# ESP32-CAM | ONVIF | DVR/NVR Recording
## ESP32-CAM ONVIF RTSP Camera
[![Platform](https://img.shields.io/badge/platform-ESP32-blue.svg)](https://www.espressif.com/en/products/socs/esp32)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
## Overview
**ESP32-CAM ONVIF RTSP Camera** is an open-source firmware project that transforms your affordable ESP32-CAM module into a network camera compatible with professional NVR/DVR systems, including Hikvision, Dahua, and other ONVIF-compliant solutions.
This project brings together:
- **RTSP streaming** (MJPEG) for real-time video
- **Minimal ONVIF support** for device discovery, stream URI reporting, and basic integration with security recorders
The goal is to make ESP32-CAM modules plug-and-play with mainstream video surveillance systems, while remaining lightweight and efficient.
---
## Features
- 📡 **ONVIF Discovery:** Your ESP32-CAM will appear as a discoverable camera on ONVIF-compatible NVRs/DVRs.
- 🎥 **RTSP Streaming:** Real-time MJPEG streaming for live view and recording.
-**Lightweight:** Designed for ESP32-CAMs limited resources.
- 🛠️ **Easy Setup:** Simple Wi-Fi configuration and deployment.
- 🔒 **Open Source:** MIT-licensed for personal and commercial use.
---
## Roadmap
- [x] Minimal ONVIF WS-Discovery responder
- [x] ONVIF `/onvif/device_service` endpoint (GetStreamUri, GetCapabilities)
- [x] RTSP video streaming (MJPEG)
- [ ] Web-based configuration interface
- [ ] Optional SD card recording
- [ ] Motion detection (future)
- [ ] Support for more ONVIF features (profiles, device info, etc.)
---
## Quick Start
1. **Clone this repository**
2. **Edit Wi-Fi credentials** in the source code
3. **Flash to your ESP32-CAM** using Arduino IDE or PlatformIO
4. **Connect your NVR/DVR** and discover the camera via ONVIF, or add the RTSP stream manually
---
## Compatibility
- **Tested hardware:** AI-Thinker ESP32-CAM
- **NVR/DVR compatibility:** Hikvision, Dahua, and most ONVIF-compliant recorders (MJPEG stream)
- **Limitations:** MJPEG only (no H.264); some recorders may require H.264 for recording
---
## Screenshots
*Coming soon!*
---
## Contributing
Pull requests, issues, and feature suggestions are welcome!
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
---
## License
This project is licensed under the [MIT License](LICENSE).
---
## Acknowledgments
- [Micro-RTSP](https://github.com/geeksville/Micro-RTSP) for RTSP streaming on ESP32
- ONVIF community for protocol documentation and inspiration
---
> **Stay tuned for updates, features, and documentation as the project evolves!**