Projects Overview
OpticWorks develops and maintains several interconnected projects that form our complete product ecosystem. This section provides comprehensive documentation for each project, including architecture details, development guides, and operational procedures.
Project Ecosystem
Section titled “Project Ecosystem”Our projects work together to deliver end-to-end mmWave presence sensing solutions:
┌─────────────────────────────────────────────────────────────────┐│ OpticWorks Ecosystem │├─────────────────────────────────────────────────────────────────┤│ ││ ┌─────────────────┐ ┌─────────────────┐ ││ │ hardwareOS │ │ Presence Engine │ ││ │ (RS-1 Device) │ │ (DIY/Hobbyist) │ ││ │ │ │ │ ││ │ • Sensor Fusion│ │ • ESP32-based │ ││ │ • WebRTC │ │ • Home Assist. │ ││ │ • Kalman Filter│ │ • Statistical │ ││ └────────┬────────┘ └────────┬────────┘ ││ │ │ ││ └──────────┬───────────┘ ││ ▼ ││ ┌─────────────────────┐ ││ │ OpticWorks Store │ ││ │ (E-commerce) │ ││ │ │ ││ │ • Next.js 15 │ ││ │ • Medusa v2 │ ││ │ • Stripe/EasyPost │ ││ └─────────────────────┘ ││ │└─────────────────────────────────────────────────────────────────┘Projects at a Glance
Section titled “Projects at a Glance”| Project | Purpose | Tech Stack | Team Lead |
|---|---|---|---|
| hardwareOS | Embedded OS for RS-1 sensor device | C, Go, TypeScript | Hardware Team |
| Presence Detection Engine | DIY presence sensing for Home Assistant | C++, Python, ESPHome | Open Source Team |
| OpticWorks Store | E-commerce platform at optic.works | Next.js, Medusa, PostgreSQL | Web Team |
Common Goals
Section titled “Common Goals”All OpticWorks projects share these core objectives:
- Privacy-First Design - All processing happens locally; no cloud dependency for core functionality
- Open Source Commitment - Our projects are open source to foster community collaboration
- Real-Time Performance - Sub-100ms latency for presence detection and state updates
- Developer Experience - Comprehensive documentation, clear APIs, and straightforward setup
Who Works on What
Section titled “Who Works on What”Hardware Team
Section titled “Hardware Team”- Focus: hardwareOS, firmware, sensor integration
- Skills: Embedded C, Go, RTOS, signal processing
- Slack Channel:
#hardware-engineering
Open Source Team
Section titled “Open Source Team”- Focus: Presence Detection Engine, community engagement
- Skills: ESPHome, Home Assistant, ESP32, Python
- Slack Channel:
#open-source
Web Team
Section titled “Web Team”- Focus: OpticWorks Store, customer-facing applications
- Skills: Next.js, React, TypeScript, Medusa
- Slack Channel:
#web-engineering
Platform Team
Section titled “Platform Team”- Focus: Shared infrastructure, CI/CD, DevOps
- Skills: GitHub Actions, Docker, Cloudflare, Hetzner
- Slack Channel:
#platform
Cross-Project Resources
Section titled “Cross-Project Resources”- Shared Resources - Common tools, libraries, and workflows
- Git Workflow - Branching strategy and PR process
- Code Standards - Coding conventions across all projects
Getting Started
Section titled “Getting Started”New to OpticWorks? Here’s how to get oriented:
- Read the overviews - Start with each project’s overview page to understand their purpose
- Set up your environment - Follow the Development Setup guide
- Join the channels - Get added to the relevant Slack channels for your team
- Clone the repos - All repositories are at github.com/r-mccarty
- Review architecture - Understand how components interact before diving into code
Repository Links
Section titled “Repository Links”| Project | Repository | Status |
|---|---|---|
| hardwareOS | r-mccarty/hardwareOS | Active Development |
| Presence Detection Engine | r-mccarty/presence-dectection-engine | Active Development |
| OpticWorks Store | r-mccarty/opticworks-store | Production |