Developer Hub Overview¶
Welcome to the ENTS Developer Hub. The ENTS project encompasses an ecosystem of open-source repositories spanning custom hardware design, dual embedded firmware architectures, cloud ingestion pipelines, and interactive web visualization.
Architecture and Source Code Organization¶
To support continuous improvement across heterogeneous embedded and web stacks without documentation drift, the ENTS ecosystem enforces a strict Single Source of Truth documentation model:
- Central Portal (
jlab-sensing/ENTS): Focuses on high-level system architecture, cross-cutting data pipelines, end-to-end integration workflows, and the overall repository index. - Subsystem Repositories: Maintain code-adjacent developer documentation (such as
pytestcommands, PlatformIO flags, Rust compilation targets, and hardware assembly notes) directly alongside their source code.
flowchart TD
subgraph DocsPortal ["Central Documentation Portal (jlab-sensing/ENTS)"]
direction TB
ArchDoc["System Architecture\n(docs/developers/architecture.md)"]
RepoMap["Repository Directory & Source Map\n(docs/developers/repositories.md)"]
ContribDoc["Contributing Guidelines\n(docs/developers/contributing.md)"]
end
subgraph HardwareDev ["Hardware Layer"]
HW_Repo["jlab-sensing/soil_power_sensor\n(Schematics, BOM, Test Points)"]
ENC_Repo["jlab-sensing/ENTS-enclosure\n(CAD Models & STL Files)"]
end
subgraph FirmwareDev ["Firmware Layer"]
BM_Repo["jlab-sensing/soil-power-sensor-firmware\n(Production Bare Metal STM32 HAL)"]
TK_Repos["jlab-sensing/tock & ENTS-tock\n(Future TockOS Microkernel & Userspace Apps)"]
end
subgraph CloudDev ["Cloud & Web Layer"]
DV_Repo["jlab-sensing/DirtViz\n(Flask Ingestion API + React Web UI)"]
NF_Repo["jlab-sensing/NodeFlow\n(Derivative Project & API Consumer Example)"]
end
RepoMap -->|Direct Link| HW_Repo
RepoMap -->|Direct Link| BM_Repo
RepoMap -->|Direct Link| TK_Repos
RepoMap -->|Direct Link| DV_Repo
RepoMap -->|Direct Link| NF_Repo
Developer Guides in this Section¶
- System Architecture: Detailed specification of end-to-end dataflow, measurement frontend pipelines, Protocol Buffer serialization, wireless transmission protocols, and cloud ingestion.
- Repository Directory and Source Map: Complete catalog of all repositories across the ENTS ecosystem, detailing primary languages, subsystem roles, direct links to canonical Markdown documentation, and a clear distinction between core projects, derivatives (NodeFlow), and unsupported community tools.
- Contributing and Community: Guidelines for contributing code, formatting standards, testing expectations, and reporting issues.
Local Development Quick Links¶
For environment setup and compilation instructions for individual subsystems, navigate directly to the canonical documentation within each repository:
- DirtViz Web and Backend: DirtViz Development Guide
- Bare Metal Firmware (STM32 HAL): Firmware Developer Guide
- TockOS Kernel: Tock wm1110dev Board Documentation
- TockOS Userspace Applications: ENTS-tock Userspace README
- Hardware PCB and Assembly: Soil Power Sensor Hardware Guide
- NodeFlow Irrigation System: NodeFlow README