updated some comments after migrating stuff from other Project

This commit is contained in:
2024-05-30 23:48:26 +02:00
parent cf76ea7cc7
commit 5ee0a23a6d
9 changed files with 17 additions and 80 deletions

View File

@@ -1,9 +1,9 @@
/**
* @file debugger.h
*
* @brief Header file for debugging functions and status in the ChainLube application.
* @brief Header file for debugging functions and status in the DE-Timer application.
*
* This file declares functions and status definitions for debugging purposes in the ChainLube project.
* This file declares functions and status definitions for debugging purposes in the DE-Timer project.
* It includes functions to print system information, WiFi information, format EEPROM data,
* handle debug messages, and manage the status of different debug ports.
*

View File

@@ -1,10 +1,10 @@
/**
* @file dtc.h
*
* @brief Header file for handling Diagnostic Trouble Codes (DTC) in the ChainLube application.
* @brief Header file for handling Diagnostic Trouble Codes (DTC) in the DE-Timer application.
*
* This file provides definitions and functions for handling Diagnostic Trouble Codes (DTC)
* in the ChainLube project. It includes structures for DTC entries, severity levels,
* in the DE-Timer project. It includes structures for DTC entries, severity levels,
* and functions for DTC maintenance and processing. DTCs are used to track system errors and issues.
*
* @author Marcel Peterkau

View File

@@ -1,9 +1,9 @@
/**
* @file dtc_defs.h
*
* @brief Header file for Diagnostic Trouble Code (DTC) definitions in the ChainLube application.
* @brief Header file for Diagnostic Trouble Code (DTC) definitions in the DE-Timer application.
*
* This file contains definitions for Diagnostic Trouble Codes (DTC) in the ChainLube project.
* This file contains definitions for Diagnostic Trouble Codes (DTC) in the DE-Timer project.
* It includes enums for DTC active status, severity levels, and specific DTC codes.
* The file also defines an array of DTC definitions and a timestamp indicating the generation time.
*

View File

@@ -4,9 +4,8 @@
* @brief Header file for configuration settings and EEPROM operations in the DE-Timer application.
*
* This file defines configuration settings for the DE-Timer project, including default values,
* EEPROM structures, and functions for EEPROM operations. It also defines enums for different sources
* of speed input, GPS baud rates, and CAN bus sources. Additionally, it includes functions for EEPROM handling
* such as storing, retrieving, and formatting configuration data.
* EEPROM structures, and functions for EEPROM operations. It also defines enums for different Battery Types.
* Additionally, it includes functions for EEPROM handling such as storing, retrieving, and formatting configuration data.
*
* @author Marcel Peterkau
* @date 09.01.2024
@@ -22,7 +21,7 @@
#include "common.h"
#define I2C_EE_ADDRESS 0x50
#define EEPROM_STRUCTURE_REVISION 3 // Increment this version when changing EEPROM structures
#define EEPROM_STRUCTURE_REVISION 4 // Increment this version when changing EEPROM structures
#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC256
typedef enum Factions_e
@@ -97,7 +96,7 @@ const configData_t ConfigData_defaults = {
"FACTION 1", // Faction_1_Name
"FACTION 2", // Faction_2_Name
"FACTION 3", // Faction_3_Name
"ChainLube",
"ArisoftTimer",
QUOTE(WIFI_AP_PASSWORD),
QUOTE(WIFI_SSID_CLIENT),
QUOTE(WIFI_PASSWORD_CLIENT),

View File

@@ -31,8 +31,8 @@ typedef struct Constants_s
} Constants_t;
const Constants_t constants PROGMEM = {
1, 4, // Firmware_Version
1, 4, // Required Flash Version
1, 5, // Firmware_Version
1, 5, // Required Flash Version
GIT_REV // Git-Hash-String
};

View File

@@ -1,20 +0,0 @@
#ifndef _OLED_DISPLAY_H_
#define _OLED_DISPLAY_H_
#include <Arduino.h>
#include <Wire.h>
#include <Adafruit_GFX.h>
#include <Adafruit_SSD1306.h>
#include "globals.h"
#include "eeprom.h"
#define OLED_SDA 4
#define OLED_SCL 15
#define OLED_RST 16
#define SCREEN_WIDTH 128 // OLED display width, in pixels
#define SCREEN_HEIGHT 64 // OLED display height, in pixels
void OLED_Init();
void OLED_Process();
#endif

View File

@@ -1,7 +1,7 @@
/**
* @file webui.h
*
* @brief Header file for the web-based user interface (WebUI) in the ChainLube application.
* @brief Header file for the web-based user interface (WebUI) in the DE-Timer application.
*
* This file contains declarations for functions related to the initialization and processing of the
* web-based user interface (WebUI). It includes the necessary libraries and dependencies for handling