File size: 54,806 Bytes
985c397 | 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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * *
# * Copyright (c) 2025 Billy Huddleston <billy@ivdc.com> *
# * *
# * This file is part of FreeCAD. *
# * *
# * FreeCAD is free software: you can redistribute it and/or modify it *
# * under the terms of the GNU Lesser General Public License as *
# * published by the Free Software Foundation, either version 2.1 of the *
# * License, or (at your option) any later version. *
# * *
# * FreeCAD is distributed in the hope that it will be useful, but *
# * WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
# * Lesser General Public License for more details. *
# * *
# * You should have received a copy of the GNU Lesser General Public *
# * License along with FreeCAD. If not, see *
# * <https://www.gnu.org/licenses/>. *
# * *
# ***************************************************************************
import json
import Path
import FreeCAD
import pathlib
from dataclasses import dataclass, field
from typing import Dict, Any, List, Optional, Tuple, Callable
from collections import namedtuple
from enum import Enum
if False:
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
Path.Log.trackModule(Path.Log.thisModule())
else:
Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule())
# Reference axis vectors
RefAxes = namedtuple("RefAxes", ["x", "y", "z"])
refAxis = RefAxes(
FreeCAD.Vector(1, 0, 0), # x: linear direction
FreeCAD.Vector(0, 1, 0), # y: linear direction
FreeCAD.Vector(0, 0, 1), # z: linear direction
)
RefRotAxes = namedtuple("RefRotAxes", ["a", "b", "c"])
refRotAxis = RefRotAxes(
FreeCAD.Vector(1, 0, 0), # a: rotational direction
FreeCAD.Vector(0, 1, 0), # b: rotational direction
FreeCAD.Vector(0, 0, 1), # c: rotational direction
)
# ============================================================================
# Enums for Machine Configuration
# ============================================================================
class MachineUnits(Enum):
"""Machine unit system."""
METRIC = "G21"
IMPERIAL = "G20"
class OutputUnits(Enum):
"""Output unit system for G-code generation."""
METRIC = "metric"
IMPERIAL = "imperial"
# ============================================================================
# Post-Processor Configuration Dataclasses
# ============================================================================
@dataclass
class OutputOptions:
"""Controls what gets included in the G-code output and its formatting."""
# These options control conversion of Path Objects to actual gcode.
output_units: OutputUnits = OutputUnits.METRIC # G-code output units
# Line formatting options
command_space: str = " "
comment_symbol: str = "("
end_of_line_chars: str = "\n"
line_increment: int = 10
line_number_start: int = 100
line_numbers: bool = False
line_number_prefix: str = "N"
# Output content options
output_comments: bool = True # Renamed from 'comments'
output_blank_lines: bool = True # Renamed from 'blank_lines'
output_bcnc_comments: bool = True
output_header: bool = True # Renamed from 'header'
output_labels: bool = False # Renamed from 'path_labels'
output_operation_labels: bool = True # Renamed from 'show_operation_labels'
# Header content options
list_tools_in_header: bool = False # Renamed from 'list_tools_in_preamble'
list_fixtures_in_header: bool = True
machine_name_in_header: bool = False # Renamed from 'machine_name'
description_in_header: bool = True
date_in_header: bool = True
document_name_in_header: bool = True
# Filter options
filter_double_parameters: bool = False # Renamed from 'output_double_parameters'
filter_double_commands: bool = False # Renamed from 'modal' (moved from ProcessingOptions)
# Numeric precision settings
axis_precision: int = 3 # Decimal places for axis coordinates
feed_precision: int = 3 # Decimal places for feed rates
spindle_precision: int = 0 # Renamed from 'spindle_decimals'
@dataclass
class GCodeBlocks:
"""
G-code block templates for various lifecycle hooks.
These templates are inserted at specific points during postprocessing
to provide customization points for machine-specific behavior.
"""
safetyblock: str = "" # Safety commands (G40, G49, etc.) Reset machine to known safe condition
# Legacy aliases (maintained for compatibility)
preamble: str = "" # Typically inserted at start of job
# Job lifecycle
pre_job: str = ""
# Operation lifecycle
pre_operation: str = ""
post_operation: str = ""
# Tool change lifecycle
pre_tool_change: str = ""
post_tool_change: str = ""
tool_return: str = "" # Return to tool change position
# Fixture/WCS change lifecycle
pre_fixture_change: str = ""
post_fixture_change: str = ""
# Rotary axis lifecycle
pre_rotary_move: str = ""
post_rotary_move: str = ""
post_job: str = ""
postamble: str = "" # Typically inserted at end of job
@dataclass
class ProcessingOptions:
"""Processing and transformation options."""
# Conversion and expansion of Path Objects. Does not affect final gcode generation
drill_cycles_to_translate: List[str] = field(
default_factory=lambda: ["G73", "G81", "G82", "G83"]
)
show_machine_units: bool = True
spindle_wait: float = 0.0 # seconds
split_arcs: bool = False
suppress_commands: List[str] = field(default_factory=list)
tool_before_change: bool = False # Output T before M6 (e.g., T1 M6 instead of M6 T1)
tool_change: bool = True # Enable tool change commands
translate_drill_cycles: bool = False
return_to: Optional[Tuple[float, float, float]] = None # (x, y, z) or None
# ============================================================================
# Machine Component Dataclasses
# ============================================================================
@dataclass
class LinearAxis:
"""Represents a single linear axis in a machine configuration"""
name: str
direction_vector: FreeCAD.Vector
min_limit: float = 0
max_limit: float = 1000
max_velocity: float = 10000
sequence: int = 0
def __post_init__(self):
"""Normalize direction vector and validate parameters after initialization"""
self.direction_vector = self.direction_vector.normalize()
# Validate limits
if self.min_limit >= self.max_limit:
Path.Log.warning(
f"LinearAxis {self.name}: min_limit ({self.min_limit}) >= max_limit ({self.max_limit})"
)
# Validate velocity
if self.max_velocity <= 0:
Path.Log.warning(
f"LinearAxis {self.name}: max_velocity must be positive, got {self.max_velocity}"
)
def is_valid_position(self, position):
"""Check if a position is within this axis's limits"""
return self.min_limit <= position <= self.max_limit
def to_dict(self):
"""Serialize to dictionary for JSON persistence"""
return {
"name": self.name,
"direction_vector": [
self.direction_vector.x,
self.direction_vector.y,
self.direction_vector.z,
],
"min_limit": self.min_limit,
"max_limit": self.max_limit,
"max_velocity": self.max_velocity,
"sequence": self.sequence,
}
@classmethod
def from_dict(cls, data):
"""Deserialize from dictionary"""
vec = FreeCAD.Vector(
data["direction_vector"][0], data["direction_vector"][1], data["direction_vector"][2]
)
return cls(
data["name"],
vec,
data.get("min_limit", 0),
data.get("max_limit", 1000),
data.get("max_velocity", 10000),
data.get("sequence", 0),
)
@dataclass
class RotaryAxis:
"""Represents a single rotary axis in a machine configuration"""
name: str
rotation_vector: FreeCAD.Vector
min_limit: float = -360
max_limit: float = 360
max_velocity: float = 36000
sequence: int = 0
prefer_positive: bool = True
def __post_init__(self):
"""Normalize rotation vector and validate parameters after initialization"""
if self.rotation_vector is None or self.rotation_vector.Length < 1e-6:
# Default to Z-axis rotation if vector is null or zero-length
self.rotation_vector = FreeCAD.Vector(0, 0, 1)
else:
self.rotation_vector = self.rotation_vector.normalize()
# Validate limits
if self.min_limit >= self.max_limit:
Path.Log.warning(
f"RotaryAxis {self.name}: min_limit ({self.min_limit}) >= max_limit ({self.max_limit})"
)
# Validate velocity
if self.max_velocity <= 0:
Path.Log.warning(
f"RotaryAxis {self.name}: max_velocity must be positive, got {self.max_velocity}"
)
def is_valid_angle(self, angle):
"""Check if an angle is within this axis's limits"""
return self.min_limit <= angle <= self.max_limit
def to_dict(self):
"""Serialize to dictionary for JSON persistence"""
return {
"name": self.name,
"rotation_vector": [
self.rotation_vector.x,
self.rotation_vector.y,
self.rotation_vector.z,
],
"min_limit": self.min_limit,
"max_limit": self.max_limit,
"max_velocity": self.max_velocity,
"sequence": self.sequence,
"prefer_positive": self.prefer_positive,
}
@classmethod
def from_dict(cls, data):
"""Deserialize from dictionary"""
vec = FreeCAD.Vector(
data["rotation_vector"][0], data["rotation_vector"][1], data["rotation_vector"][2]
)
return cls(
data["name"],
vec,
data["min_limit"],
data["max_limit"],
data.get("max_velocity", 36000),
data.get("sequence", 0),
data.get("prefer_positive", True),
)
@dataclass
class Spindle:
"""Represents a single spindle in a machine configuration"""
name: str
id: Optional[str] = None
max_power_kw: float = 0
max_rpm: float = 0
min_rpm: float = 0
tool_change: str = "manual"
tool_axis: Optional[FreeCAD.Vector] = None
def __post_init__(self):
"""Set default tool axis if not provided"""
if self.tool_axis is None:
self.tool_axis = FreeCAD.Vector(0, 0, -1)
def to_dict(self):
"""Serialize to dictionary for JSON persistence"""
data = {
"name": self.name,
"max_power_kw": self.max_power_kw,
"max_rpm": self.max_rpm,
"min_rpm": self.min_rpm,
"tool_change": self.tool_change,
"tool_axis": [self.tool_axis.x, self.tool_axis.y, self.tool_axis.z],
}
if self.id is not None:
data["id"] = self.id
return data
@classmethod
def from_dict(cls, data):
"""Deserialize from dictionary"""
tool_axis_data = data.get("tool_axis", [0, 0, -1])
tool_axis = FreeCAD.Vector(tool_axis_data[0], tool_axis_data[1], tool_axis_data[2])
return cls(
data["name"],
data.get("id"),
data.get("max_power_kw", 0),
data.get("max_rpm", 0),
data.get("min_rpm", 0),
data.get("tool_change", "manual"),
tool_axis,
)
@dataclass
class Machine:
"""Represents a CNC machine configuration with axes, spindles, and output settings.
This class encapsulates all machine parameters including linear and rotary axes,
spindles, post-processor settings, and G-code generation options. It provides
methods for serialization to/from JSON and various factory methods for common
machine configurations (3-axis, 4-axis, 5-axis).
"""
"""
Unified machine configuration combining physical machine definition
with post-processor settings.
This is the single source of truth for all machine-related configuration,
including physical capabilities (axes, spindles) and G-code generation
preferences (output options, formatting, processing).
"""
# ========================================================================
# PHYSICAL MACHINE DEFINITION
# ========================================================================
# Basic identification
name: str = "Default Machine"
manufacturer: str = ""
description: str = ""
# Machine components
linear_axes: Dict[str, LinearAxis] = field(default_factory=dict)
rotary_axes: Dict[str, RotaryAxis] = field(default_factory=dict)
spindles: List[Spindle] = field(default_factory=list)
# Coordinate system
reference_system: Dict[str, FreeCAD.Vector] = field(
default_factory=lambda: {
"X": FreeCAD.Vector(1, 0, 0),
"Y": FreeCAD.Vector(0, 1, 0),
"Z": FreeCAD.Vector(0, 0, 1),
}
)
tool_axis: FreeCAD.Vector = field(default_factory=lambda: FreeCAD.Vector(0, 0, -1))
# Rotary axis configuration
primary_rotary_axis: Optional[str] = None
secondary_rotary_axis: Optional[str] = None
compound_moves: bool = True
prefer_positive_rotation: bool = True
# Units and versioning
configuration_units: str = "metric" # Internal storage for configuration_units
version: int = 1
freecad_version: str = field(init=False)
# ========================================================================
# POST-PROCESSOR CONFIGURATION
# ========================================================================
# Output options
output: OutputOptions = field(default_factory=OutputOptions)
blocks: GCodeBlocks = field(default_factory=GCodeBlocks)
processing: ProcessingOptions = field(default_factory=ProcessingOptions)
# Post-processor selection
postprocessor_file_name: str = ""
postprocessor_args: str = ""
# Dynamic state (for runtime)
parameter_functions: Dict[str, Callable] = field(default_factory=dict)
def __post_init__(self):
"""Initialize computed fields and handle backward compatibility"""
# Initialize computed fields
self.freecad_version = ".".join(FreeCAD.Version()[0:3])
# Validate configuration_units
if self.configuration_units not in ["metric", "imperial"]:
raise ValueError(
f"configuration_units must be 'metric' or 'imperial', got '{self.configuration_units}'"
)
# Backward compatibility for renamed fields
# Support old field names by creating aliases
if not hasattr(self.output, "filter_double_parameters"):
self.output.filter_double_parameters = getattr(
self.output, "output_double_parameters", False
)
if not hasattr(self.output, "filter_double_commands"):
self.output.filter_double_commands = getattr(self.processing, "modal", False)
# ========================================================================
# PROPERTIES - Bridge between physical machine and post-processor
# ========================================================================
@property
def machine_units(self) -> MachineUnits:
"""Get machine configuration units as enum"""
return (
MachineUnits.METRIC if self.configuration_units == "metric" else MachineUnits.IMPERIAL
)
@property
def output_machine_units(self) -> MachineUnits:
"""Get output units as enum for G-code generation"""
return (
MachineUnits.METRIC
if self.output.output_units == OutputUnits.METRIC
else MachineUnits.IMPERIAL
)
@property
def gcode_units(self) -> MachineUnits:
"""Get G-code output units as enum for post-processor"""
return (
MachineUnits.METRIC
if self.output.output_units == OutputUnits.METRIC
else MachineUnits.IMPERIAL
)
@property
def unit_format(self) -> str:
"""Get machine configuration unit format string (mm or in)"""
return "mm" if self.configuration_units == "metric" else "in"
@property
def output_unit_format(self) -> str:
"""Get G-code output unit format string (mm or in)"""
return "mm" if self.output.output_units == OutputUnits.METRIC else "in"
@property
def unit_speed_format(self) -> str:
"""Get machine configuration unit speed format string (mm/min or in/min)"""
return "mm/min" if self.configuration_units == "metric" else "in/min"
@property
def output_unit_speed_format(self) -> str:
"""Get G-code output unit speed format string (mm/min or in/min)"""
return "mm/min" if self.output.output_units == OutputUnits.METRIC else "in/min"
@property
def machine_type(self) -> str:
"""
Determine machine type based on available axes.
Returns one of: 'xyz', 'xyza', 'xyzb', 'xyzac', 'xyzbc', or 'custom'
"""
if not all(axis in self.linear_axes for axis in ["X", "Y", "Z"]):
return "custom"
rot_axes = set(self.rotary_axes.keys())
# Check for 5-axis configurations
if {"A", "C"}.issubset(rot_axes):
return "xyzac"
if {"B", "C"}.issubset(rot_axes):
return "xyzbc"
# Check for 4-axis configurations
if "A" in rot_axes:
return "xyza"
if "B" in rot_axes:
return "xyzb"
# 3-axis configuration
return "xyz"
@property
def has_rotary_axes(self) -> bool:
"""Check if machine has any rotary axes"""
return len(self.rotary_axes) > 0
@property
def is_5axis(self) -> bool:
"""Check if machine is 5-axis (2 rotary axes)"""
return len(self.rotary_axes) >= 2
@property
def is_4axis(self) -> bool:
"""Check if machine is 4-axis (1 rotary axis)"""
return len(self.rotary_axes) == 1
@property
def motion_commands(self) -> List[str]:
"""Get list of motion commands that change position"""
import Path.Geom as PathGeom
return PathGeom.CmdMoveAll
@property
def rapid_moves(self) -> List[str]:
"""Get list of rapid move commands"""
import Path.Geom as PathGeom
return PathGeom.CmdMoveRapid
# ========================================================================
# BUILDER METHODS - Fluent interface for machine construction
# ========================================================================
def add_linear_axis(
self, name, direction_vector, min_limit=0, max_limit=1000, max_velocity=10000
):
"""Add a linear axis to the configuration"""
self.linear_axes[name] = LinearAxis(
name, direction_vector, min_limit, max_limit, max_velocity
)
return self
def add_rotary_axis(
self, name, rotation_vector, min_limit=-360, max_limit=360, max_velocity=36000
):
"""Add a rotary axis to the configuration"""
self.rotary_axes[name] = RotaryAxis(
name, rotation_vector, min_limit, max_limit, max_velocity
)
return self
def add_spindle(
self,
name,
id=None,
max_power_kw=0,
max_rpm=0,
min_rpm=0,
tool_change="manual",
tool_axis=None,
):
"""Add a spindle to the configuration"""
if tool_axis is None:
tool_axis = FreeCAD.Vector(0, 0, -1)
self.spindles.append(
Spindle(name, id, max_power_kw, max_rpm, min_rpm, tool_change, tool_axis)
)
return self
def save(self, filepath):
"""Save this configuration to a file
Args:
filepath: Path to save the configuration file
Returns:
Path object of saved file
"""
filepath = pathlib.Path(filepath)
data = self.to_dict()
try:
with open(filepath, "w", encoding="utf-8") as f:
json.dump(data, f, indent=4, ensure_ascii=False)
Path.Log.debug(f"Saved machine configuration to {filepath}")
return filepath
except Exception as e:
Path.Log.error(f"Failed to save configuration: {e}")
raise Exception(f"Failed to save machine file {filepath}: {e}")
def set_alignment_axes(self, primary, secondary=None):
"""Set the primary and secondary rotary axes for alignment strategy
For 4-axis machines, secondary can be None (single rotary axis)
For 5-axis machines, both primary and secondary are required
"""
if primary not in self.rotary_axes:
raise ValueError(f"Primary axis {primary} not found in configuration")
if secondary is not None and secondary not in self.rotary_axes:
raise ValueError(f"Secondary axis {secondary} not found in configuration")
self.primary_rotary_axis = primary
self.secondary_rotary_axis = secondary
return self
def get_axis_by_name(self, name):
"""Get a rotary axis by name"""
return self.rotary_axes.get(name)
def get_spindle_by_index(self, index):
"""Get a spindle by its index in the list"""
if 0 <= index < len(self.spindles):
return self.spindles[index]
raise ValueError(f"Spindle index {index} out of range")
def get_spindle_by_name(self, name):
"""Get a spindle by name (case-insensitive)"""
name_lower = name.lower()
for spindle in self.spindles:
if spindle.name.lower() == name_lower:
return spindle
raise ValueError(f"Spindle with name '{name}' not found")
def get_spindle_by_id(self, id):
"""Get a spindle by ID (if present)"""
if id is None:
raise ValueError("ID cannot be None")
for spindle in self.spindles:
if spindle.id == id:
return spindle
raise ValueError(f"Spindle with ID '{id}' not found")
@classmethod
def create_AC_table_config(cls, a_limits=(-120, 120), c_limits=(-360, 360)):
"""Create standard A/C table configuration"""
config = cls("AC Table Configuration")
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.add_rotary_axis("A", FreeCAD.Vector(1, 0, 0), a_limits[0], a_limits[1])
config.add_rotary_axis("C", FreeCAD.Vector(0, 0, 1), c_limits[0], c_limits[1])
config.set_alignment_axes("C", "A")
return config
@classmethod
def create_BC_head_config(cls, b_limits=(-120, 120), c_limits=(-360, 360)):
"""Create standard B/C head configuration"""
config = cls("BC Head Configuration")
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.add_rotary_axis("B", FreeCAD.Vector(0, 1, 0), b_limits[0], b_limits[1])
config.add_rotary_axis("C", FreeCAD.Vector(0, 0, 1), c_limits[0], c_limits[1])
config.set_alignment_axes("C", "B")
config.compound_moves = True # Ensure compound moves are enabled for test compatibility
return config
@classmethod
def create_AB_table_config(cls, a_limits=(-120, 120), b_limits=(-120, 120)):
"""Create standard A/B table configuration"""
config = cls("AB Table Configuration")
# AB configuration will be detected as 'custom' by the machine_type property
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.add_rotary_axis("A", FreeCAD.Vector(1, 0, 0), a_limits[0], a_limits[1])
config.add_rotary_axis("B", FreeCAD.Vector(0, 1, 0), b_limits[0], b_limits[1])
config.set_alignment_axes("A", "B")
return config
@classmethod
def create_4axis_A_config(cls, a_limits=(-120, 120)):
"""Create standard 4-axis XYZA configuration (rotary table around X)"""
config = cls("4-Axis XYZA Configuration")
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.add_rotary_axis("A", FreeCAD.Vector(1, 0, 0), a_limits[0], a_limits[1])
config.set_alignment_axes("A", None)
config.description = "4-axis machine with A-axis rotary table (rotation around X-axis)"
return config
@classmethod
def create_4axis_B_config(cls, b_limits=(-120, 120)):
"""Create standard 4-axis XYZB configuration (rotary table around Y)"""
config = cls("4-Axis XYZB Configuration")
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.add_rotary_axis("B", FreeCAD.Vector(0, 1, 0), b_limits[0], b_limits[1])
config.set_alignment_axes("B", None)
config.description = "4-axis machine with B-axis rotary table (rotation around Y-axis)"
return config
@classmethod
def create_3axis_config(cls):
"""Create standard 3-axis XYZ configuration (no rotary axes)"""
config = cls("3-Axis XYZ Configuration")
config.add_linear_axis("X", FreeCAD.Vector(1, 0, 0))
config.add_linear_axis("Y", FreeCAD.Vector(0, 1, 0))
config.add_linear_axis("Z", FreeCAD.Vector(0, 0, 1))
config.description = "Standard 3-axis machine with no rotary axes"
# No rotary axes to add, no alignment axes to set
return config
def to_dict(self):
"""Serialize configuration to dictionary for JSON persistence"""
# Build flattened axes structure
axes = {}
# Add linear axes from LinearAxis objects
for axis_name, axis_obj in self.linear_axes.items():
dir_vec = axis_obj.direction_vector
joint = [[dir_vec.x, dir_vec.y, dir_vec.z], [0, 0, 0]]
axes[axis_name] = {
"type": "linear",
"min": axis_obj.min_limit,
"max": axis_obj.max_limit,
"max_velocity": axis_obj.max_velocity,
"joint": joint,
"sequence": axis_obj.sequence,
}
# Add rotary axes
for axis_name, axis_obj in self.rotary_axes.items():
rot_vec = axis_obj.rotation_vector
joint = [[0, 0, 0], [rot_vec.x, rot_vec.y, rot_vec.z]]
axes[axis_name] = {
"type": "angular",
"min": axis_obj.min_limit,
"max": axis_obj.max_limit,
"max_velocity": axis_obj.max_velocity,
"joint": joint,
"sequence": axis_obj.sequence,
"prefer_positive": axis_obj.prefer_positive,
}
data = {
"freecad_version": self.freecad_version,
"machine": {
"name": self.name,
"manufacturer": self.manufacturer,
"description": self.description,
"units": self.configuration_units,
"axes": axes,
"spindles": [spindle.to_dict() for spindle in self.spindles],
},
"version": self.version,
}
# Add post-processor configuration
data["postprocessor"] = {
"file_name": self.postprocessor_file_name,
"args": self.postprocessor_args,
}
# Output options
data["output"] = {
"command_space": self.output.command_space,
"comment_symbol": self.output.comment_symbol,
"output_comments": self.output.output_comments,
"end_of_line_chars": self.output.end_of_line_chars,
"line_increment": self.output.line_increment,
"line_number_start": self.output.line_number_start,
"line_numbers": self.output.line_numbers,
"line_number_prefix": self.output.line_number_prefix,
"list_tools_in_header": self.output.list_tools_in_header,
"list_fixtures_in_header": self.output.list_fixtures_in_header,
"machine_name_in_header": self.output.machine_name_in_header,
"description_in_header": self.output.description_in_header,
"date_in_header": self.output.date_in_header,
"document_name_in_header": self.output.document_name_in_header,
"filter_double_parameters": self.output.filter_double_parameters,
"filter_double_commands": self.output.filter_double_commands,
"output_blank_lines": self.output.output_blank_lines,
"output_bcnc_comments": self.output.output_bcnc_comments,
"output_header": self.output.output_header,
"output_labels": self.output.output_labels,
"output_operation_labels": self.output.output_operation_labels,
"output_units": self.output.output_units.value,
"axis_precision": self.output.axis_precision,
"feed_precision": self.output.feed_precision,
"spindle_precision": self.output.spindle_precision,
}
# G-code blocks (only non-empty ones)
blocks = {}
if self.blocks.pre_job:
blocks["pre_job"] = self.blocks.pre_job
if self.blocks.post_job:
blocks["post_job"] = self.blocks.post_job
if self.blocks.preamble:
blocks["preamble"] = self.blocks.preamble
if self.blocks.postamble:
blocks["postamble"] = self.blocks.postamble
if self.blocks.safetyblock:
blocks["safetyblock"] = self.blocks.safetyblock
if self.blocks.pre_operation:
blocks["pre_operation"] = self.blocks.pre_operation
if self.blocks.post_operation:
blocks["post_operation"] = self.blocks.post_operation
if self.blocks.pre_tool_change:
blocks["pre_tool_change"] = self.blocks.pre_tool_change
if self.blocks.post_tool_change:
blocks["post_tool_change"] = self.blocks.post_tool_change
if self.blocks.tool_return:
blocks["tool_return"] = self.blocks.tool_return
if self.blocks.pre_fixture_change:
blocks["pre_fixture_change"] = self.blocks.pre_fixture_change
if self.blocks.post_fixture_change:
blocks["post_fixture_change"] = self.blocks.post_fixture_change
if self.blocks.pre_rotary_move:
blocks["pre_rotary_move"] = self.blocks.pre_rotary_move
if self.blocks.post_rotary_move:
blocks["post_rotary_move"] = self.blocks.post_rotary_move
if blocks:
data["blocks"] = blocks
# Processing options
data["processing"] = {
"drill_cycles_to_translate": self.processing.drill_cycles_to_translate,
"show_machine_units": self.processing.show_machine_units,
"spindle_wait": self.processing.spindle_wait,
"split_arcs": self.processing.split_arcs,
"suppress_commands": self.processing.suppress_commands,
"tool_before_change": self.processing.tool_before_change,
"tool_change": self.processing.tool_change,
"translate_drill_cycles": self.processing.translate_drill_cycles,
}
if self.processing.return_to:
data["processing"]["return_to"] = list(self.processing.return_to)
return data
def _initialize_3axis_config(self) -> None:
"""Initialize as a standard 3-axis XYZ configuration (no rotary axes)"""
self.linear_axes = {
"X": LinearAxis("X", FreeCAD.Vector(1, 0, 0)),
"Y": LinearAxis("Y", FreeCAD.Vector(0, 1, 0)),
"Z": LinearAxis("Z", FreeCAD.Vector(0, 0, 1)),
}
self.rotary_axes = {}
self.primary_rotary_axis = None
self.secondary_rotary_axis = None
self.compound_moves = True
@classmethod
def create_3axis_config(cls) -> "Machine":
"""Create standard 3-axis XYZ configuration (no rotary axes)"""
config = cls("3-Axis XYZ Configuration")
config._initialize_3axis_config()
return config
def _initialize_4axis_A_config(self, a_limits=(-120, 120)) -> None:
"""Initialize as a 4-axis XYZA configuration (rotary table around X)"""
self._initialize_3axis_config()
self.rotary_axes["A"] = RotaryAxis(
"A", FreeCAD.Vector(1, 0, 0), min_limit=a_limits[0], max_limit=a_limits[1]
)
self.primary_rotary_axis = "A"
def _initialize_4axis_B_config(self, b_limits=(-120, 120)) -> None:
"""Initialize as a 4-axis XYZB configuration (rotary table around Y)"""
self._initialize_3axis_config()
self.rotary_axes["B"] = RotaryAxis(
"B", FreeCAD.Vector(0, 1, 0), min_limit=b_limits[0], max_limit=b_limits[1]
)
self.primary_rotary_axis = "B"
def _initialize_AC_table_config(self, a_limits=(-120, 120), c_limits=(-360, 360)) -> None:
"""Initialize as a 5-axis AC table configuration"""
self._initialize_4axis_A_config(a_limits)
self.rotary_axes["C"] = RotaryAxis(
"C", FreeCAD.Vector(0, 0, 1), min_limit=c_limits[0], max_limit=c_limits[1]
)
self.secondary_rotary_axis = "C"
def _initialize_BC_head_config(self, b_limits=(-120, 120), c_limits=(-360, 360)) -> None:
"""Initialize as a 5-axis BC head configuration"""
self._initialize_4axis_B_config(b_limits)
self.rotary_axes["C"] = RotaryAxis(
"C", FreeCAD.Vector(0, 0, 1), min_limit=c_limits[0], max_limit=c_limits[1]
)
self.secondary_rotary_axis = "C"
def _initialize_from_machine_type(self, machine_type: str) -> None:
"""Initialize machine configuration based on machine type"""
if machine_type == "xyz":
self._initialize_3axis_config()
elif machine_type == "xyza":
self._initialize_4axis_A_config()
elif machine_type == "xyzb":
self._initialize_4axis_B_config()
elif machine_type == "xyzac":
self._initialize_AC_table_config()
elif machine_type == "xyzbc":
self._initialize_BC_head_config()
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "Machine":
"""Deserialize configuration from dictionary (supports both old and new formats)"""
machine_data = data.get("machine", data) # Support both old and new formats
# Extract basic configuration
config = cls(
name=machine_data.get("name", "Loaded Machine"),
configuration_units=machine_data.get("units", "metric"),
manufacturer=machine_data.get("manufacturer", ""),
description=machine_data.get("description", ""),
)
# Parse axes from new flattened structure
axes = machine_data.get("axes", {})
config.linear_axes = {}
config.rotary_axes = {}
# Determine primary/secondary rotary axes
rotary_axis_names = [
name for name, axis_data in axes.items() if axis_data.get("type") == "angular"
]
rotary_axis_names.sort() # Sort to get consistent ordering
if len(rotary_axis_names) > 0:
config.primary_rotary_axis = rotary_axis_names[0]
if len(rotary_axis_names) > 1:
config.secondary_rotary_axis = rotary_axis_names[1]
# Parse linear and rotary axes
for axis_name, axis_data in axes.items():
axis_type = axis_data.get("type", "linear")
if axis_type == "linear":
# Extract direction vector from joint
joint = axis_data.get("joint", [[1, 0, 0], [0, 0, 0]])
direction_vec = FreeCAD.Vector(joint[0][0], joint[0][1], joint[0][2])
min_limit = axis_data.get("min", 0)
max_limit = axis_data.get("max", 1000)
max_velocity = axis_data.get("max_velocity", 10000)
config.linear_axes[axis_name] = LinearAxis(
name=axis_name,
direction_vector=direction_vec,
min_limit=min_limit,
max_limit=max_limit,
max_velocity=max_velocity,
)
elif axis_type == "angular":
joint = axis_data.get("joint", [[0, 0, 0], [0, 0, 1]])
rotation_vec = FreeCAD.Vector(joint[1][0], joint[1][1], joint[1][2])
min_limit = axis_data.get("min", -360)
max_limit = axis_data.get("max", 360)
max_velocity = axis_data.get("max_velocity", 36000)
prefer_positive = axis_data.get("prefer_positive", True)
config.rotary_axes[axis_name] = RotaryAxis(
name=axis_name,
rotation_vector=rotation_vec,
min_limit=min_limit,
max_limit=max_limit,
max_velocity=max_velocity,
prefer_positive=prefer_positive,
)
# Parse spindles if present
spindles = machine_data.get("spindles", [])
config.spindles = [Spindle.from_dict(s) for s in spindles]
# Parse post-processor settings if present
post_data = data.get("postprocessor", {})
if post_data:
config.postprocessor_file_name = post_data.get("file_name", "")
config.postprocessor_args = post_data.get("args", "")
# Load output options
output_data = data.get("output", {})
if output_data:
# Line formatting options
config.output.command_space = output_data.get("command_space", " ")
config.output.comment_symbol = output_data.get("comment_symbol", "(")
config.output.end_of_line_chars = output_data.get("end_of_line_chars", "\n")
config.output.line_increment = output_data.get("line_increment", 10)
config.output.line_number_start = output_data.get("line_number_start", 100)
config.output.line_numbers = output_data.get("line_numbers", False)
config.output.line_number_prefix = output_data.get("line_number_prefix", "N")
# Output content options (with backward compatibility)
config.output.output_comments = output_data.get(
"output_comments", output_data.get("comments", True)
)
config.output.output_blank_lines = output_data.get(
"output_blank_lines", output_data.get("blank_lines", True)
)
config.output.output_bcnc_comments = output_data.get("output_bcnc_comments", True)
config.output.output_header = output_data.get(
"output_header", output_data.get("header", True)
)
config.output.output_labels = output_data.get(
"output_labels", output_data.get("path_labels", False)
)
config.output.output_operation_labels = output_data.get(
"output_operation_labels", output_data.get("show_operation_labels", True)
)
# Header content options (with backward compatibility)
config.output.list_tools_in_header = output_data.get(
"list_tools_in_header", output_data.get("list_tools_in_preamble", False)
)
config.output.list_fixtures_in_header = output_data.get("list_fixtures_in_header", True)
config.output.machine_name_in_header = output_data.get(
"machine_name_in_header", output_data.get("machine_name", False)
)
config.output.description_in_header = output_data.get("description_in_header", True)
config.output.date_in_header = output_data.get("date_in_header", True)
config.output.document_name_in_header = output_data.get("document_name_in_header", True)
# Filter options (with backward compatibility)
config.output.filter_double_parameters = output_data.get(
"filter_double_parameters", output_data.get("output_double_parameters", False)
)
# filter_double_commands comes from processing.modal in old format
config.output.filter_double_commands = output_data.get("filter_double_commands", False)
# Numeric precision settings (with backward compatibility)
config.output.axis_precision = output_data.get("axis_precision", 3)
config.output.feed_precision = output_data.get("feed_precision", 3)
config.output.spindle_precision = output_data.get(
"spindle_precision", output_data.get("spindle_decimals", 0)
)
# Handle output_units conversion from string to enum
output_units_str = output_data.get("output_units", "metric")
config.output.output_units = (
OutputUnits.METRIC if output_units_str == "metric" else OutputUnits.IMPERIAL
)
# These fields are now in ProcessingOptions (backward compatibility)
if "tool_change" in output_data:
config.processing.tool_change = output_data["tool_change"]
# Load processing options
processing_data = data.get("processing", {})
if processing_data:
config.processing.drill_cycles_to_translate = processing_data.get(
"drill_cycles_to_translate", ["G73", "G81", "G82", "G83"]
)
config.processing.show_machine_units = processing_data.get("show_machine_units", True)
config.processing.spindle_wait = processing_data.get("spindle_wait", 0.0)
config.processing.split_arcs = processing_data.get("split_arcs", False)
config.processing.suppress_commands = processing_data.get("suppress_commands", [])
config.processing.tool_before_change = processing_data.get("tool_before_change", False)
config.processing.tool_change = processing_data.get("tool_change", True)
config.processing.translate_drill_cycles = processing_data.get(
"translate_drill_cycles", False
)
return_to = processing_data.get("return_to", None)
config.processing.return_to = tuple(return_to) if return_to is not None else None
# Backward compatibility: modal moved to output.filter_double_commands
if "modal" in processing_data:
config.output.filter_double_commands = processing_data["modal"]
# Load G-code blocks
blocks_data = data.get("blocks", {})
if blocks_data:
for block_name in [
"pre_job",
"post_job",
"preamble",
"postamble",
"safetyblock",
"pre_operation",
"post_operation",
"pre_tool_change",
"post_tool_change",
"tool_return",
"pre_fixture_change",
"post_fixture_change",
"pre_rotary_move",
"post_rotary_move",
"pre_spindle_change",
"post_spindle_change",
"finish_label",
]:
if block_name in blocks_data:
setattr(config.blocks, block_name, blocks_data[block_name])
return config
class MachineFactory:
"""Factory class for creating, loading, and saving machine configurations"""
# Default configuration directory
_config_dir = None
@classmethod
def set_config_directory(cls, directory):
"""Set the directory for storing machine configuration files"""
cls._config_dir = pathlib.Path(directory)
cls._config_dir.mkdir(parents=True, exist_ok=True)
@classmethod
def get_config_directory(cls):
"""Get the configuration directory, creating default if not set"""
if cls._config_dir is None:
# Use FreeCAD user data directory + CAM/Machines
try:
cls._config_dir = Path.Preferences.getAssetPath() / "Machines"
cls._config_dir.mkdir(parents=True, exist_ok=True)
except Exception as e:
Path.Log.warning(f"Could not create default config directory: {e}")
cls._config_dir = pathlib.Path.cwd() / "Machines"
cls._config_dir.mkdir(parents=True, exist_ok=True)
return cls._config_dir
@classmethod
def save_configuration(cls, config, filename=None):
"""
Save a machine configuration to a JSON file
Args:
config: Machine object to save
filename: Optional filename (without path). If None, uses sanitized config name
Returns:
Path to the saved file
"""
if filename is None:
# Sanitize the config name for use as filename
filename = config.name.replace(" ", "_").replace("/", "_") + ".fcm"
config_dir = cls.get_config_directory()
filepath = config_dir / filename
try:
data = config.to_dict()
with open(filepath, "w", encoding="utf-8") as f:
json.dump(data, f, sort_keys=True, indent=4)
Path.Log.debug(f"Saved machine file: {filepath}")
return filepath
except Exception as e:
Path.Log.error(f"Failed to save configuration: {e}")
raise Exception(f"Failed to save machine file {filepath}: {e}")
@classmethod
def load_configuration(cls, filename):
"""
Load a machine configuration from a JSON file
Args:
filename: Filename (with or without path). If no path, searches config directory
Returns:
Dictionary containing machine configuration data (new format) or
Machine object if loading old format
Raises:
FileNotFoundError: If the file does not exist
json.JSONDecodeError: If the file is not valid JSON
Exception: For other I/O errors
"""
filepath = pathlib.Path(filename)
# If no directory specified, look in config directory
if not filepath.parent or filepath.parent == pathlib.Path("."):
filepath = cls.get_config_directory() / filename
try:
with open(filepath, "r", encoding="utf-8") as f:
data = json.load(f)
Path.Log.debug(f"Loaded machine file: {filepath}")
machine = Machine.from_dict(data)
Path.Log.debug(f"Loaded machine configuration from {filepath}")
return machine
except FileNotFoundError:
raise FileNotFoundError(f"Machine file not found: {filepath}")
except json.JSONDecodeError as e:
raise ValueError(f"Invalid JSON in machine file {filepath}: {e}")
except Exception as e:
raise Exception(f"Failed to load machine file {filepath}: {e}")
@classmethod
def create_default_machine_data(cls):
"""
Create a default machine configuration dictionary for the editor.
Returns:
Dictionary with default machine configuration structure
"""
machine = Machine(name="New Machine")
return machine.to_dict()
@classmethod
def list_configuration_files(cls) -> list[tuple[str, pathlib.Path]]:
"""Get list of available machine files from the asset directory.
Scans the Machine subdirectory of the asset path for .fcm files
and returns tuples of (display_name, file_path).
Returns:
list: List of (name, path) tuples for discovered machine files
"""
machines = [("<any>", None)]
try:
asset_base = cls.get_config_directory()
if asset_base.exists():
for p in sorted(asset_base.glob("*.fcm")):
name = cls.get_machine_display_name(p.name)
machines.append((name, p.name))
except Exception:
# Failed to access machine directory or read files, return default list only
pass
return machines
@classmethod
def list_configurations(cls) -> list[str]:
"""Get list of available machines from the asset directory.
Scans the Machine subdirectory of the asset path for .fcm files
and extracts machine names. Returns ["<any>"] plus discovered machine names.
Returns:
list: List of machine names starting with "<any>"
"""
machines = cls.list_configuration_files()
return [name for name, path in machines]
@classmethod
def delete_configuration(cls, filename):
"""
Delete a machine configuration file
Args:
filename: Name of the configuration file to delete
Returns:
True if deleted successfully, False otherwise
"""
filepath = cls.get_config_directory() / filename
try:
if filepath.exists():
filepath.unlink()
Path.Log.debug(f"Deleted machine: {filepath}")
return True
else:
Path.Log.warning(f"Machine file not found: {filepath}")
return False
except Exception as e:
Path.Log.error(f"Failed to delete machine: {e}")
return False
@classmethod
def create_standard_configs(cls):
"""
Create and save all standard machine configurations
Returns:
Dictionary mapping config names to file paths
"""
configs = {
"XYZ": Machine.create_3axis_config(),
"XYZAC": Machine.create_AC_table_config(),
"XYZBC": Machine.create_BC_head_config(),
"XYZA": Machine.create_4axis_A_config(),
"XYZB": Machine.create_4axis_B_config(),
}
saved_paths = {}
for name, config in configs.items():
try:
filepath = cls.save_configuration(config, f"{name}.fcm")
saved_paths[name] = filepath
except Exception as e:
Path.Log.error(f"Failed to save {name}: {e}")
return saved_paths
@classmethod
def get_builtin_config(cls, config_type):
"""
Get a built-in machine configuration without loading from disk
Args:
config_type: One of "XYZ", "XYZAC", "XYZBC", "XYZA", "XYZB"
Returns:
Machine object
"""
config_map = {
"XYZ": Machine.create_3axis_config,
"XYZAC": Machine.create_AC_table_config,
"XYZBC": Machine.create_BC_head_config,
"XYZA": Machine.create_4axis_A_config,
"XYZB": Machine.create_4axis_B_config,
}
if config_type not in config_map:
raise ValueError(
f"Unknown config type: {config_type}. Available: {list(config_map.keys())}"
)
return config_map[config_type]()
@classmethod
def get_machine(cls, machine_name):
"""
Get a machine configuration by name from the assets folder
Args:
machine_name: Name of the machine to load (without .fcm extension)
Returns:
Machine object
Raises:
FileNotFoundError: If no machine with that name is found
ValueError: If the loaded data is not a valid machine configuration
"""
# Get list of available machine files
machine_files = cls.list_configuration_files()
# Find the file matching the machine name (case-insensitive)
target_path = None
machine_name_lower = machine_name.lower()
for name, path in machine_files:
if name.lower() == machine_name_lower and path is not None:
target_path = path
break
if target_path is None:
available = [name for name, path in machine_files if path is not None]
raise FileNotFoundError(
f"Machine '{machine_name}' not found. Available machines: {available}"
)
# Load the configuration using the path from list_configuration_files()
data = cls.load_configuration(target_path)
# If load_configuration returned a dict (new format), convert to Machine
if isinstance(data, dict):
return Machine.from_dict(data)
else:
# Already a Machine object (old format)
return data
@classmethod
def get_machine_display_name(cls, filename):
"""
Get the display name for a machine from its filename in the config directory.
Args:
filename: Name of the machine file (without path)
Returns:
str: Display name (machine name from JSON or filename stem)
"""
filepath = cls.get_config_directory() / filename
try:
with open(filepath, "r", encoding="utf-8") as f:
data = json.load(f)
return data.get("machine", {}).get("name", filepath.stem)
except Exception:
return filepath.stem
|