modifications

Author: kdschlosser

builder/__init__.py

@@ -256,6 +256,13 @@ def generate_manifest(
         )
     ]
 
+    toml_gen_driver = f'{script_dir}/build/display.py'
+    if os.path.exists(toml_gen_driver):
+        print(toml_gen_driver)
+        file_path, file_name = os.path.split(toml_gen_driver)
+        entry = f"freeze('{file_path}', '{file_name}')"
+        manifest_files.append(entry)
+
     for file in frozen_manifest_files:
         if not os.path.exists(file):
             raise RuntimeError(f'File not found "{file}"')

builder/toml_reader.py

@@ -0,0 +1,286 @@
+import os
+
+try:
+    import tomlib as toml
+except ImportError:
+    try:
+        import toml
+    except ImportError:
+        raise RuntimeError(
+            'A "toml" library is needed to read a .toml file\n'
+            'One is included with Python 3.11+ or you can install \n'
+            'into your current version of Python using the following command:\n'
+            '\n'
+            'pip3 install toml'
+        )
+
+
+class TOMLMeta(type):
+
+    def __call__(cls, name, parent=None, **kwargs):
+        children = {}
+        for key, value in list(kwargs.items()):
+            if isinstance(value, dict):
+                children[key] = value
+                del kwargs[key]
+
+        instance = super().__call__(name, parent=parent, **kwargs)
+
+        for child_name, child_data in children.items():
+            child = TOMLObject(child_name, parent=instance, **child_data)
+            instance.add_child(child)
+
+        return instance
+
+
+class TOMLObject(metaclass=TOMLMeta):
+
+    def __init__(self, name, parent=None, **kwargs):
+
+        if parent is not None and parent.name == 'MCU':
+            self.build_args = kwargs
+
+        self.name = name
+        self.parent = parent
+        self.__kwargs = kwargs
+        self.__children = []
+        self.imports = []
+        self.mcu = None
+
+    def add_child(self, child):
+        if self.name == 'MCU':
+            self.__dict__.update(child.__dict__)
+            self.board = child.name
+            self.name = 'MCU'
+        elif self.parent is None and child.name == 'MCU':
+            self.mcu = TOMLmcu(child)
+        else:
+            self.__children.append(child)
+
+    def __getattr__(self, item):
+        if item in self.__dict__:
+            return self.__dict__[item]
+
+        if item in self.__kwargs:
+            return self.__kwargs[item]
+
+        raise AttributeError(item)
+
+    @property
+    def fqn(self):
+        if self.__kwargs:
+            if 'params' in self.__kwargs or 'value' in self.__kwargs:
+                return self.parent.fqn + '.' + self.name
+
+            return self.name + ' = ' + self.parent.fqn
+
+        if self.name == 'I2C':
+            return 'i2c.I2C'
+
+        if self.name == 'SPI':
+            return 'machine.SPI'
+
+        if self.name == 'SDCard':
+            return 'machine.SDCard'
+
+        if self.name.lower() in display_drivers:
+            return self.name.lower() + '.' + self.name
+
+        if self.name.lower() in indev_drivers:
+            return self.name.lower() + '.' + self.name
+
+        if self.name.lower() in io_expanders:
+            return self.name.lower() + '.' + self.name
+
+        if self.name in ('I80Bus', 'SPIBus', 'I2CBus', 'RGBBus'):
+            return 'lcd_bus.' + self.name
+
+        if self.parent is None:
+            return None
+
+        if self.parent.name:
+            return self.parent.fqn + '.' + self.name
+
+        return self.name
+
+    @property
+    def var_names(self):
+        if self.__kwargs:
+            fqn = self.fqn
+
+            if '=' in fqn:
+                return [fqn.split('=')[0].strip()]
+
+            return []
+
+        var_names = []
+
+        for child in self.__children:
+            var_names.extend(child.var_names)
+
+        return var_names
+
+    @property
+    def constants(self):
+        res = []
+
+        if not self.__children:
+            for key, value in list(self.__kwargs.items()):
+                if not isinstance(value, int) or key == 'value':
+                    continue
+
+                name = self.name.upper()
+
+                key_upper = key.upper()
+                if name not in key_upper:
+                    key_upper = name + '_' + key_upper
+
+                res.append(f'_{key_upper} = const({value})')
+                self.__kwargs[key] = f'_{key_upper}'
+        else:
+            for child in self.__children:
+                res.extend(child.constants)
+
+        return res
+
+    def __str__(self):
+        if self.parent is None:
+            var_names = self.var_names
+
+            output = []
+            output.extend(self.constants)
+
+            for child in self.__children:
+                if child.name not in var_names:
+                    module = child.fqn.split('.')[0]
+                    if module not in self.imports:
+                        self.imports.append(module)
+                        output.extend(['', f'import {module}', ''])
+
+                output.append(str(child))
+
+            if output:
+                output = [
+                    'from micropython import const',
+                    'import lvgl as lv',
+                    '',
+                    ''
+                ] + output
+
+            return '\n'.join(output)
+
+        if self.__children and not self.__kwargs:
+            output = [str(child) for child in self.__children]
+            return '\n'.join(output)
+
+        fqn = self.fqn
+
+        if len(self.__kwargs) == 1:
+            key = list(self.__kwargs.keys())[0]
+            if key == 'params':
+                params = ', '.join(str(itm) for itm in self.__kwargs[key])
+                return f'{fqn}({params})'
+            elif key == 'value':
+                return f'{fqn} = ' + str(self.__kwargs[key])
+            else:
+                return f'{fqn}({key}={str(self.__kwargs[key])})'
+        else:
+            params = ',\n'.join(f'    {k}={str(v)}' for k, v in self.__kwargs.items() if not isinstance(v, dict))
+            if params:
+                output = [f'{fqn}(\n{params}\n)', '']
+            else:
+                raise RuntimeError
+
+            for child in self.__children:
+                output.append(self.name + '.' + str(child).split('.', 2)[-1])
+
+            if len(output) > 2:
+                output.append('')
+
+            return '\n'.join(output)
+
+
+class TOMLmcu:
+
+    def __init__(self, mcu):
+        name = mcu.board
+        build_args = mcu.build_args
+
+        command = [name]
+        for arg, value in build_args.items():
+            if arg.islower():
+                build_arg = '--' + arg.replace('_', '-')
+                if isinstance(value, bool) and not value:
+                    raise SyntaxError(
+                        'optionless build commands must be set to "true"\n'
+                        f'if they are used in the toml file. ({arg} = {repr(value)})'
+                    )
+            else:
+                build_arg = arg
+
+            if not isinstance(value, bool):
+                build_arg = f'{build_arg}={value}'
+
+            command.append(build_arg)
+
+        self.build_command = command
+
+
+base_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+
+display_driver_path = os.path.join(base_path, 'api_drivers/common_api_drivers/display')
+indev_driver_path = os.path.join(base_path, 'api_drivers/common_api_drivers/indev')
+io_expander_path = os.path.join(base_path, 'api_drivers/common_api_drivers/io_expander')
+
+
+display_drivers = [file for file in os.listdir(display_driver_path) if not file.endswith('.wip') and not file.endswith('.py')]
+indev_drivers = [file[:-3] for file in os.listdir(indev_driver_path) if file.endswith('.py')]
+io_expanders = [file[:-3] for file in os.listdir(io_expander_path) if file.endswith('.py')]
+
+
+def run(toml_path, output_file):
+
+    if not os.path.exists(toml_path):
+        raise RuntimeError(f'inable to locate .toml ({toml_path})')
+
+    try:
+        with open(toml_path, 'r') as f:
+            toml_data = toml.load(f)
+
+        toml_obj = TOMLObject('', **toml_data)
+
+        t_data = str(toml_obj)
+
+        if t_data:
+            with open(output_file, 'w') as f:
+                f.write(t_data)
+
+        displays = [f'DISPLAY={item}' for item in toml_obj.imports if item in display_drivers]
+        indevs = [f'INDEV={item}' for item in toml_obj.imports if item in indev_drivers]
+        expanders = [f'EXPANDER={item}' for item in toml_obj.imports if item in io_expanders]
+
+        if toml_obj.mcu is None:
+            build_command = []
+        else:
+            build_command = toml_obj.build_command
+
+        for display in displays[:]:
+            if display not in build_command:
+                build_command.append(display)
+
+        for indev in indevs[:]:
+            if indev not in build_command:
+                build_command.append(indev)
+
+        for expander in expanders[:]:
+            if expander not in build_command:
+                build_command.append(expander)
+
+        return build_command
+
+    except OSError as err:
+        raise RuntimeError(f'Unable to write data to {output_file}') from err
+    except Exception as err:  # NOQA
+        raise SyntaxError(f'Unable to parse .toml file ({toml_path})') from err
+
+

example_build_toml.toml

@@ -0,0 +1,67 @@
+
+[MCU.esp32]
+BOARD = "ESP32_GENERIC_S3"
+BOARD_VARIANT = "SPIRAM_OCT"
+octal_flash = true
+flash_size = 16
+enable_jtag_repl = 'n'
+enable_cdc_repl = 'n'
+enable_uart_repl = 'y'
+uart_repl_bitrate = 115200
+
+
+
+[I80Bus.display_bus]
+data0 = 9
+data1 = 46
+data2 = 3
+data3 = 8
+data4 = 18
+data5 = 17
+data6 = 16
+data7 = 15
+dc = 0
+wr = 47
+cs = -1
+freq = 20000000
+
+
+[I2C.Bus.i2c_bus]
+host = 0
+scl = 5
+sda = 6
+freq = 100000
+
+
+[I2C.Device.indev_device]
+bus = "i2c_bus"
+dev_id = "ft6x36.I2C_ADDR"
+reg_bits = "ft6x36.BITS"
+
+
+[ST7796.display]
+data_bus = "display_bus"
+display_width = 320
+display_height = 480
+backlight_pin = 45
+color_byte_order = "st7789.BYTE_ORDER_BGR"
+color_space = "lv.COLOR_FORMAT.RGB565"
+rgb565_byte_swap = true
+
+[ST7796.display.init]
+params = []
+
+[FT6x36.indev]
+device = "indev_device"
+
+[display.set_color_inversion]
+params = [true]
+
+[display.set_rotation]
+params = ["lv.DISPLAY_ROTATION._90"]
+
+[display.set_backlight]
+params = [100]
+
+[task_handler.TaskHandler]
+params=[]