Skip to content

Commit 6dbc163

Browse files
amrikarismaamrikarisma
committed
convert to modular
1 parent fe72ef4 commit 6dbc163

20 files changed

Lines changed: 1032 additions & 92 deletions

‎MODULARIZATION_STATUS.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# MAZDUINO Display Modularization Status
2+
3+
## Overview
4+
The ESP32 dashboard project has been successfully modularized from a single `.ino` file into multiple `.h` and `.cpp` files. The main file has been converted from `.ino` to `.cpp` format.
5+
6+
## File Structure
7+
8+
### Main Application
9+
- **main.cpp** - Main application file (replaces ESP32_DevkitC_3.5_SPI.ino)
10+
- **ESP32_DevkitC_3.5_SPI.ino.backup** - Backup of original file
11+
12+
### Modular Components
13+
14+
#### Configuration & Data
15+
- **Config.h** - System constants, pin definitions, and configuration
16+
- **DataTypes.h** - Global variable declarations
17+
- **GlobalVariables.cpp** - Global variable definitions
18+
19+
#### Hardware Modules
20+
- **BacklightControl.h/cpp** - PWM backlight control on pin 32
21+
- **CANHandler.h/cpp** - CAN communication and message parsing
22+
- **DisplayManager.h/cpp** - Display/UI management and rendering
23+
24+
#### Network & Communication
25+
- **WebServerHandler.h/cpp** - OTA updates and web server functionality
26+
- **Comms.h/cpp** - Serial communication with ECU (formerly Comms.ino)
27+
28+
#### Legacy/Utility Files
29+
- **drawing_utils.h** - Drawing utility functions
30+
- **text_utils.h** - Text utility functions
31+
- **NotoSansBold15.h** - Font definition
32+
- **NotoSansBold36.h** - Font definition
33+
- **splash.bmp** - Splash screen image
34+
35+
## Key Features Implemented
36+
37+
### 1. CAN ID 0x369 (Trigger System Error Count)
38+
- ✅ Added CAN0.watchFor(0x369) in setupCAN()
39+
- ✅ Implemented parsing in handleCANCommunication()
40+
- ✅ Added triggerError variable to DataTypes.h
41+
- ✅ Updated display to show "Trigger" instead of "FPS" when EEPROM.read(0) == 1
42+
- ✅ Updated Serial output to include "Trigger Error: " + triggerError
43+
44+
### 2. PWM Backlight Control
45+
- ✅ Added PWM setup for pin 32 in BacklightControl.cpp
46+
- ✅ Implemented automatic brightness adjustment based on RPM
47+
- ✅ Added initializeBacklight() and adjustBacklightAutomatically() functions
48+
- ✅ Removed old backlight defines from platformio.ini
49+
50+
### 3. Floating Point Display
51+
- ✅ Fixed AFR display to show floating point values (afrConv with 1 decimal)
52+
- ✅ Fixed Voltage display to show floating point values (bat with 1 decimal)
53+
- ✅ Used drawFloat() function in drawDataBox() for proper decimal display
54+
55+
### 4. Modularization
56+
- ✅ Separated concerns into logical modules
57+
- ✅ Clean include structure with proper header guards
58+
- ✅ Maintained backward compatibility with legacy utility files
59+
- ✅ Converted main file from .ino to .cpp format
60+
61+
## Function Distribution
62+
63+
### main.cpp
64+
- setup() - Main initialization
65+
- loop() - Main application loop
66+
- handleSerialCommunication() - Serial ECU communication
67+
68+
### CANHandler.cpp
69+
- setupCAN() - CAN initialization
70+
- handleCANCommunication() - CAN message processing
71+
- canTask() - FreeRTOS task for CAN
72+
73+
### DisplayManager.cpp
74+
- setupDisplay() - Display initialization
75+
- drawSplashScreenWithImage() - Startup splash screen
76+
- itemDraw() - UI element rendering
77+
- startUpDisplay() - Initial display setup
78+
- drawDataBox() - Individual data box rendering
79+
- drawData() - Main display update
80+
81+
### BacklightControl.cpp
82+
- initializeBacklight() - PWM setup
83+
- setBacklightBrightness() - Brightness control
84+
- adjustBacklightAutomatically() - Automatic brightness based on RPM
85+
86+
### WebServerHandler.cpp
87+
- setupWebServer() - Web server initialization
88+
- handleRoot() - Root page handler
89+
- handleUpdate() - OTA update handler
90+
- handleToggle() - Display toggle handler
91+
- handleWebServerClients() - Client management
92+
93+
## Build Configuration
94+
- **platformio.ini** - Updated with proper build flags
95+
- **src/main.cpp** - New main application file
96+
- All modules properly linked and included
97+
98+
## Usage
99+
1. The project should now build with PlatformIO
100+
2. CAN ID 0x369 (Trigger System Error Count) is automatically parsed and displayed
101+
3. PWM backlight control automatically adjusts based on RPM
102+
4. AFR and Voltage display as floating point values
103+
5. Modular structure allows easy maintenance and updates
104+
105+
## Notes
106+
- Original .ino file backed up as .ino.backup
107+
- All legacy functionality preserved
108+
- Web server features available but commented out in main.cpp
109+
- Serial communication mode still supported
110+
- All previous CAN IDs still supported with new 0x369 addition

‎src/BacklightControl.cpp‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#include "BacklightControl.h"
2+
#include "Config.h"
3+
#include "DataTypes.h"
4+
#include "Arduino.h"
5+
6+
void setupBacklight() {
7+
ledcSetup(BACKLIGHT_CHANNEL, BACKLIGHT_FREQ, BACKLIGHT_RESOLUTION);
8+
ledcAttachPin(BACKLIGHT_PIN, BACKLIGHT_CHANNEL);
9+
ledcWrite(BACKLIGHT_CHANNEL, BACKLIGHT_BRIGHTNESS);
10+
}
11+
12+
void setBacklightBrightness(uint8_t brightness) {
13+
ledcWrite(BACKLIGHT_CHANNEL, brightness);
14+
}
15+
16+
void adjustBacklightAutomatically() {
17+
static uint32_t lastBrightnessCheck = 0;
18+
19+
if (millis() - lastBrightnessCheck > 1000) { // Check every second
20+
uint8_t newBrightness = BACKLIGHT_BRIGHTNESS;
21+
22+
// Reduce brightness when engine is running (RPM > 500)
23+
if (rpm > 500) {
24+
newBrightness = 80; // Dimmer when driving
25+
} else {
26+
newBrightness = 150; // Brighter when idle/parked
27+
}
28+
29+
setBacklightBrightness(newBrightness);
30+
lastBrightnessCheck = millis();
31+
}
32+
}

‎src/BacklightControl.h‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#ifndef BACKLIGHT_CONTROL_H
2+
#define BACKLIGHT_CONTROL_H
3+
4+
#include <stdint.h>
5+
6+
// Function declarations
7+
void setupBacklight();
8+
void setBacklightBrightness(uint8_t brightness);
9+
void adjustBacklightAutomatically();
10+
11+
#endif // BACKLIGHT_CONTROL_H

‎src/CANHandler.cpp‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
#include "CANHandler.h"
2+
#include "Config.h"
3+
#include "DataTypes.h"
4+
#include <esp32_can.h>
5+
#include "Arduino.h"
6+
7+
void setupCAN() {
8+
CAN0.setCANPins(GPIO_NUM_17, GPIO_NUM_16); // RX, TX
9+
CAN0.begin(500000); // 500Kbps
10+
CAN0.watchFor(0x360); // RPM, MAP, TPS
11+
CAN0.watchFor(0x361); // Fuel Pressure
12+
CAN0.watchFor(0x362); // Ignition Angle (Leading)
13+
CAN0.watchFor(0x368); // AFR 01
14+
CAN0.watchFor(0x369); // Trigger System Error Count
15+
CAN0.watchFor(0x370); // VSS
16+
CAN0.watchFor(0x372); // Voltage
17+
CAN0.watchFor(0x3E0); // CLT, IAT
18+
CAN0.watchFor(0x3E4); // Indicator
19+
20+
Serial.println("CAN mode aktif.");
21+
}
22+
23+
void canTask(void *pvParameters) {
24+
while (1) {
25+
handleCANCommunication();
26+
vTaskDelay(1);
27+
}
28+
}
29+
30+
void handleCANCommunication() {
31+
static uint32_t lastRefresh = millis();
32+
uint32_t elapsed = millis() - lastRefresh;
33+
refreshRate = (elapsed > 0) ? (1000 / elapsed) : 0;
34+
lastRefresh = millis();
35+
unsigned long currentTime = millis();
36+
37+
if (CAN0.available()) {
38+
CAN_FRAME can_message;
39+
if (CAN0.read(can_message)) {
40+
// Process data based on ID
41+
switch (can_message.id) {
42+
case 0x360: {
43+
rpm = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
44+
uint16_t map = (can_message.data.byte[2] << 8) | can_message.data.byte[3];
45+
uint16_t tps_raw = (can_message.data.byte[4] << 8) | can_message.data.byte[5];
46+
mapData = map / 10.0;
47+
tps = tps_raw / 10.0;
48+
break;
49+
}
50+
case 0x361: {
51+
uint16_t fuel_pressure = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
52+
fp = fuel_pressure / 10 - 101.3;
53+
break;
54+
}
55+
case 0x368: {
56+
uint16_t afr_raw = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
57+
float lambda = afr_raw / 1000.0;
58+
afrConv = lambda * 14.7;
59+
break;
60+
}
61+
case 0x369: {
62+
uint16_t trigger_raw = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
63+
triggerError = trigger_raw;
64+
break;
65+
}
66+
case 0x370: {
67+
uint16_t vss_raw = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
68+
vss = vss_raw / 10.0;
69+
break;
70+
}
71+
case 0x372: {
72+
uint16_t voltage = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
73+
bat = voltage / 10.0;
74+
break;
75+
}
76+
case 0x3E0: {
77+
uint16_t clt_raw = (can_message.data.byte[0] << 8) | can_message.data.byte[1];
78+
uint16_t iat_raw = (can_message.data.byte[2] << 8) | can_message.data.byte[3];
79+
float clt_k = clt_raw / 10.0;
80+
float iat_k = iat_raw / 10.0;
81+
clt = clt_k - 273.15;
82+
iat = iat_k - 273.15;
83+
break;
84+
}
85+
case 0x3E4: {
86+
dfco = (can_message.data.byte[1] << 8) | can_message.data.byte[4];
87+
launch = (can_message.data.byte[2] << 8) | can_message.data.byte[6];
88+
airCon = (can_message.data.byte[3] << 8) | can_message.data.byte[4];
89+
fan = (can_message.data.byte[3] << 8) | can_message.data.byte[0];
90+
rev = (can_message.data.byte[2] << 8) | can_message.data.byte[5];
91+
break;
92+
}
93+
case 0x362: {
94+
uint16_t adv_raw = (can_message.data.byte[4] << 8) | can_message.data.byte[5];
95+
adv = adv_raw / 10.0;
96+
break;
97+
}
98+
default:
99+
break;
100+
}
101+
} else {
102+
Serial.println("Error reading CAN message.");
103+
}
104+
}
105+
106+
if (currentTime - lastPrintTime >= 1000) {
107+
Serial.print("RPM: ");
108+
Serial.print(rpm);
109+
Serial.print(" MAP: ");
110+
Serial.print(mapData);
111+
Serial.print(" kPa TPS: ");
112+
Serial.print(tps);
113+
Serial.print(" % ADV:");
114+
Serial.print(adv);
115+
Serial.print(" ° Fuel Pressure: ");
116+
Serial.print(fp);
117+
Serial.print(" kPa AFR: ");
118+
Serial.print(afrConv, 2);
119+
Serial.print(" VSS: ");
120+
Serial.print(vss);
121+
Serial.print(" km/h Voltage: ");
122+
Serial.print(bat, 2);
123+
Serial.print(" V CLT: ");
124+
Serial.print(clt);
125+
Serial.print(" °C IAT: ");
126+
Serial.print(iat);
127+
Serial.print(" °C Trigger Error: ");
128+
Serial.print(triggerError);
129+
Serial.println();
130+
131+
lastPrintTime = currentTime;
132+
}
133+
}

‎src/CANHandler.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#ifndef CAN_HANDLER_H
2+
#define CAN_HANDLER_H
3+
4+
// Function declarations
5+
void setupCAN();
6+
void handleCANCommunication();
7+
void canTask(void *pvParameters);
8+
9+
#endif // CAN_HANDLER_H

src/Comms.ino renamed to src/Comms.cpp

File renamed without changes.

‎src/Config.h‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#ifndef CONFIG_H
2+
#define CONFIG_H
3+
4+
// Firmware version
5+
extern const char *version;
6+
7+
// WiFi Configuration
8+
extern const char *ssid;
9+
extern const char *password;
10+
11+
// Pin definitions
12+
#define UART_BAUD 115200
13+
#define RXD 16
14+
#define TXD 17
15+
16+
// Backlight control
17+
#define BACKLIGHT_PIN 32
18+
#define BACKLIGHT_CHANNEL 0
19+
#define BACKLIGHT_FREQ 5000
20+
#define BACKLIGHT_RESOLUTION 8
21+
#define BACKLIGHT_BRIGHTNESS 100 // 0-255 (0 = off, 255 = max brightness)
22+
23+
// Communication modes
24+
#define COMM_CAN 0
25+
#define COMM_SERIAL 1
26+
27+
// Other constants
28+
#define EEPROM_SIZE 512
29+
30+
// Font definitions
31+
#define AA_FONT_SMALL NotoSansBold15
32+
#define AA_FONT_LARGE NotoSansBold36
33+
34+
#endif // CONFIG_H

‎src/DataTypes.h‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#ifndef DATATYPES_H
2+
#define DATATYPES_H
3+
4+
#include <stdint.h>
5+
6+
// Global variables for ECU data
7+
extern uint8_t iat, clt;
8+
extern uint8_t refreshRate;
9+
extern unsigned int rpm, lastRpm, vss;
10+
extern int mapData, tps, adv, fp, triggerError;
11+
extern float bat, afrConv;
12+
extern bool syncStatus, fan, ase, wue, rev, launch, airCon, dfco;
13+
14+
// Last values for comparison
15+
extern int lastIat, lastClt, lastTps, lastAdv, lastMapData, lastFp, lastTriggerError;
16+
extern float lastBat, lastAfrConv;
17+
extern unsigned int lastRefreshRate;
18+
19+
// System variables
20+
extern bool first_run;
21+
extern uint32_t lastPrintTime;
22+
extern uint32_t startupTime;
23+
extern uint32_t lazyUpdateTime;
24+
extern uint16_t spr_width;
25+
26+
// Communication variables
27+
extern int commMode;
28+
extern bool sent, received;
29+
30+
// WiFi variables
31+
extern bool wifiActive;
32+
extern uint32_t lastClientCheck;
33+
extern uint32_t lastClientCheckTimeout;
34+
extern uint32_t wifiTimeout;
35+
extern bool clientConnected;
36+
37+
#endif // DATATYPES_H

0 commit comments

Comments
 (0)