ClearGrow Documentation
Technical documentation for the ClearGrow IoT agricultural monitoring system.
Overview
ClearGrow is a premium grow room environmental monitoring system consisting of:
- Controller: ESP32-S3 touchscreen device with Thread Border Router
- Probes: nRF52840 wireless sensors for temperature, humidity, light, and more
- Server: Desktop software for data aggregation and analysis
Documentation Structure
Documentation is organized into three categories:
| Category | Path | Purpose |
|---|---|---|
| Guides | guides/ |
Learning and how-to content |
| Reference | reference/ |
Lookup information (specs, APIs) |
| Project | project/ |
Internal working documents |
Guides (Learning & Doing)
| Path | Audience | Contents |
|---|---|---|
guides/user/ |
End users | Setup, daily use, troubleshooting |
guides/developer/ |
Developers | Onboarding, contributing, testing |
Reference (Looking Up)
| Path | Contents |
|---|---|
reference/architecture/ |
System design, component diagrams |
reference/api/ |
REST, CoAP, MQTT specifications |
reference/firmware/ |
Component specifications |
reference/hardware/ |
PCB, pinouts, manufacturing |
reference/ui/ |
Screens, styles, components |
reference/errors/ |
Error codes and recovery |
Project (Internal)
| Path | Contents |
|---|---|
project/tasks/ |
Active implementation tasks (TASK_*.md) |
project/assessments/ |
Code analysis findings |
project/decisions/ |
Architecture Decision Records (ADRs) |
project/archive/ |
Completed tasks |
Project Roadmap
Future features documented but not yet implemented:
| Document | Description |
|---|---|
| Server Platform | Desktop/cloud server software |
| Mobile App | iOS/Android companion app |
| MQTT Integration | Home Assistant connectivity |
| Probe OTA | Over-the-air probe updates |
See project/roadmap/ for all planned features.
Other Directories
| Path | Contents |
|---|---|
project/assessments/ |
Firmware assessment (168 gaps identified) |
_templates/ |
Document templates for new content |
_archive/ |
Archived previous documentation |
pdf-output/ |
Generated PDF manuals |
Quick Links
For Users:
- Getting Started - Unboxing to first readings
- Daily Use - Dashboard, zones, alerts
- Troubleshooting - Common issues
For Developers:
- Onboarding - Toolchain setup, first build
- Contributing - Code style, PR process
- API Reference - REST, CoAP, MQTT
Technical Reference:
- Hardware Pinout - GPIO assignments
- Screen Inventory - All UI screens
- Error Codes - Troubleshooting codes
Generating PDFs
User-facing documentation can be exported to PDF:
./build-pdf.sh
Requires: pandoc, pdflatex (texlive)
Output: pdf-output/*.pdf
Related Repositories
- ClearGrow-Controller - ESP32-S3 controller firmware
- ClearGrow-Probe - nRF52840 probe firmware
License
Proprietary - All rights reserved.