How cedced19/garage-doors-opener works
Project type and purpose
• This is an IoT-based, full-stack garage-door opener system.
• Hardware layer: ESP8266/NodeMCU (with or without Arduino Uno), optional Raspberry Pi.
• Backend/microservices:
• util-clock (Node.js scheduling service with web admin UI)
• watch-over (Dockerized monitoring service)
• Mobile frontends: two React Native apps (“mobile” and “mobile-new”).
• Purpose: remotely toggle and monitor garage doors via HTTP(S), optionally schedule tasks or continuous monitoring.
File structure
• Top-level folders by function:
• arduino-esp8266 / arduino-ethernet / nodemcu* / little-door – firmware sketches for different hardware setups
• raspberry – Python script + systemd service for Pi-based version
• util-clock – Node.js cron task manager + Express/EJS-based admin UI + REST-style garage APIs
• watch-over – Docker+Node.js service for monitoring endpoints
• mobile, mobile-new – two React Native app variants, each with Android/iOS projects plus shared JS/TS code
• Configuration and deployment files:
• docker-compose.yml and Dockerfile in watch-over
• garage-doors-opener.service files (systemd) in raspberry and watch-over
• Build scripts: gulpfile.js in util-clock, gradle files in mobile-new/android, Buck/Gradle in mobile/android.
README for additional insights
• Core API routes:
• GET /garage/{id}/toggle/{password}
• GET /garage/{id}/status/{password}
• Emphasis on using a reverse proxy (e.g., Caddy) for HTTPS.
• Three hardware schemas (Arduino+ESP8266, NodeMCU, Arduino+Ethernet, Raspberry Pi).
• Demo credentials and URLs for testing.
Elements
• Clear, descriptive labels for each component (e.g., “ESP8266 HTTP Server”, “Caddy HTTPS Proxy”, “util-clock Scheduler”).
• Clients → Proxy → Device/Service
• Services → Device API
• Device → Sensor data → Service or direct client fetch
• Hardware (e.g., orange rectangles)
• Microservices (e.g., green hexagons)
• Clients (e.g., purple rounded rectangles)