Devices Numbering and Cabinet
Renumbering devices/pages/cables/terminals/connections, device lists, and cabinet/segment calculations.
17 tools (all prefixed eplan_ when registered as MCP tools).
eplan_generate_connections
Section titled “eplan_generate_connections”eplan_generate_connections(project_name: str=None, page_name: str=None, page_names: List[str]=None, page_identifiers: List[str]=None, rebuild_all: bool=False, use_page_filter: bool=False, page_filter_name: str=None)Generate connections in project. Action: generate
Args: project_name: Project path (optional) page_name: Specific page (optional) page_names: List of page names (e.g., [“=AP+ST1/2”, “=AP+ST1/4”]) page_identifiers: List of page identifiers from StorableObject.ToStringIdentifier() rebuild_all: Rebuild all connections vs update only use_page_filter: Use active page filter page_filter_name: Name of specific page filter to use
eplan_generate_cables
Section titled “eplan_generate_cables”eplan_generate_cables(project_name: str=None, creation_scheme: str=None, numbering_scheme: str=None, autoselect_scheme: str=None, keep_old_names: bool=True, start_value: int=1, step_value: int=1, only_auto_cables: bool=True)Generate cables in project. Action: generate
Args: project_name: Project path (optional) creation_scheme: Cable creation scheme numbering_scheme: Cable numbering scheme autoselect_scheme: Auto cable selection scheme keep_old_names: Preserve existing cable names start_value: Start value for DT counter step_value: Increment value only_auto_cables: Only select for auto cables
eplan_renumber_devices
Section titled “eplan_renumber_devices”eplan_renumber_devices(project_name: str=None, start_value: int=1, step_value: int=1, config_scheme: str=None, filter_scheme: str=None, identifier: str=None, use_selection: bool=False, post_numerate: bool=True, also_numerated_by_plc: bool=False, numerate_cables: bool=False)Renumber devices in project. Action: renumber
Args: project_name: Project path (optional) start_value: Start value (default 1) step_value: Increment value (default 1) config_scheme: Configuration scheme name filter_scheme: Filter scheme name identifier: Device identifier pattern (e.g., “X*”, “V”) use_selection: Only renumber selected objects post_numerate: Only renumber invalid tags with “?” (default True) also_numerated_by_plc: Include devices influenced by PLC numbering numerate_cables: Also numerate cables with source/target info
eplan_renumber_pages
Section titled “eplan_renumber_pages”eplan_renumber_pages(project_name: str=None, start_value: int=1, step_value: int=1, structure_oriented: bool=False, keep_interval: bool=False, keep_text: bool=False, subpages: int=0, use_selection: bool=False)Renumber pages in project. Action: renumber
Args: project_name: Project path (optional) start_value: Start value (default 1) step_value: Increment value (default 1) structure_oriented: Number per structure identifier keep_interval: Retain increments between selected pages keep_text: Don’t overwrite alphabetic part of page name subpages: 0=Retain, 1=ConsecutiveNumbering, 2=ConvertIntoMainPages use_selection: Only renumber selected pages
eplan_renumber_cables
Section titled “eplan_renumber_cables”eplan_renumber_cables(project_name: str=None, start_value: int=1, step_value: int=1, config_scheme: str=None, use_selection: bool=False, keep_existing: bool=False, keep_identifier: bool=False)Renumber cables in project. Action: renumber
Args: project_name: Project path (optional) start_value: Start value (default 1) step_value: Increment value (default 1) config_scheme: Configuration scheme name use_selection: Only renumber selected cables keep_existing: Keep existing cable DTs (only renumber new/copied) keep_identifier: Keep identifier, only reassign counters
eplan_renumber_terminals
Section titled “eplan_renumber_terminals”eplan_renumber_terminals(project_name: str=None, start_value: int=1, step_value: int=1, config_scheme: str=None, use_selection: bool=False, sequence: int=0, extent: int=0, prefix: str=None, suffix: str=None, post_numerate: bool=True, also_numerated_by_plc: bool=False, permit_sort_change: bool=False, fill_gaps: bool=False, potential_n: int=0, potential_pe: int=0, potential_sh: int=0, multiple_terminals: int=0, keep_alpha: int=0)Renumber terminals in project. Action: renumber
Args: project_name: Project path (optional) start_value: Start value (default 1) step_value: Increment value (default 1) config_scheme: Configuration scheme name use_selection: Only renumber selected terminals sequence: 0=Like sorting, 1=Page oriented, 2=Cable oriented, 3=Level oriented extent: 0=Selected only, 1=All selected terminal strips prefix: Prefix for terminal designation suffix: Suffix for terminal designation post_numerate: Only renumber invalid tags with “?” (default True) also_numerated_by_plc: Include terminals influenced by PLC numbering permit_sort_change: Allow sort change fill_gaps: Fill gaps in numbering potential_n: N terminals: 0=Ignore, 1=DoNotModify, 2=Renumber potential_pe: PE terminals: 0=Ignore, 1=DoNotModify, 2=Renumber potential_sh: SH terminals: 0=Ignore, 1=DoNotModify, 2=Renumber multiple_terminals: 0=DontModify, 1=NumberSame, 2=NumberIndividually keep_alpha: 0=DontModify, 1=KeepAlphaElements, 2=Number
eplan_renumber_connections
Section titled “eplan_renumber_connections”eplan_renumber_connections(project_name: str=None, config_scheme: str=None, use_selection: bool=False, groups: Dict[int, dict]=None, overwrite: int=0, avoid_identical_designations: int=0, visibility: int=0, mark_as_manual: bool=False)Renumber connections in project. Action: renumber
Args: project_name: Project path (optional) config_scheme: Configuration scheme name use_selection: Only renumber selected connections groups: Dict of group configurations, e.g.: {1: {“start”: 1, “step”: 1}, 2: {“start”: 10, “step”: 5}} overwrite: 0=All (always overwrite), 1=ExceptManuals, 2=None (never) avoid_identical_designations: 0=InProject, 1=InSelection, 2=None, 3=PerRange visibility: 0=AllVisible, 1=DoNotModify, 2=OncePerPageAndRange mark_as_manual: Mark renumbered connections as “manually set”
Example: renumber_connections( config_scheme=“ConnectionOriented”, groups={1: {“start”: 1, “step”: 1}}, overwrite=1, use_selection=True )
eplan_export_device_list
Section titled “eplan_export_device_list”eplan_export_device_list(export_file: str, project_name: str=None, format: str='XDLXmlExporter')Export device list from project. Action: devicelist
Args: export_file: Output file path project_name: Project path (optional) format: Export format - “XDLXmlExporter”, “XDLTxtImporterExporter”, “XDLCsvImporterExporter”
eplan_import_device_list
Section titled “eplan_import_device_list”eplan_import_device_list(import_file: str, project_name: str=None, format: str='XDLXmlExporter')Import device list into project. Action: devicelist
eplan_delete_device_list
Section titled “eplan_delete_device_list”eplan_delete_device_list(project_name: str=None)Delete device list from project. Action: devicelist
eplan_calculate_cabinet_weight
Section titled “eplan_calculate_cabinet_weight”eplan_calculate_cabinet_weight(project_name: str=None)Calculate total weight of cabinet. Action: XCabCalculateEnclosureTotalWeightAction
eplan_update_segments_filling
Section titled “eplan_update_segments_filling”eplan_update_segments_filling(project_name: str=None)Calculate and set segment filling values. Action: UpdateSegmentsFilling
eplan_topology_operation
Section titled “eplan_topology_operation”eplan_topology_operation(operation_type: str, project_name: str=None)Perform topology-related operations. Action: Topology
eplan_import_preplanning_data
Section titled “eplan_import_preplanning_data”eplan_import_preplanning_data(import_file: str, scheme_name: str, project_name: str=None, table_name: str=None, delimiter: str=None, header: bool=None, target_name: str=None, skip_errors: bool=None, overwrite: bool=None, update_only: bool=None)Import pre-planning data. Action: ImportPrePlanningData
The previous wrapper sent IMPORTFILE (the action documents FILENAME) and never sent SCHEMENAME at all, though the action documents both as mandatory. Audit #42 item 6.
Args: import_file: Full path of the source file. Mandatory. scheme_name: Name of the scheme mapping external data fields to EPLAN properties. Mandatory - EPLAN’s own docs mark this required, same as import_file. project_name: Project path (optional). table_name: Table/data-area name within the source, for Excel imports (optional). delimiter: Column separator, for text-file imports (optional). header: Column names appear in the “External field” column of the assignment table (Excel imports only). Optional, EPLAN default False. target_name: DMPLAOBJECT_FULLDESIGNATION of the object to insert the imported data under (optional). If omitted, data is inserted under the project. skip_errors: Do not abort on errors/messages during import (optional). EPLAN’s own default is True. overwrite: Overwrite existing planning objects that share a name with an imported one (optional). EPLAN’s own default is True. update_only: Only update existing structure segments/planning objects, insert nothing new (optional). EPLAN’s own default is False.
eplan_export_segments_template
Section titled “eplan_export_segments_template”eplan_export_segments_template(export_file: str, project_name: str=None, description: str=None)Export segment templates to file. Action: ExportSegmentsTemplate
The previous wrapper sent EXPORTFILE; the action documents FILENAME. Audit #42 item 6.
Args: export_file: Full path of the target file. Mandatory. project_name: Project path (optional). description: Description stored in the exported file, in multi-language string format (optional).
eplan_import_segments_template
Section titled “eplan_import_segments_template”eplan_import_segments_template(import_file: str, project_name: str=None)Import segment templates from file. Action: ImportSegmentsTemplate
The previous wrapper sent IMPORTFILE; the action documents FILENAME. Audit #42 item 6.
Args: import_file: Full path of the source file. Mandatory. project_name: Project path (optional).
eplan_create_graving_text
Section titled “eplan_create_graving_text”eplan_create_graving_text(complete: bool=None)Generate the engraving text of a cable from the DTs of its source and target. Action: XCCreateGravingtextAction
By default the designation is abbreviated according to the VASS standard (Volkswagen Audi Seat Skoda): structure identifiers that have the same name on source and target are removed, starting from the left.
This action takes no PROJECTNAME - it works on the current GUI selection (the selected cable) in the open project. Select the cable first; calling it headless with nothing selected does nothing.
Args: complete: Retain mounting locations of the same name. False/None (0, the default) truncates per the VASS standard; True (1) keeps the identical structure identifiers.
This page is generated from the docstrings in Canary-ECAD/eplan-mcp.