Skip to content

Commit b4c2b4c

Browse files
committed
readme_update: Updated the readme file for "System Design" and "Project Hightlights" sections
1 parent 329eeb8 commit b4c2b4c

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

README.md

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,53 @@
1414
<!-- System Design -->
1515
<img src="./readme/title3.svg"/>
1616

17-
### Add Title Here
17+
### ER Diagram
18+
19+
<center>
20+
<img src="./readme/demo/Amp_Intelligence.png"/>
21+
</center>
22+
23+
<br />
24+
25+
## System Design - Database Schema Overview
26+
The Amp Intelligence platform utilizes a relational database schema designed to support a scalable, secure, and modular architecture for intelligent energy monitoring and user management. The schema is optimized for clarity in data ownership, role-based access, and historical data collection, ensuring robust data integrity and efficient query performance.
27+
28+
### Core Entities & Relationships
29+
### 1) Users
30+
31+
- Centralized user management is facilitated through the Users table, which supports multiple user roles: Clients, Providers, and Admins. This enables clear segregation of access rights and responsibilities.
32+
33+
- The schema supports optional direct mapping between Users and Slaves, ensuring traceability of device ownership per client.
34+
35+
- The design ensures flexibility to support role-based data visualization and management in both the platform’s dashboard and APIs.
36+
37+
### 2) Masters & Slaves
38+
39+
- The Masters table represents the core energy monitoring controllers, typically installed and managed by provider entities (linked via user_id).
40+
41+
- Each Master can manage multiple Slaves, which represent individual monitored assets or devices. The Slaves are associated back to the Masters and can also link directly to Users (clients) via the slave_id field in the Users table, ensuring traceability of monitored assets.
1842

19-
- To be decided on later on.
43+
### 3) Metrics & Lines
44+
45+
- The Metrics table serves as the historical data ledger, storing essential telemetry such as voltage, current, power, and energy per Slave and Master device, organized on a monthly basis for performance optimization.
46+
47+
- The Lines table provides additional granularity by storing per-phase measurements (L1, L2, L3) and is directly linked to the Masters. This supports detailed line-level diagnostics, crucial for industrial-grade energy analytics.
48+
49+
### 4) Contact Forms
50+
51+
- User-generated communication is handled by the Contact_Forms table, ensuring that feedback, support requests, and queries are traceable to specific users.
52+
53+
- This supports seamless user support workflows and ensures accountability.
54+
55+
### 5) Design Principles
56+
- Scalability & Modularity: The schema supports multi-tenant architecture, where Providers can manage multiple Masters and Clients can own specific Slaves. This allows the platform to scale horizontally by simply extending these relationships.
57+
58+
- Data Integrity & Traceability: All critical records are timestamped (created_at, updated_at), supporting full audit trails. Foreign key relationships ensure data consistency across all levels.
59+
60+
- Performance Considerations: Metrics are decoupled into Metrics and Lines, optimizing for both high-frequency telemetry capture and in-depth line-level analysis without query performance degradation.
61+
62+
### Summary
63+
This ERD lays the foundation for Amp Intelligence’s core platform services by enabling structured, efficient, and secure energy data management while providing flexibility for future expansion, including integrations with third-party platforms, advanced reporting engines, and AI-driven anomaly detection systems.
2064

2165
<br><br>
2266

@@ -25,9 +69,11 @@
2569

2670
### The Most Remarkable Features
2771

28-
- Send Data from ESP32 microcontroller and store them into the database.
29-
- Send AI prediction to providers that predicts the power usage of clients based on thier previous power usage months.
30-
- Send AI plan for clients that helps them optimize their power consumption.
72+
- <b>Seamless IoT Data Ingestion:</b> The system integrates with ESP32 microcontrollers to capture real-time energy consumption data from client devices. This data is securely transmitted and stored in the platform's centralized database, ensuring accurate and continuous monitoring of power usage.
73+
74+
- <b>AI-Powered Consumption Forecasting for Providers:</b> Leveraging advanced AI models, the platform provides energy providers with predictive analytics based on historical consumption patterns. These insights enable providers to anticipate client power demand, enhance load management, and optimize resource allocation.
75+
76+
- <b>Personalized AI Optimization Plans for Clients:</b> The system offers clients intelligent, data-driven power usage plans. By analyzing past consumption behaviors, the AI recommends actionable strategies to optimize energy usage, reduce costs, and promote sustainable consumption habits.
3177

3278
<br><br>
3379

0 commit comments

Comments
 (0)