PyELSSA 0.1.0__py3-none-any.whl

PyELSSA/gui/gui_sub_frame.py

@@ -0,0 +1,414 @@
+# -*- coding: utf-8 -*-
+#=================================================================
+# Created by: Jieming Ye
+# Created on: Feb 2024
+# Last Modified: Feb 2024
+#=================================================================
+# Copyright (c) 2024 [Jieming Ye]
+#
+# This Python source code is licensed under the 
+# Open Source Non-Commercial License (OSNCL) v1.0
+# See LICENSE for details.
+#=================================================================
+"""
+This file defines action pages for the PyELSSA GUI.
+"""
+#=================================================================
+# VERSION CONTROL
+# V1.0 (Jieming Ye) - Initial Version
+#=================================================================
+
+import tkinter as tk
+from tkinter import ttk
+
+from PyELSSA.shared_contents import SharedVariables
+from PyELSSA.gui.gui_base_frame import BasePage
+
+
+class ActionPage(BasePage):
+    config = None
+
+    def __init__(self, parent, controller):
+        super().__init__(parent, controller)
+        self.field_vars = {}
+        self.selection_var = tk.StringVar(value='0')
+        self.build_page()
+
+    def build_page(self):
+        if not self.config:
+            return
+
+        title = self.create_label(self.headframe, self.config['title'], style='PageTitle.TLabel')
+        title.pack(anchor='w', pady=(0, 8))
+
+        description = self.create_label(self.headframe, self.config.get('description', ''), style='PageText.TLabel', wraplength=860, justify='left')
+        description.pack(anchor='w', pady=(0, 8))
+
+        for note in self.config.get('notes', []):
+            note_label = self.create_label(self.headframe, note, style='Info.TLabel', wraplength=860, justify='left')
+            note_label.pack(anchor='w', pady=(0, 6))
+
+        if self.config.get('configs'):
+            config_section = self.create_section(self.contentframe,title='Configuration')
+            columns = 4
+            for idx, cfg in enumerate(self.config['configs']):
+                row = idx // columns
+                col = idx % columns
+                var = tk.BooleanVar(value=False)
+                self.config_vars[cfg['name']] = var
+                chk = ttk.Checkbutton(config_section,text=cfg['label'],variable=var)
+                chk.grid(row=row,column=col,sticky='w',padx=10,pady=4)
+
+            for col in range(columns):
+                config_section.columnconfigure(col, weight=1)
+
+        if self.config.get('options'):
+            options_section = self.create_section(self.contentframe, title='Options')
+            for row, option in enumerate(self.config['options']):
+                radio = self.create_radio(options_section, option['label'], self.selection_var, option['value'])
+                radio.grid(row=row, column=0, sticky='w', padx=(0, 12), pady=4, columnspan=2)
+            options_section.columnconfigure(0, weight=1)
+
+        fields_section = self.create_section(self.contentframe, title='Inputs')
+        for row, field in enumerate(self.config.get('fields', [])):
+            label = self.create_label(fields_section, field['label'], style='OptionText.TLabel')
+            label.grid(row=row, column=0, sticky='w', padx=(0, 12), pady=6)
+
+            var = tk.StringVar()
+            self.field_vars[field['name']] = var
+            if field['type'] == 'file':
+                entry = self.create_entry(fields_section, var, width=40)
+                entry.grid(row=row, column=1, sticky='w', padx=(0, 12), pady=6)
+                select_button = self.create_button(fields_section, field.get('button', 'Select'), lambda v=var: self.auto_file_select(v), style='Secondary.TButton')
+                select_button.grid(row=row, column=2, sticky='w', pady=6)
+            else:
+                entry = self.create_entry(fields_section, var, width=30)
+                entry.grid(row=row, column=1, sticky='w', padx=(0, 12), pady=6)
+
+        run_section = self.create_section(self.contentframe, title='Action')
+        run_button = self.create_button(run_section, 'RUN', self._run_action)
+        run_button.pack(side='left', pady=8)
+
+        footer = self.create_frame(padding=(0, 0))
+        self.create_button(footer, 'Back to Home', lambda: self.controller.show_frame('StartPage')).pack(side='left', padx=6, pady=8)
+        self.create_button(footer, 'Back to Processing', lambda: self.controller.show_frame(self.config.get('back_target', 'StartPage')), style='Secondary.TButton').pack(side='left', padx=6, pady=8)
+
+    def _run_action(self):
+        inputs = {}
+        if self.config.get('configs'):
+            inputs['configs'] = {
+            name: var.get()
+            for name, var in self.config_vars.items()
+            }
+        if self.config.get('options'):
+            inputs['option_select'] = self.selection_var
+        for field in self.config.get('fields', []):
+            inputs[field['name']] = self.field_vars[field['name']]
+        self.run_new_thread_or_process(self.config['script'], **inputs)
+
+        # data passing structure example
+        # {
+        # 'configs': {
+        #     'setup': True,
+        #     'config': False,
+        #     'vision': True,
+        #     'validate': False
+        # },
+        # 'option_select': 'rail',
+        # 'input_file': 'model.xlsx'
+        # }
+
+ACTION_PAGE_CONFIGS = {
+    'P01': {
+        'title': 'Page 1: List OSLO Train Data',
+        'description': 'Generate step outputs for OSLO trains. Copy and paste results into Excel for further analysis.',
+        'notes': ['NOTE: Option 3 and Option 4 require a Branch List text file.'],
+        'options': [
+            {'label': 'Option 1: List all trains step output from the simulation', 'value': '1'},
+            {'label': 'Option 2: List all trains step output From Start to End', 'value': '2'},
+            {'label': 'Option 3: List selected branches for the whole simulation window', 'value': '3'},
+            {'label': 'Option 4: List selected branches From Start to End', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'text_input', 'label': 'Customised Branch File Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'list_file_processing.py',
+        'back_target': 'PageFour',
+    },
+    'P02': {
+        'title': 'Page 2: Low Voltage Analysis',
+        'description': 'Produce voltage-based reports and summaries for trains and branches.',
+        'notes': ['NOTE: Option 3 and Option 4 require a Branch List text file.'],
+        'options': [
+            {'label': 'Option 1: Processing whole simulation', 'value': '1'},
+            {'label': 'Option 2: Processing customised time window', 'value': '2'},
+            {'label': 'Option 3: Processing customised branches', 'value': '3'},
+            {'label': 'Option 4: Processing customised branches during customised time window', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'low_v', 'label': 'Low Voltage Threshold (max 5 digit)', 'type': 'entry'},
+            {'name': 'time_start', 'label': 'Output From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Output To (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'text_input', 'label': 'Customised Branch File Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'list_file_processing.py',
+        'back_target': 'PageFour',
+    },
+    'P03': {
+        'title': 'Page 3: AC - Supply Points Load Analysis',
+        'description': 'Requires an Excel spreadsheet with predefined information for average power analysis.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import "Excel - For Average Power" if needed.'],
+        'options': [
+            {'label': 'Option 1: Full Auto Process (Require .oof + .lst.txt files)', 'value': '1'},
+            {'label': 'Option 2: Auto process with user defined node configuration (Only require .oof file)', 'value': '2'},
+            {'label': 'Option 3: Update spreadsheet only (Require .d4 + .mxn)', 'value': '3'},
+            {'label': 'Option 4: Extract d4 and mxn only (Only require .oof file)', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'average_load.py',
+        'back_target': 'PageFive',
+    },
+    'P04': {
+        'title': 'Page 4: Umeanuseful Analysis',
+        'description': 'Produces Umean useful dashboards as per BS EN 50388. Choose the right train selection for the assessment.',
+        'notes': ['NOTE: Import UmeanSettingTemplate.csv for Option 2.', 'NOTE: Require *.lst.txt file within the current folder.'],
+        'options': [
+            {'label': 'Option 1: Auto Configuration (Hourly Window + Supply Point Zone)', 'value': '1'},
+            {'label': 'Option 2: Auto + Customised Settings', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Umeanuseful Settings (.csv)', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Peak time From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Peak time To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'umeanuseful.py',
+        'back_target': 'PageFive',
+    },
+    'P05': {
+        'title': 'Page 5: AC - Incoming Feeder Protection',
+        'description': 'Preliminary assessment of incoming feeder protection based on relay type.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import "Excel - For IF Protection" if needed.'],
+        'options': [
+            {'label': 'Option 1: Full Auto Process (Require .oof files)', 'value': '1'},
+            {'label': 'Option 2: Update Spreadsheet only (Require .d4 files)', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'protection_if.py',
+        'back_target': 'PageFive',
+    },
+    'P06': {
+        'title': 'Page 6: AC - New Supply Point Connection Assessment',
+        'description': 'Assessment for new supply points requiring a defined Excel template.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import "Excel - For New SP Connect" if needed.'],
+        'options': [
+            {'label': 'Option 1: Full Auto Process (Require .oof files)', 'value': '1'},
+            {'label': 'Option 2: Update Spreadsheet only (Require extracted .d4 files)', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'grid_connection.py',
+        'back_target': 'PageFive',
+    },
+    'P07': {
+        'title': 'Page 7: AC - OLE Current Rating Assessment',
+        'description': 'Assessment of OLE current ratings using the provided Excel spreadsheet.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import "Excel - For OLE Rating" if needed.'],
+        'options': [
+            {'label': 'Option 1: Full Auto Process (Require .oof files)', 'value': '1'},
+            {'label': 'Option 2: Update Spreadsheet only (Require .d4 files)', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'ole_processing.py',
+        'back_target': 'PageFive',
+    },
+    'P08': {
+        'title': 'Page 8: AC - Static Frequency Converter Assessment',
+        'description': 'SFC assessment using Excel input and optional file extraction.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import "Excel - For SFC" if needed.'],
+        'options': [
+            {'label': 'Option 1: Full Auto Process', 'value': '1'},
+            {'label': 'Option 2: Auto process with node configuration', 'value': '2'},
+            {'label': 'Option 3: Update spreadsheet only', 'value': '3'},
+            {'label': 'Option 4: Extract d4/mxn only', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'sfc_assess.py',
+        'back_target': 'PageFive',
+    },
+    'P09': {
+        'title': 'Page 9: Substation TRU Assessment Data Prepare',
+        'description': 'Create substation assessment files and load summaries for TRU and grid calculations.',
+        'notes': ['NOTE: "FeederList.txt" is required before clicking RUN.'],
+        'options': [
+            {'label': 'Option 1: Substation RMS and average power summary', 'value': '1'},
+            {'label': 'Option 2: Grid Calculation (requires GridAllocation.csv)', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'batch_processing.py',
+        'back_target': 'PageSix',
+    },
+    'P10': {
+        'title': 'Page 10: Substation Protection / Track CB & ETE Assessment',
+        'description': 'Generate branch assessment summaries and rolling RMS calculations.',
+        'notes': ['NOTE: Time window is compulsory.', 'NOTE: Option 4-6 require BranchNodeList.txt.'],
+        'options': [
+            {'label': 'Option 1: All branches step output summary', 'value': '1'},
+            {'label': 'Option 2: All branches rolling RMS current calculation', 'value': '2'},
+            {'label': 'Option 3: All branches maximum rolling RMS current summary', 'value': '3'},
+            {'label': 'Option 4: Customised branches step output summary', 'value': '4'},
+            {'label': 'Option 5: Customised branches rolling RMS calculation', 'value': '5'},
+            {'label': 'Option 6: Customised branches maximum rolling RMS summary', 'value': '6'},
+        ],
+        'fields': [
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_step', 'label': 'Time Seconds (0-86400)', 'type': 'entry'},
+        ],
+        'script': 'batch_processing.py',
+        'back_target': 'PageSix',
+    },
+    'P11': {
+        'title': 'Page 11: DC Substation Assessment Summary',
+        'description': 'Create summary reports for DC ratings and train voltage assessments.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.'],
+        'options': [
+            {'label': 'Option 1: TRU Summary', 'value': '1'},
+            {'label': 'Option 2: Main DC Circuit Breaker Summary', 'value': '2'},
+            {'label': 'Option 3: DC Busbar Summary', 'value': '3'},
+            {'label': 'Option 4: Negative ETE Summary', 'value': '4'},
+            {'label': 'Option 5: Impedance Bond Summary', 'value': '5'},
+            {'label': 'Option 6: Track Circuit Breaker Summary', 'value': '6'},
+            {'label': 'Option 7: Positive ETE Summary', 'value': '7'},
+            {'label': 'Option 8: Train Min Voltage Summary', 'value': '8'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'dc_summary.py',
+        'back_target': 'PageSix',
+    },
+    'P12': {
+        'title': 'Page 12: DC Single End Feeding 1st Stage Processing',
+        'description': 'Estimate single end feeding loads for preliminary DC assessment.',
+        'notes': ['NOTE: Time window is compulsory.', 'NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.'],
+        'options': [
+            {'label': 'Option 1: TCB Assessment (15min RMS)', 'value': '1'},
+            {'label': 'Option 2: ETE Assessment (30min RMS)', 'value': '2'},
+            {'label': 'Option 3: TCB Assessment with CSV step outputs', 'value': '3'},
+            {'label': 'Option 4: ETE Assessment with CSV step outputs', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'dc_single_end_feeding.py',
+        'back_target': 'PageSix',
+    },
+    'P13': {
+        'title': 'Page 13: Battery EMU Assessment',
+        'description': 'Battery EMU assessment workflows with simple and detailed modes.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Import the matching Excel template as required for your option.'],
+        'options': [
+            {'label': 'Option 1: Preliminary Assessment (Quick BEMU)', 'value': '1'},
+            {'label': 'Option 2: Update spreadsheet only (Quick BEMU)', 'value': '2'},
+            {'label': 'Option 3: Detailed Modelling Auto Assessment (<RN29)', 'value': '3'},
+            {'label': 'Option 4: Update spreadsheet only (<RN29)', 'value': '4'},
+            {'label': 'Option 5: New BEMU Assessment (>RN29)', 'value': '5'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'battery_processing.py',
+        'back_target': 'PageFour',
+    },
+    'P14': {
+        'title': 'Page 14: DC Falling Voltage Protection Processing',
+        'description': 'Assess falling voltage protection and optional step result plots.',
+        'notes': ['NOTE: Time window is compulsory.', 'NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.'],
+        'options': [
+            {'label': 'Option 1: FVP assessment with OSOP extraction', 'value': '1'},
+            {'label': 'Option 2: FVP assessment with OSOP extraction and plots', 'value': '2'},
+            {'label': 'Option 3: FVP assessment only', 'value': '3'},
+            {'label': 'Option 4: FVP assessment with plots only', 'value': '4'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+            {'name': 'time_start', 'label': 'Extraction From (Format: DHHMMSS)', 'type': 'entry'},
+            {'name': 'time_end', 'label': 'Extraction To (Format: DHHMMSS)', 'type': 'entry'},
+        ],
+        'script': 'dc_falling_voltage_protection.py',
+        'back_target': 'PageSix',
+    },
+    'P15': {
+        'title': 'Page 15: Low Voltage Summary',
+        'description': 'Create a low voltage summary from train step results.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Train_list.csv within each simulation folder is required.'],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'low_v_summary.py',
+        'back_target': 'PageFour',
+    },
+    'P16': {
+        'title': 'Page 16: Batch Operation Settings',
+        'description': 'Run multiple analysis options in an unattended batch sequence.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.'],
+        'options': [
+            {'label': 'Option 1: Run under root folder (recommended)', 'value': '1'},
+            {'label': 'Option 2: Run from anywhere (beta)', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'all_in_one_processing.py',
+        'back_target': 'PageFour',
+    },
+    'P17': {
+        'title': 'Page 17: Voltage Profile Assessment',
+        'description': 'Plot low pantograph voltage profiles for branches and filtered time windows.',
+        'notes': ['NOTE: Excel spreadsheet in .xlsx format is required before clicking RUN.', 'NOTE: Train_list.csv within each simulation folder is required.'],
+        'options': [
+            {'label': 'Option 1: Plot low voltage summary only', 'value': '1'},
+            {'label': 'Option 2: Plot all pantograph voltage', 'value': '2'},
+        ],
+        'fields': [
+            {'name': 'text_input', 'label': 'Excel Name', 'type': 'file', 'button': 'Select'},
+        ],
+        'script': 'low_v_plot.py',
+        'back_target': 'PageFour',
+    },
+}
+
+
+def create_action_page_class(name, config):
+    return type(name, (ActionPage,), {'config': config})
+
+for page_name, page_config in ACTION_PAGE_CONFIGS.items():
+    globals()[page_name] = create_action_page_class(page_name, page_config)

PyELSSA/licensing.py

@@ -0,0 +1,224 @@
+#
+# -*- coding: utf-8  -*-
+#=================================================================
+# Created by: Jieming Ye
+# Created on: Aug 2026
+# Last Modified: Aug 2026
+#=================================================================
+# Copyright (c) 2026 [Jieming Ye]
+#
+# This Python source code is licensed under the 
+# Open Source Non-Commercial License (OSNCL) v1.0
+# See LICENSE for details.
+#=================================================================
+"""
+Pre-requisite: 
+N/A
+Used Input:
+N/A
+Expected Output:
+True/Flase
+Description:
+This module is the license process
+
+"""
+#=================================================================
+# VERSION CONTROL
+# V1.0 (Jieming Ye) - Initial Version
+# V2.0 (Jieming Ye) - Configuration File Processing added
+#=================================================================
+# Set Information Variable
+# N/A
+#=================================================================
+
+import os
+import uuid
+import requests
+import psutil
+import json
+from datetime import datetime, timedelta
+
+from PyELSSA.shared_contents import SharedVariables
+from PyELSSA.shared_contents import SharedMethods
+
+# Constants for file path
+LICENSE_FILE = SharedVariables.license_file
+
+# Function to get the MAC address of the current machine
+def get_mac_address():
+    mac_addresses = []
+    try:
+        # mac_code = uuid.UUID(int=uuid.getnode()).hex[-12:]
+        # mac = ":".join([mac_code[e:e+2] for e in range(0, 11, 2)])        
+        for interface, addrs in psutil.net_if_addrs().items():
+            for addr in addrs:
+                if addr.family == psutil.AF_LINK:  # AF_LINK corresponds to MAC addresses
+                    # mac_addresses.append((interface, addr.address)) # Return interface name and MAC address
+                    mac_addresses.append(addr.address)
+
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Fail to read mac address: {e}","31")
+
+    return mac_addresses
+
+# Function to fetch the allowed MAC addresses from an online file
+def fetch_allowed_macs(url):
+    try:
+        response = requests.get(url, timeout=5)
+        response.raise_for_status()  # Check for HTTP errors
+        lines = response.text.splitlines()
+        
+        allowed_macs = []
+
+        # Process each line
+        for line in lines:
+            line = line.strip()
+            # Ignore lines that start with '//'
+            if line.startswith("//"):
+                continue
+            # If the line looks like a MAC address (e.g., xx-xx-xx-xx-xx-xx)
+            if len(line) == 17 and all(c in "0123456789ABCDEFabcdef-:" for c in line):
+                # # Convert MAC to lowercase and replace '-' with ':'
+                # formatted_mac = line.lower().replace('-', ':')
+                allowed_macs.append(line)
+
+        return allowed_macs
+    
+    except requests.exceptions.Timeout:
+        SharedMethods.print_message("ERROR: Request timed out after 5 seconds. POOR INTERNET...", "31")
+        return []
+    
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error fetching allowed MAC addresses: {e}","31")
+        return []
+
+# Function to check if the MAC address is allowed
+def is_mac_allowed(mac_address, allowed_macs):
+    # if any mac address in the list is allowed, return True
+    for mac in mac_address:
+        if mac in allowed_macs:
+            return True
+    # if no mac address in the list is allowed, return False
+    return False
+
+# Function to read from the license file
+def read_license_file():
+    if os.path.exists(LICENSE_FILE):
+        try:
+            with open(LICENSE_FILE, 'r') as file:
+                license_data = json.load(file)
+                status = license_data.get('status')
+                expiry_date_str = license_data.get('expiry_date')
+                unique_key = license_data.get('unique_key')
+                return status, expiry_date_str, unique_key
+        except Exception as e:
+            SharedMethods.print_message(f"ERROR: Error reading license: {e}","31")
+            return None, None, None
+    else:
+        SharedMethods.print_message(f"WARNING: License key DOES NOT exist yet...","33")   
+               
+    return None, None, None
+
+# Function to write to the license file
+def write_license_file(status, expiry_date_str, unique_key):
+    try:
+        os.makedirs(SharedVariables.configuration_path, exist_ok=True)
+        license_data = {
+            'status': status,
+            'expiry_date': expiry_date_str,
+            'unique_key': unique_key,
+        }
+        with open(LICENSE_FILE, 'w') as file:
+            json.dump(license_data, file, indent=4)
+    except Exception as e:
+        SharedMethods.print_message(f"ERROR: Error writing license: {e}","31")
+    return
+
+# Function to check if the license is still valid
+def is_license_valid(expiry_date_str,days_valid):
+    try:
+        if expiry_date_str:
+            expiry_date = datetime.strptime(expiry_date_str, "%Y-%m-%d")
+            start_date = expiry_date - timedelta(days=days_valid)
+            return start_date <= datetime.now() <= expiry_date
+    except:
+        return False
+    return False
+
+# Function to set license expiry in the license file
+def set_license_expiry(days_valid, unique_key):
+    expiry_date = datetime.now() + timedelta(days=days_valid)
+    expiry_date_str = expiry_date.strftime("%Y-%m-%d")
+    write_license_file("1", expiry_date_str, unique_key)
+
+# Function to allow user try five times password
+def admin_password_bypass():
+    max_attempts = 5
+    
+    for attempt in range(1, max_attempts + 1):
+        SharedMethods.print_message(f"ATTENTION: Attempt: ({attempt}/{max_attempts})","33")
+        user_input = input(f"Enter Admin Password: ")
+        if user_input == SharedVariables.admin_password:
+            SharedMethods.print_message(f"INFO: Temporary access granted. Please connect to the open internet to renew the license when possible.", '32')
+            return True
+        else:
+            SharedMethods.print_message(f"ERROR: Incorrect password. Try Again.","31")
+    
+    SharedMethods.print_message("ERROR: Access Denied. Too many failed attempts.","31")
+    return False
+
+# Main function to start the application
+def valid_license_main():
+    # disable in debug mode (bypass the process in debug mode):
+    if SharedMethods.is_debug_mode():
+        return True
+    
+    # Read the license information from the file
+    license_status, expiry_date_str, unique_key = read_license_file()
+
+    if license_status == "1" and is_license_valid(expiry_date_str,30):
+        SharedMethods.print_message(f"INFO: Valid License. Due to expiry on {expiry_date_str}.", '32')
+        return True
+    
+    else:
+        SharedMethods.print_message(f"WARNING: License not valid. Online validation process started...","33")
+        SharedMethods.print_message(f"ATTENTION: Ensure you have a valid online connection...","33")
+        mac_address = get_mac_address()
+        allowed_macs_url = SharedVariables.license_online  # Replace with your URL
+        allowed_macs = fetch_allowed_macs(allowed_macs_url)
+
+        if not allowed_macs or not is_mac_allowed(mac_address, allowed_macs):
+            SharedMethods.print_message(f"ERROR: Unauthorized machine detected. This attempt have been notified.","31")
+            # Set license file status to 0 (failed check)
+            write_license_file("0", "", unique_key)
+            SharedMethods.print_message(f"ATTENTION: To authorize your machine. Please send all your machines MAC address to {SharedVariables.contacts}.","33")
+            SharedMethods.print_message(f"ATTENTION: To fetch your mac address. Please refer to '{SharedVariables.support_online}' and follow instructions.","33")
+            SharedMethods.print_message(f"ATTENTION: If you believe there is any issue, please contact support via {SharedVariables.contacts}.","33")
+            
+            # allow user to bypass the password
+            if admin_password_bypass():
+                return True
+            else:
+                return False
+
+        # License check passed, generate a unique key if it doesn't exist and set expiry
+        # (TODO) This is to be updated to a more secure and encrpted way in the future.
+        # Due to the source code is able to be modified and licensing can be bypassed. No addtional encrption is considered.
+        if unique_key == None:
+            unique_key = str(uuid.uuid4())
+
+        set_license_expiry(days_valid=30, unique_key=unique_key)
+        SharedMethods.print_message(f"License created / updated successfully. Due to be reviewed in 30 days.", '32')
+        return True
+
+def main():
+    if not valid_license_main():
+        SharedMethods.print_message(f"ERROR: Validation Failed. The application cannot be started.","31")
+        return False
+    else:     
+        return True
+
+
+# Programme running
+if __name__ == '__main__':
+    main()