Compare commits

...

3 Commits

Author SHA1 Message Date
Ken Van Hoeylandt
45d5dbc372 Updated help printing 2025-06-05 23:40:44 +02:00
Ken Van Hoeylandt
5e65cd0da8 Implement sdk.json 2025-06-05 23:32:44 +02:00
Ken Van Hoeylandt
a67a1bc0a9 Build tool can now download SDKs 2025-06-05 22:46:07 +02:00
3 changed files with 143 additions and 32 deletions

View File

@ -1 +1,2 @@
build*/
.ttbuild/

View File

@ -0,0 +1,2 @@
[sdk]
version = 0.4.0-dev

View File

@ -1,58 +1,166 @@
import sys
import os
import urllib.request
import zipfile
import configparser
import time
import json
def printWarning(message):
esp_platforms = ["esp32", "esp32s3"]
ttbuild_path = '.ttbuild'
ttbuild_version = '0.1.0'
ttbuild_properties_file = 'tactility.properties'
ttbuild_cdn = "https://cdn.tactility.one"
def print_help():
print("Usage: python ttbuild.py [all|esp32|esp32s3] [options]")
print("Options:")
print(" --skip-build Run everything except the idf.py/CMake commands")
def download_file(url, filepath):
request = urllib.request.Request(
url,
data=None,
headers={
'User-Agent': f"Tactility Build Tool {ttbuild_version}"
}
)
response = urllib.request.urlopen(request)
file = open(filepath, mode='wb')
file.write(response.read())
file.close()
return True
def print_warning(message):
if sys.platform == 'win32':
print(f"ERROR: {message}")
else:
print(f"\033[93mWARNING: {message}\033[m")
def printError(message):
def print_error(message):
if sys.platform == 'win32':
print(f"ERROR: {message}")
else:
print(f"\033[91mERROR: {message}\033[m")
def exitWithError(message):
printError(message)
def exit_with_error(message):
print_error(message)
sys.exit(1)
def isValidPlatformName(name):
def is_valid_platform_name(name):
return name == "all" or name == "esp32" or name == "esp32s3"
def build(platformName):
print(f"Platform: {platformName}")
os.system(f"cp sdkconfig.{platformName} sdkconfig")
os.system(f"idf.py -B build-{platformName} build")
def build(version, platforms, skip_build):
for platform in platforms:
print(f"Platform: {platform}")
sdk_dir = get_sdk_dir(version, platform)
print(f"Using SDK at {sdk_dir}")
os.environ['TACTILITY_SDK_PATH'] = sdk_dir
os.system(f"cp sdkconfig.{platform} sdkconfig")
if not skip_build:
os.system(f"idf.py -B build-{platform} build")
def buildAll():
build("esp32")
build("esp32s3")
def validate_environment():
if os.environ.get('IDF_PATH') is None:
exit_with_error("IDF is not installed or activated. Ensure you installed the toolset and ran the export command.")
if os.environ.get('TACTILITY_SDK_PATH') is not None:
print_warning("TACTILITY_SDK_PATH is set, but will be ignored by this command")
if not os.path.exists(ttbuild_properties_file):
exit_with_error(f"{ttbuild_properties_file} file not found")
def printHelp():
print("Usage:")
print("\tpython ttbuild.py [platformName]")
print("\tplatformName: all|esp32|esp32s3")
def setup_environment():
os.makedirs(ttbuild_path, exist_ok=True)
def get_sdk_dir(version, platform):
return os.path.join(ttbuild_path, f"{version}-{platform}", 'TactilitySDK')
def get_sdk_version():
parser = configparser.RawConfigParser()
parser.read(ttbuild_properties_file)
sdk_dict = dict(parser.items('sdk'))
if not 'version' in sdk_dict:
exit_with_error(f"Could not find 'version' in [sdk] section in {ttbuild_properties_file}")
return sdk_dict['version']
def get_sdk_root_dir(version, platform):
return os.path.join(ttbuild_path, f"{version}-{platform}")
def get_sdk_url(version, platform):
return f"{ttbuild_cdn}/TactilitySDK-{version}-{platform}.zip"
def sdk_exists(version, platform):
sdk_dir = get_sdk_dir(version, platform)
return os.path.isdir(sdk_dir)
def should_update_sdk_json():
json_filepath = os.path.join(ttbuild_path, "sdk.json")
if os.path.exists(json_filepath):
json_modification_time = os.path.getmtime(json_filepath)
now = time.time()
minimum_seconds_difference = 3600
return (now - json_modification_time) > minimum_seconds_difference
else:
return True
def update_sdk_json():
json_url = f"{ttbuild_cdn}/sdk.json"
json_filepath = os.path.join(ttbuild_path, "sdk.json")
return download_file(json_url, json_filepath)
def sdk_download(version, platform):
sdk_root_dir = get_sdk_root_dir(version, platform)
os.makedirs(sdk_root_dir, exist_ok=True)
sdk_url = get_sdk_url(version, platform)
print(f"Downloading SDK version {version} for {platform} from {sdk_url}")
filepath = os.path.join(sdk_root_dir, f"{version}-{platform}.zip")
if download_file(sdk_url, filepath):
with zipfile.ZipFile(filepath, 'r') as zip_ref:
zip_ref.extractall(sdk_root_dir)
else:
exit_with_error("Failed to download SDK")
def sdk_download_all(version, platforms):
for platform in platforms:
if not sdk_exists(version, platform):
sdk_download(version, platform)
else:
print(f"Using cached download for SDK version {version} and platform {platform}")
def validate_version_and_platforms(sdk_json, sdk_version, platforms_to_build):
version_map = sdk_json['versions']
if not sdk_version in version_map:
exit_with_error(f"Version not found: {sdk_version}")
version_data = version_map[sdk_version]
available_platforms = version_data['platforms']
for desired_platform in platforms_to_build:
if not desired_platform in available_platforms:
exit_with_error(f"Platform {desired_platform} is not available. Available ones: {available_platforms}")
if __name__ == "__main__":
print("Tactility Build System v0.1.0")
print(f"Tactility Build System v{ttbuild_version}")
# Environment
if os.environ.get('IDF_PATH') == None:
exitWithError("IDF is not installed or activated. Ensure you installed the toolset and ran the export command.")
if os.environ.get('TACTILITY_SDK_PATH') != None:
printWarning("TACTILITY_SDK_PATH is set, but will be ignored by this command")
os.environ['TACTILITY_SDK_PATH'] = '../../release/TactilitySDK'
validate_environment()
setup_environment()
# Argument validation
if len(sys.argv) == 1:
printHelp()
print_help()
sys.exit()
platformName = sys.argv[1]
if not isValidPlatformName(platformName):
printHelp()
exitWithError("Invalid platform name")
platform_arg = sys.argv[1]
if not is_valid_platform_name(platform_arg):
print_help()
exit_with_error("Invalid platform name")
# Update SDK cache
if should_update_sdk_json():
update_sdk_json()
json_file_path = os.path.join(ttbuild_path, 'sdk.json')
json_file = open(json_file_path)
sdk_json = json.load(json_file)
if not 'versions' in sdk_json:
exit_with_error("version data not found in sdk.json")
# Build
if platformName == "all":
buildAll()
else:
build(sys.argv[1])
platforms_to_build = esp_platforms if platform_arg == "all" else [platform_arg]
sdk_version = get_sdk_version()
validate_version_and_platforms(sdk_json, sdk_version, platforms_to_build)
sdk_download_all(sdk_version, platforms_to_build)
skip_build = '--skip-build' in sys.argv
build(sdk_version, platforms_to_build, skip_build)