trmnlServer/config.py at main · ohAnd/trmnlServer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
'''
This module provides the ConfigManager class for managing configuration settings
of the application. The configuration settings are stored in a 'config.yaml' file.

Classes:
    ConfigManager: Manages loading, updating, and saving configuration settings.

Usage example:
    config_manager = ConfigManager('/path/to/config/directory')
    config_manager.set_refresh_time(600)
'''
import os
import sys
import logging
import yaml

logger = logging.getLogger('__main__')
logger.info('[Config] loading module ')

class ConfigManager:
    '''
    Manages the configuration settings for the application.

    This class handles loading, updating, and saving configuration settings from a 'config.yaml'
    file. If the configuration file does not exist, it creates one with default values and
    prompts the user to restart the server.
    '''
    def __init__(self, given_dir):
        self.current_dir = given_dir
        self.config_file = os.path.join(self.current_dir, 'config.yaml')
        self.default_config = {
            'image_path': 'images/screen.bmp',
            'image_modification': True,
            'refresh_time': 900,
            'battery_max_voltage': 4.1,
            'battery_min_voltage': 2.3,
            'time_zone': 'UTC'  # Add default time zone
        }
        self.config = self.default_config.copy()
        self.load_config()

    def load_config(self):
        """
        Reads the configuration from 'config.yaml' file located in the current directory.
        If the file exists, it loads the configuration values.
        If the file does not exist, it creates a new 'config.yaml' file with default values and
        prompts the user to restart the server after configuring the settings.
        """
        if os.path.exists(self.config_file):
            with open(self.config_file, 'r', encoding='utf-8') as f:
                self.config.update(yaml.safe_load(f))
        else:
            self.write_config()
            print("Config file not found. Created a new one with default values.")
            print("Please restart the server after configuring the settings in config.yaml")
            sys.exit(0)

    def write_config(self):
        """
        Writes the configuration to 'config.yaml' file located in the current directory.
        """
        logger.info('[Config] writing config file')
        with open(self.config_file, 'w', encoding='utf-8') as config_file_handle:
            yaml.safe_dump(self.config, config_file_handle)

    def set_refresh_time(self, refresh_time):
        """
        Updates the configuration file with the new refresh time.
        """
        logger.info('[Config] setting refresh time to %s', refresh_time)
        self.config['refresh_time'] = refresh_time
        self.write_config()

    def set_image_path(self, image_path):
        """
        Updates the configuration file with the new image path.
        """
        logger.info('[Config] setting image path to %s', image_path)
        self.config['image_path'] = image_path
        self.write_config()

    def set_image_modification(self, image_modification):
        """
        Updates the configuration file with the new image modification setting.
        """
        logger.info('[Config] setting image modification to %s', image_modification)
        self.config['image_modification'] = image_modification
        self.write_config()

    def set_battery_max_voltage(self, battery_max_voltage):
        """
        Updates the configuration file with the new battery max voltage.
        """
        logger.info('[Config] setting battery max voltage to %s', battery_max_voltage)
        self.config['battery_max_voltage'] = battery_max_voltage
        self.write_config()

    def set_battery_min_voltage(self, battery_min_voltage):
        """
        Updates the configuration file with the new battery min voltage.
        """
        logger.info('[Config] setting battery min voltage to %s', battery_min_voltage)
        self.config['battery_min_voltage'] = battery_min_voltage
        self.write_config()

    def set_time_zone(self, time_zone):
        """
        Updates the configuration file with the new time zone.
        """
        logger.info('[Config] setting time zone to %s', time_zone)
        self.config['time_zone'] = time_zone
        self.write_config()