Initial release

scripts/orca_filament_lib.py

@@ -0,0 +1,307 @@
+import os
+import json
+import argparse
+from collections import defaultdict
+
+def create_ordered_profile(profile_dict, priority_fields=['name', 'type']):
+    """Create a new dictionary with priority fields first"""
+    ordered_profile = {}
+    
+    # Add priority fields first
+    for field in priority_fields:
+        if field in profile_dict:
+            ordered_profile[field] = profile_dict[field]
+    
+    # Add remaining fields
+    for key, value in profile_dict.items():
+        if key not in priority_fields:
+            ordered_profile[key] = value
+    
+    return ordered_profile
+
+def topological_sort(filaments):
+    # Build a graph of dependencies
+    graph = defaultdict(list)
+    in_degree = defaultdict(int)
+    name_to_filament = {f['name']: f for f in filaments}
+    all_names = set(name_to_filament.keys())
+    
+    # Create the dependency graph
+    processed_files = set()
+    for filament in filaments:
+        if 'inherits' in filament:
+            parent = filament['inherits']
+            child = filament['name']
+            # Only create dependency if parent exists
+            if parent in all_names:
+                graph[parent].append(child)
+                in_degree[child] += 1
+                if parent not in in_degree:
+                    in_degree[parent] = 0
+                processed_files.add(child)
+                processed_files.add(parent)
+
+    # Initialize queue with nodes having no dependencies (now sorted)
+    queue = sorted([name for name, degree in in_degree.items() if degree == 0])
+    result = []
+
+    # Process the queue
+    while queue:
+        current = queue.pop(0)
+        result.append(name_to_filament[current])
+        processed_files.add(current)
+        
+        # Process children (now sorted)
+        children = sorted(graph[current])
+        for child in children:
+            in_degree[child] -= 1
+            if in_degree[child] == 0:
+                queue.append(child)
+
+    # Add remaining files that weren't part of inheritance tree (now sorted)
+    remaining = sorted(all_names - processed_files)
+    for name in remaining:
+        result.append(name_to_filament[name])
+
+    return result
+
+def update_profile_library(vendor="",profile_type="filament"):
+    # change current working directory to the relative path(..\resources\profiles) compare to script location
+    os.chdir(os.path.join(os.path.dirname(__file__), '..', 'resources', 'profiles'))
+
+    # Collect current profile entries
+    if vendor:
+        vendors = [vendor]
+    else:
+        profiles_dir = os.path.join(os.path.dirname(__file__), '..', 'resources', 'profiles')
+        vendors = [f[:-5] for f in os.listdir(profiles_dir) if f.lower().endswith('.json')]
+    for vendor in vendors:
+        current_profiles = []
+        base_dir = vendor
+        # Orca expects machine_model to be in the machine folder
+        if profile_type == 'machine_model':
+            profile_dir = os.path.join(base_dir, 'machine')
+        else:
+            profile_dir = os.path.join(base_dir, profile_type)
+        
+        for root, dirs, files in os.walk(profile_dir):
+            for file in files:
+                if file.lower().endswith('.json'):
+                    full_path = os.path.join(root, file)
+                    
+                    # Get relative path from base directory
+                    sub_path = os.path.relpath(full_path, base_dir).replace('\\', '/')
+                    
+                    try:
+                        with open(full_path, 'r', encoding='utf-8') as f:
+                            _profile = json.load(f)
+                            if _profile.get('type') != profile_type:
+                                continue
+                            name = _profile.get('name')
+                            inherits = _profile.get('inherits')
+                            
+                            if name:
+                                entry = {
+                                    "name": name,
+                                    "sub_path": sub_path
+                                }
+                                if inherits:
+                                    entry['inherits'] = inherits
+                                current_profiles.append(entry)
+                            else:
+                                print(f"Warning: Missing 'name' in {full_path}")
+                    except Exception as e:
+                        print(f"Error reading {full_path}: {str(e)}")
+                        continue
+
+        # Sort profiles based on inheritance
+        sorted_profiles = topological_sort(current_profiles)
+        
+        # Remove the inherits field as it's not needed in the final JSON
+        for p in sorted_profiles:
+            p.pop('inherits', None)
+
+        # Update library file
+        lib_path = f'{vendor}.json'
+
+        profile_section = profile_type+'_list'
+        
+        try:
+            with open(lib_path, 'r+', encoding='utf-8') as f:
+                library = json.load(f)
+                library[profile_section] = sorted_profiles
+                f.seek(0)
+                json.dump(library, f, indent=4, ensure_ascii=False)
+                f.truncate()
+                
+            print(f"Profile library for {vendor} updated successfully!")
+        except Exception as e:
+            print(f"Error updating library file: {str(e)}")
+
+def clean_up_profile(vendor="", profile_type="", force=False):
+# change current working directory to the relative path(..\resources\profiles) compare to script location
+    os.chdir(os.path.join(os.path.dirname(__file__), '..', 'resources', 'profiles'))
+
+    # Collect current profile entries
+    if vendor:
+        vendors = [vendor]
+    else:
+        profiles_dir = os.path.join(os.path.dirname(__file__), '..', 'resources', 'profiles')
+        vendors = [f[:-5] for f in os.listdir(profiles_dir) if f.lower().endswith('.json')]
+    for vendor in vendors:
+        current_profiles = []
+        base_dir = vendor
+        # Orca expects machine_model to be in the machine folder
+        if profile_type == 'machine_model':
+            profile_dir = os.path.join(base_dir, 'machine')
+        else:
+            profile_dir = os.path.join(base_dir, profile_type)
+        
+        for root, dirs, files in os.walk(profile_dir):
+            for file in files:
+                if file.lower().endswith('.json'):
+                    if file == 'filaments_color_codes.json': # Ignore non-profile file
+                        continue
+                    
+                    full_path = os.path.join(root, file)
+                    
+                    # Get relative path from base directory
+                    sub_path = os.path.relpath(full_path, base_dir).replace('\\', '/')
+                    
+                    try:
+                        with open(full_path, 'r+', encoding='utf-8') as f:
+                            _profile = json.load(f)
+                            need_update = False
+                            if not _profile.get('type') or _profile.get('type') == "":
+                                need_update = True
+                                name = _profile.get('name')
+                                inherits = _profile.get('inherits')
+                                if profile_type == "machine_model" or profile_type == "machine":
+                                    if "nozzle" in name or "Nozzle" in name:
+                                        _profile['type'] = "machine"
+                                    else:
+                                        _profile['type'] = "machine_model"
+                                else:
+                                    _profile['type'] = profile_type
+                                print(f"Added type: {_profile['type']} to {file}")
+
+                            fields_to_remove = ['version', 'is_custom_defined']
+                            for field in fields_to_remove:
+                                if _profile.get(field):
+                                    # remove version field
+                                    del _profile[field]
+                                    print(f"Removed {field} field from {file}")
+                                    need_update = True
+
+                            # Handle `extruder_clearance_radius`.
+                            if 'extruder_clearance_radius' in _profile and 'extruder_clearance_max_radius' in _profile:
+                                # BBS renamed `extruder_clearance_radius` to `extruder_clearance_max_radius`
+                                # however some of their profiles have both options exists with different value, which
+                                # could cause very bad consequence such as toolhead collision.
+                                # Here we make sure only one of these options exist, and if both present, we keep
+                                # the one with greater value.
+                                need_update = True
+                                if float(_profile['extruder_clearance_max_radius']) > float(_profile['extruder_clearance_radius']):
+                                    del _profile['extruder_clearance_radius']
+                                else:
+                                    del _profile['extruder_clearance_max_radius']
+
+                            # Convert filament fields to arrays if not already
+                            if profile_type == 'filament':
+                                fields_to_arrayify = ['filament_cost', 'filament_density', 'filament_type', "temperature_vitrification", "filament_max_volumetric_speed", "filament_vendor"]
+                                for field in fields_to_arrayify:
+                                    if field in _profile and not isinstance(_profile[field], list):
+                                        original_value = _profile[field]
+                                        _profile[field] = [original_value]
+                                        print(f"Converted {field} to array in {file}")
+                                        need_update = True
+
+                                # remove following fields from filament profile
+                                fields_to_remove = ['initial_layer_print_speed', 'outer_wall_speed', 'inner_wall_speed', 'infill_speed', 'top_surface_speed', 'travel_speed']
+                                for field in fields_to_remove:
+                                    if field in _profile:
+                                        del _profile[field]
+                                        print(f"Removed {field} field from {file}")
+                                        need_update = True
+
+
+                            if need_update or force:
+                                # write back to file
+                                f.seek(0)
+                                ordered_profile = create_ordered_profile(_profile, ['type', 'name', 'renamed_from', 'inherits', 'from', 'setting_id', 'filament_id', 'instantiation'])
+                                json.dump(ordered_profile, f, indent=4, ensure_ascii=False)
+                                f.truncate()
+                                print(f"Updated profile: {full_path}")
+                    except Exception as e:
+                        print(f"Error reading {full_path}: {str(e)}")
+                        continue
+
+# For each JSON file, it will:
+#    - Replace "BBL X1C" with "System" in the name field
+#    - Empty the compatible_printers array
+#    - Ensure setting_id starts with 'O'
+def rename_filament_system(vendor="OrcaFilamentLibrary"):
+    # change current working directory to the relative path
+    os.chdir(os.path.join(os.path.dirname(__file__), '..', 'resources', 'profiles'))
+    
+    base_dir = vendor
+    filament_dir = os.path.join(base_dir, 'filament')
+    
+    for root, dirs, files in os.walk(filament_dir):
+        for file in files:
+            if file.lower().endswith('.json'):
+                full_path = os.path.join(root, file)
+                try:
+                    with open(full_path, 'r', encoding='utf-8') as f:
+                        data = json.load(f)
+                        modified = False
+                        
+                        # Update name if it contains "BBL X1C"
+                        if 'name' in data and "BBL X1C" in data['name']:
+                            data['name'] = data['name'].replace("BBL X1C", "System")
+                            modified = True
+                            
+                        # Empty compatible_printers if exists
+                        if 'compatible_printers' in data:
+                            data['compatible_printers'] = []
+                            modified = True
+                            
+                        # Update setting_id if needed
+                        if 'setting_id' in data and not data['setting_id'].startswith('O'):
+                            data['setting_id'] = 'O' + data['setting_id']
+                            modified = True
+                        
+                        if modified:
+                            with open(full_path, 'w', encoding='utf-8') as f:
+                                json.dump(data, f, indent=4, ensure_ascii=False)
+                            print(f"Updated {full_path}")
+                            
+                except Exception as e:
+                    print(f"Error processing {full_path}: {str(e)}")
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='Update filament library for specified vendor')
+    parser.add_argument('-v', '--vendor', type=str, default="",
+                      help='Vendor name (default: "" which means all vendors)')
+    parser.add_argument('-u', '--update', action='store_true', help='update vendor.json')
+    parser.add_argument('-p', '--profile_type', type=str, choices=['machine_model', 'process', 'filament', 'machine'], help='profile type (default: "" which means all types)')
+    parser.add_argument('-f', '--fix', action='store_true', help='Fix errors like missing type field, and clean up the profile')
+    parser.add_argument('--force', action='store_true', help='Force update the profile files, for --fix option')
+    args = parser.parse_args()
+    
+    if args.fix:
+        if(args.profile_type):
+            clean_up_profile(args.vendor, args.profile_type, args.force)
+        else:
+            clean_up_profile(args.vendor, 'machine_model', args.force)
+            clean_up_profile(args.vendor, 'process', args.force)
+            clean_up_profile(args.vendor, 'filament', args.force)
+            clean_up_profile(args.vendor, 'machine', args.force)
+
+    if args.update:
+        update_profile_library(args.vendor, 'machine_model')
+        update_profile_library(args.vendor, 'process')
+        update_profile_library(args.vendor, 'filament')
+        update_profile_library(args.vendor, 'machine')
+    # else:
+        # rename_filament_system(args.vendor)