mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 10:53:17 +00:00
b565d56029
- Implement generic ESP32 devices - Updated GitHub Actions to first build the SDKs. These are now based on the generic device implementations and the build act as a filter before compiling the dozens of other devices. It should save on resources when boards fail to compile. - Adapted code to C6 and P4 differences, heavily borrowed from from https://github.com/ByteWelder/Tactility/pull/394 written by @marciogranzotto, with some changes of my own - Updated `device.py` to make the `[display]` section optional
250 lines
11 KiB
Python
250 lines
11 KiB
Python
import configparser
|
|
import os
|
|
import sys
|
|
from configparser import ConfigParser
|
|
|
|
if sys.platform == "win32":
|
|
SHELL_COLOR_RED = ""
|
|
SHELL_COLOR_ORANGE = ""
|
|
SHELL_COLOR_RESET = ""
|
|
else:
|
|
SHELL_COLOR_RED = "\033[91m"
|
|
SHELL_COLOR_ORANGE = "\033[93m"
|
|
SHELL_COLOR_RESET = "\033[m"
|
|
|
|
DEVICES_DIRECTORY = "Devices"
|
|
|
|
def print_warning(message):
|
|
print(f"{SHELL_COLOR_ORANGE}WARNING: {message}{SHELL_COLOR_RESET}")
|
|
|
|
def print_error(message):
|
|
print(f"{SHELL_COLOR_RED}ERROR: {message}{SHELL_COLOR_RESET}")
|
|
|
|
def exit_with_error(message):
|
|
print_error(message)
|
|
sys.exit(1)
|
|
|
|
def print_help():
|
|
print("Usage: python device.py [device_id] [arguments]\n\n")
|
|
print(f"\t[device_id] the device identifier (folder name in {DEVICES_DIRECTORY}/)")
|
|
print("\n")
|
|
print("Optional arguments:\n")
|
|
print("\t--dev developer options (limit to 4MB partition table)")
|
|
|
|
def get_properties_file_path(device_id: str):
|
|
return os.path.join(DEVICES_DIRECTORY, device_id, "device.properties")
|
|
|
|
def read_file(path: str):
|
|
with open(path, "r") as file:
|
|
result = file.read()
|
|
return result
|
|
|
|
def read_properties_file(path):
|
|
config = configparser.RawConfigParser()
|
|
# Don't convert keys to lowercase
|
|
config.optionxform = str
|
|
config.read(path)
|
|
return config
|
|
|
|
def read_device_properties(device_id):
|
|
device_file_path = get_properties_file_path(device_id)
|
|
if not os.path.isfile(device_file_path):
|
|
exit_with_error(f"Device file not found: {device_file_path}")
|
|
return read_properties_file(device_file_path)
|
|
|
|
def has_group(properties: ConfigParser, group: str):
|
|
return group in properties.sections()
|
|
|
|
def get_property_or_exit(properties: ConfigParser, group: str, key: str):
|
|
if group not in properties.sections():
|
|
exit_with_error(f"Device properties does not contain group: {group}")
|
|
if key not in properties[group].keys():
|
|
exit_with_error(f"Device properties does not contain key: {key}")
|
|
return properties[group][key]
|
|
|
|
def get_property_or_none(properties: ConfigParser, group: str, key: str):
|
|
if group not in properties.sections():
|
|
return None
|
|
if key not in properties[group].keys():
|
|
return None
|
|
return properties[group][key]
|
|
|
|
def get_boolean_property_or_false(properties: ConfigParser, group: str, key: str):
|
|
if group not in properties.sections():
|
|
return False
|
|
if key not in properties[group].keys():
|
|
return False
|
|
return properties[group][key] == "true"
|
|
|
|
def write_defaults(output_file):
|
|
default_properties_path = os.path.join("Buildscripts", "sdkconfig", "default.properties")
|
|
default_properties = read_file(default_properties_path)
|
|
output_file.write(default_properties)
|
|
|
|
def write_partition_table(output_file, device_properties: ConfigParser, is_dev: bool):
|
|
if is_dev:
|
|
flash_size_number = 4
|
|
else:
|
|
flash_size = get_property_or_exit(device_properties, "hardware", "flashSize")
|
|
if not flash_size.endswith("MB"):
|
|
exit_with_error("Flash size should be written as xMB or xxMB (e.g. 4MB, 16MB)")
|
|
flash_size_number = flash_size[:-2]
|
|
output_file.write("# Partition Table\n")
|
|
output_file.write("CONFIG_PARTITION_TABLE_CUSTOM=y\n")
|
|
output_file.write(f"CONFIG_PARTITION_TABLE_CUSTOM_FILENAME=\"partitions-{flash_size_number}mb.csv\"\n")
|
|
output_file.write(f"CONFIG_PARTITION_TABLE_FILENAME=\"partitions-{flash_size_number}mb.csv\"\n")
|
|
|
|
def write_tactility_variables(output_file, device_properties: ConfigParser, device_id: str):
|
|
device_selector_name = device_id.upper().replace("-", "_")
|
|
device_selector = f"CONFIG_TT_DEVICE_{device_selector_name}"
|
|
output_file.write(f"{device_selector}=y\n")
|
|
board_vendor = get_property_or_exit(device_properties, "general", "vendor").replace("\"", "\\\"")
|
|
board_name = get_property_or_exit(device_properties, "general", "name").replace("\"", "\\\"")
|
|
if board_name == board_vendor or board_vendor == "":
|
|
output_file.write(f"CONFIG_TT_DEVICE_NAME=\"{board_name}\"\n")
|
|
else:
|
|
output_file.write(f"CONFIG_TT_DEVICE_NAME=\"{board_vendor} {board_name}\"\n")
|
|
output_file.write(f"CONFIG_TT_DEVICE_ID=\"{device_id}\"\n")
|
|
|
|
def write_core_variables(output_file, device_properties: ConfigParser):
|
|
idf_target = get_property_or_exit(device_properties, "hardware", "target")
|
|
output_file.write("# Target\n")
|
|
output_file.write(f"CONFIG_IDF_TARGET=\"{idf_target.lower()}\"\n")
|
|
output_file.write("# CPU\n")
|
|
output_file.write(f"CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y\n")
|
|
output_file.write(f"CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ=240\n")
|
|
output_file.write(f"CONFIG_{idf_target}_DEFAULT_CPU_FREQ_240=y\n")
|
|
output_file.write(f"CONFIG_{idf_target}_DEFAULT_CPU_FREQ_MHZ=240\n")
|
|
|
|
def write_flash_variables(output_file, device_properties: ConfigParser):
|
|
flash_size = get_property_or_exit(device_properties, "hardware", "flashSize")
|
|
if not flash_size.endswith("MB"):
|
|
exit_with_error("Flash size should be written as xMB or xxMB (e.g. 4MB, 16MB)")
|
|
output_file.write("# Flash\n")
|
|
flash_size_number = flash_size[:-2]
|
|
output_file.write(f"CONFIG_ESPTOOLPY_FLASHSIZE_{flash_size_number}MB=y\n")
|
|
flash_mode = get_property_or_none(device_properties, "hardware", "flashMode")
|
|
if flash_mode is not None:
|
|
output_file.write(f"CONFIG_FLASHMODE_{flash_mode}=y\n")
|
|
else:
|
|
output_file.write("CONFIG_FLASHMODE_QIO=y\n")
|
|
esptool_flash_freq = get_property_or_none(device_properties, "hardware", "esptoolFlashFreq")
|
|
if esptool_flash_freq is not None:
|
|
output_file.write(f"CONFIG_ESPTOOLPY_FLASHFREQ_{esptool_flash_freq}=y\n")
|
|
|
|
def write_spiram_variables(output_file, device_properties: ConfigParser):
|
|
idf_target = get_property_or_exit(device_properties, "hardware", "target")
|
|
has_spiram = get_property_or_exit(device_properties, "hardware", "spiRam")
|
|
if has_spiram != "true":
|
|
return
|
|
output_file.write("# SPIRAM\n")
|
|
# Enable
|
|
output_file.write("CONFIG_SPIRAM=y\n")
|
|
output_file.write(f"CONFIG_{idf_target}_SPIRAM_SUPPORT=y\n")
|
|
mode = get_property_or_exit(device_properties, "hardware", "spiRamMode")
|
|
# Mode
|
|
if mode != "AUTO":
|
|
output_file.write(f"CONFIG_SPIRAM_MODE_{mode}=y\n")
|
|
else:
|
|
output_file.write("CONFIG_SPIRAM_TYPE_AUTO=y\n")
|
|
speed = get_property_or_exit(device_properties, "hardware", "spiRamSpeed")
|
|
# Speed
|
|
output_file.write(f"CONFIG_SPIRAM_SPEED_{speed}=y\n")
|
|
output_file.write(f"CONFIG_SPIRAM_SPEED={speed}\n")
|
|
# Reduce IRAM usage
|
|
output_file.write("CONFIG_SPIRAM_USE_MALLOC=y\n")
|
|
output_file.write("CONFIG_SPIRAM_TRY_ALLOCATE_WIFI_LWIP=y\n")
|
|
# Performance improvements
|
|
if idf_target == "esp32s3":
|
|
output_file.write("CONFIG_SPIRAM_FETCH_INSTRUCTIONS=y\n")
|
|
output_file.write("CONFIG_SPIRAM_RODATA=y\n")
|
|
output_file.write("CONFIG_SPIRAM_XIP_FROM_PSRAM=y\n")
|
|
|
|
def write_performance_improvements(output_file, device_properties: ConfigParser):
|
|
idf_target = get_property_or_exit(device_properties, "hardware", "target")
|
|
output_file.write("# Free up IRAM\n")
|
|
output_file.write("CONFIG_FREERTOS_PLACE_FUNCTIONS_INTO_FLASH=y\n")
|
|
output_file.write("CONFIG_FREERTOS_PLACE_SNAPSHOT_FUNS_INTO_FLASH=y\n")
|
|
output_file.write("CONFIG_HEAP_PLACE_FUNCTION_INTO_FLASH=y\n")
|
|
output_file.write("CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH=y\n")
|
|
output_file.write("# Boot speed optimization\n")
|
|
output_file.write("CONFIG_SPIRAM_MEMTEST=n\n")
|
|
if idf_target == "esp32s3":
|
|
output_file.write("# Performance improvement: Fixes glitches in the RGB display driver when rendering new screens/apps\n")
|
|
output_file.write("CONFIG_ESP32S3_DATA_CACHE_LINE_64B=y\n")
|
|
|
|
def write_lvgl_variables(output_file, device_properties: ConfigParser):
|
|
output_file.write("# LVGL\n")
|
|
if has_group(device_properties, "display"):
|
|
dpi = get_property_or_exit(device_properties, "display", "dpi")
|
|
output_file.write(f"CONFIG_LV_DPI_DEF={dpi}\n")
|
|
if has_group(device_properties, "lvgl"):
|
|
color_depth = get_property_or_exit(device_properties, "lvgl", "colorDepth")
|
|
output_file.write(f"CONFIG_LV_COLOR_DEPTH={color_depth}\n")
|
|
output_file.write(f"CONFIG_LV_COLOR_DEPTH_{color_depth}=y\n")
|
|
output_file.write("CONFIG_LV_DISP_DEF_REFR_PERIOD=10\n")
|
|
theme = get_property_or_none(device_properties, "lvgl", "theme")
|
|
if theme is None or theme == "DefaultDark":
|
|
output_file.write("CONFIG_LV_THEME_DEFAULT_DARK=y\n")
|
|
elif theme == "DefaultLight":
|
|
output_file.write("CONFIG_LV_THEME_DEFAULT_LIGHT=y\n")
|
|
elif theme == "Mono":
|
|
output_file.write("CONFIG_LV_THEME_DEFAULT_DARK=y\n")
|
|
output_file.write("CONFIG_LV_THEME_MONO=y\n")
|
|
else:
|
|
exit_with_error(f"Unknown theme: {theme}")
|
|
|
|
def write_usb_variables(output_file, device_properties: ConfigParser):
|
|
has_tiny_usb = get_boolean_property_or_false(device_properties, "hardware", "tinyUsb")
|
|
if has_tiny_usb:
|
|
output_file.write("# TinyUSB\n")
|
|
output_file.write("CONFIG_TINYUSB_MSC_ENABLED=y\n")
|
|
output_file.write("CONFIG_TINYUSB_MSC_MOUNT_PATH=\"/sdcard\"\n")
|
|
|
|
def write_custom_sdkconfig(output_file, device_properties: ConfigParser):
|
|
if "sdkconfig" in device_properties.sections():
|
|
output_file.write("# Custom\n")
|
|
section = device_properties["sdkconfig"]
|
|
for key in section.keys():
|
|
value = section[key].replace("\"", "\\\"")
|
|
output_file.write(f"{key}={value}\n")
|
|
|
|
def write_properties(output_file, device_properties: ConfigParser, device_id: str, is_dev: bool):
|
|
write_defaults(output_file)
|
|
output_file.write("\n\n")
|
|
write_tactility_variables(output_file, device_properties, device_id)
|
|
write_core_variables(output_file, device_properties)
|
|
write_flash_variables(output_file, device_properties)
|
|
write_partition_table(output_file, device_properties, is_dev)
|
|
write_spiram_variables(output_file, device_properties)
|
|
write_performance_improvements(output_file, device_properties)
|
|
write_usb_variables(output_file, device_properties)
|
|
write_custom_sdkconfig(output_file, device_properties)
|
|
write_lvgl_variables(output_file, device_properties)
|
|
|
|
def main(device_id: str, is_dev: bool):
|
|
device_properties_path = get_properties_file_path(device_id)
|
|
if not os.path.isfile(device_properties_path):
|
|
exit_with_error(f"{device_id} is not a valid device identifier (could not found {device_properties_path})")
|
|
output_file_path = "sdkconfig"
|
|
if os.path.isfile(output_file_path):
|
|
os.remove(output_file_path)
|
|
device_properties = read_device_properties(device_id)
|
|
with open(output_file_path, "w") as output_file:
|
|
write_properties(output_file, device_properties, device_id, is_dev)
|
|
if is_dev:
|
|
dev_mode_postfix = " in dev mode"
|
|
else:
|
|
dev_mode_postfix = ""
|
|
print(f"Created sdkconfig for {device_id}{dev_mode_postfix}")
|
|
|
|
if __name__ == "__main__":
|
|
if "--help" in sys.argv:
|
|
print_help()
|
|
sys.exit()
|
|
if len(sys.argv) < 2:
|
|
print_help()
|
|
sys.exit()
|
|
is_dev = "--dev" in sys.argv
|
|
main(sys.argv[1], is_dev)
|