How kizniche/mycodo works
Project Type and Purpose
• Mycodo is a full-stack environmental regulation system for SBCs (Raspberry Pi). It couples sensor “Inputs,” control “Functions,” and actuator “Outputs” in a daemon process, and exposes a Flask-based Web UI (and REST API) for configuration, visualization, and management. It uses a relational database (via SQLAlchemy/Alembic) for system configuration and a time-series database (InfluxDB) for measurement data.
Main Components
a. Hardware Layer (Sensors & Actuators)
• GPIO, I²C, SPI, UART sensors (temperature, humidity, CO₂, etc.)
• Actuators: relays, PWM devices, pumps, LEDs, motors
b. Mycodo Daemon (“mycodo_daemon.py”)
• Loads Controllers: InputController, FunctionController, OutputController, ConditionalController, PIDController, TriggerController, WidgetController
• Interfaces to hardware (mycodo/inputs, mycodo/outputs, mycodo/devices)
• Writes measurement points to InfluxDB (via mycodo/utils/influx.py)
• Reads configuration from SQL database (via SQLAlchemy models, migrations in alembic_db/)
• Executes Functions (control logic), dispatches Actions
• Communicates with Web UI via REST (Flask-RESTX) or Pyro5 for remote module calls
c. Relational Database
• SQLAlchemy ORM models in mycodo/databases/models/
• Alembic migration scripts in alembic_db/
• Stores users, roles, dashboards, inputs/outputs/functions configuration, notes, logs, themes
d. Time-Series Database (InfluxDB)
• Measurements: stored by the daemon for graphing and alerts
• Dockerized InfluxDB container in docker/influxdb/
e. Web Interface (“mycodo_flask”)
• Flask application using Gunicorn (or native Python) behind Nginx (docker/nginx/)
• Static assets, templates, forms, REST API endpoints in mycodo/mycodo_flask/
• Reads configuration from SQL DB, queries InfluxDB for graphs
• Exposes REST API (flask_restx) for external clients
f. Auxiliary Services (Docker Compose)
• Grafana (docker/grafana/) for alternate visualization
• Telegraf (docker/telegraf/) for instrumentation
• Logrotate service, reverse proxy Nginx, environment scripts
Relationships and Data Flow
1. Sensors → Daemon InputController → Measurement Data → InfluxDB
2. Daemon FunctionController → Control logic → OutputController → Actuators
3. Daemon ↔ Relational DB (configuration read/write)
4. Web UI ↔ Relational DB (read/write configs, user management)
5. Web UI ↔ InfluxDB (read time-series for dashboards)
6. Web UI ↔ Daemon (REST API for real-time status, remote commands)
7. External Services (Grafana) ↔ InfluxDB for monitoring
8. Nginx routes external HTTP(S) to Web UI / API
Architectural Patterns
• Modular plugin architecture for Inputs, Outputs, Functions, Actions, Widgets
• Controller pattern: separate controllers for each subsystem
• Layered architecture: Hardware → Daemon → Storage → Web UI
• Micro-service style in Docker: each service in its own container
• MVC-like in the Web UI: forms and templates separate from routes and models
Technologies & Frameworks
• Python 3, Flask, Flask-RESTX, Gunicorn, SQLAlchemy, Alembic, InfluxDB, Pyro5
• Docker, Docker-Compose, Nginx, Telegraf, Grafana
• Frontend: Bootstrap 4, jQuery, gridstack.js, Highcharts