How pavelanni/geekhouse works
Key Components to Include:
Hardware Layer
• Supported sensors (ADC and Digital) and actuators (LEDs, motors, buzzers)
• Components to their respective GPIO pins
Software Stack
• MicroPython Runtime Environment
• Microdot Web Framework
• Custom Server Implementation
• Configuration Management System
Application Architecture
Create three main sections:
a. Core Server Components:
• Main Application (src/server/main.py)
• Server Handler (src/server/server.py)
• Route Definitions (src/server/routes.py)
• Configuration Handler (src/server/config_handler.py)
• Utility Functions (src/server/utils.py)
b. Device Management:
• Sensor Management
• LED Control
• Calibration System
c. External Interface:
• HATEOAS REST API
• WiFi Connection
Use a layered architecture approach
• [Client Layer]
• ↕ HTTP/REST
• [API Layer (HATEOAS)]
• ↕
• [Application Layer]
• ↕
• [Hardware Abstraction Layer]
• ↕
• [Physical Hardware Layer]
Data Flow Indicators
Special Considerations:
Configuration Management
• Relationship between TOML config files and runtime JSON
• Deployment process flow
• Calibration parameter handling
API Structure
• HATEOAS links between endpoints
• Filtering capabilities for sensors and LEDs
• Supported HTTP methods
Sensor Integration
• ADC conversion flow
• Calibration formula processing
• Demonstrate sensor data paths
Device Management
• Device discovery
• State management for actuators
• Error handling paths
Implementation Details:
Use standardized symbols
• ⬡ : Microcontroller
• ⬢ : Sensors/Actuators
• □ : Software Components
• ○ : API Endpoints
• ⟳ : Processing Units
• Sensor calibration flow
• Configuration deployment process
• API interaction patterns