Skip to content

Commit 0b589ae

Browse files
committed
docs: add src/ directory index with module map and architecture
Add README.md inside src/ so visitors immediately understand the 19 modules, their purpose, and status (Production/Experimental/Legacy). Includes ASCII architecture diagram and evolution table mapping legacy modules to their new skill equivalents.
1 parent 2a9c2ab commit 0b589ae

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

src/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# DeepCamera Source Code
2+
3+
This directory contains the original DeepCamera processing pipeline, built over 4+ years of development. These modules handle everything from camera capture to AI-powered detection and re-identification.
4+
5+
> **🆕 Looking for the new skill system?** See [`skills/`](../skills/) for the pluggable AI skill architecture.
6+
7+
## Module Map
8+
9+
| Module | Purpose | Status |
10+
|--------|---------|--------|
11+
| **`yolov7_person_detector/`** | Real-time person detection using YOLOv7 | ✅ Production |
12+
| **`yolov7_reid/`** | Person re-identification — tracks individuals across cameras | ✅ Production |
13+
| **`face_detection/`** | Face detection & recognition pipeline (InsightFace) | ✅ Production |
14+
| **`embedding/`** | Feature extraction for visual similarity search | ✅ Production |
15+
| **`camera/`** | Camera capture utilities, RTSP/USB handlers | ✅ Production |
16+
| **`home-assistant-py/`** | Home Assistant integration (Python) | ✅ Production |
17+
| **`home-assistant-nodejs/`** | Home Assistant integration (Node.js) | ✅ Production |
18+
| **`fall_detection/`** | Fall detection for elderly care | 🧪 Experimental |
19+
| **`laptop_monitor/`** | Screen activity monitoring | 🧪 Experimental |
20+
| **`yolov2_parking/`** | Parking space detection (YOLOv2) | 📦 Legacy |
21+
| **`yolov3_parking/`** | Parking space detection (YOLOv3) | 📦 Legacy |
22+
| **`label-studio/`** | Label Studio annotation config | 📦 Legacy |
23+
| **`milvus/`** | Milvus vector database config | 📦 Legacy |
24+
| **`minio/`** | MinIO object storage config | 📦 Legacy |
25+
| **`flower/`** | Celery task monitor | 📦 Legacy |
26+
| **`monitor/`** | System monitoring utilities | 📦 Legacy |
27+
| **`build/`** | Build scripts for ARM/x86 platforms | 🔧 Build |
28+
| **`env/`** | Environment configuration | 🔧 Build |
29+
| **`unit_test/`** | Test suite | 🔧 Test |
30+
31+
## Architecture
32+
33+
```
34+
Camera Feed → capture (camera/) → detection (yolov7/) → embedding (embedding/)
35+
↓ ↓
36+
face_detection/ yolov7_reid/
37+
↓ ↓
38+
Face Recognition Person Re-ID
39+
└────────┬───────────────┘
40+
Notification
41+
(Home Assistant)
42+
```
43+
44+
## Evolution
45+
46+
These modules are being wrapped as **skills** for the [SharpAI Aegis](https://github.com/SharpAI/Aegis-AI) desktop app. The skill architecture provides a standard interface (`SKILL.md`) so each capability can be independently installed, configured, and updated.
47+
48+
| Legacy Module | New Skill |
49+
|--------------|-----------|
50+
| `yolov7_person_detector/` | [`skills/detection/yolo-detection-2026/`](../skills/detection/yolo-detection-2026/) |
51+
| `yolov7_reid/` | `skills/detection/person-recognition/` (planned) |
52+
| `face_detection/` + `embedding/` | `skills/detection/face-recognition/` (planned) |
53+
| `home-assistant-py/` | `skills/integrations/homeassistant-bridge/` (planned) |
54+
55+
See [`docs/skill-development.md`](../docs/skill-development.md) for how to create new skills.

0 commit comments

Comments
 (0)