How to install macros: Difference between revisions

From FreeCAD Documentation
m (Reworded a few sentences)
mNo edit summary
(31 intermediate revisions by 5 users not shown)
Line 11: Line 11:


==Description== <!--T:2-->
==Description== <!--T:2-->
This short tutorial will show you how to install and use FreeCAD [[macros]].


<!--T:186-->
Macros are sequences of commands or drawing actions which are used to perform a complex operation. Macros are [[Python]] scripts, which means they are text files that can be written and edited with a text editor.
Since v0.17 it is easy to add macros by using the [[Std_AddonMgr|Addon Manager]]. A regular user doesn't need to do more than use this tool. Keep reading for more information regarding installation of [[macros|macros]].


<!--T:140-->
While Python scripts normally have the {{incode|.py}} extension, macros should have the {{incode|.FCMacro}} extension.
Macros are sequences of commands which are used to perform a complex drawing operation. Macros are [[Python|Python]] scripts, which means they are text files that can be written and edited with a text editor.


<!--T:141-->
See [[Introduction to Python]] to learn about the Python programming language, and then [[Python scripting tutorial]] and [[FreeCAD Scripting Basics]] to learn about writing macros.
While Python scripts normally have the {{incode|.py}} extension, FreeCAD macros should have the {{incode|.FCMacro}} extension. A collection of macros written by experienced users is found in the [[macros recipes|macros recipes]] page.

<!--T:142-->
See [[Introduction to Python|Introduction to Python]] to learn about the Python programming language, and then [[Python scripting tutorial|Python scripting tutorial]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]] to learn about writing macros.

<!--T:143-->
Here is a video on [https://wiki.opensourceecology.org/wiki/Installing_Macros_in_FreeCAD installing FreeCAD macros in Ubuntu].


==The Macro menu and toolbar== <!--T:6-->
==The Macro menu and toolbar== <!--T:6-->


===Toolbar===
===Toolbar=== <!--T:7-->
* [[Image:Std_DlgMacroRecord.svg|32px]] [[Std_DlgMacroRecord|Macro recording...]]
<!--T:7-->
* [[Image:Macro-record.svg|32px|record]] [[Std_DlgMacroRecord|Record]]
* [[Image:Std_MacroStopRecord.svg|32px]] [[Std_MacroStopRecord|Stop macro recording]]
* [[Image:Macro-stop.svg|32px|stop]] [[Std_DlgMacroStop|Stop]]
* [[Image:Std_DlgMacroExecute.svg|32px]] [[Std_DlgMacroExecute|Macros...]]
* [[Image:Std_DlgMacroExecuteDirect.svg|32px|open editor]] [[Std_DlgMacroExecuteDirect|Execute macro dialog]]
* [[Image:Std_DlgMacroExecuteDirect.svg|32px]] [[Std_DlgMacroExecuteDirect|Execute macro]]
* [[Image:Macro-execute.svg|32px|execute]] [[Std_DlgMacroExecute|Execute]]


===Menu===
===Menu=== <!--T:144-->
Besides the tools in the toolbar, the following functions are also available in the {{MenuCommand|Macro}} menu.
Besides the tools in the toolbar, the following functions are also available in the {{MenuCommand|Macro}} menu.
* [[Std_MacroAttachDebugger|Attach to remote debugger]]
* [[Image:Debug-start.svg|32px|start]] [[Std_DebugMacro|Debug Start]]
* [[Image:Debug-stop.svg|32px|stop]] [[Std_DebugStop|Debug Stop]]
* [[Image:Std_MacroStartDebug.svg|32px]] [[Std_MacroStartDebug|Debug macro]]
* [[Image:Std_MacroStopDebug.svg|32px]] [[Std_MacroStopDebug|Stop debugging]]
* Step over
* Step into
* [[Std_MacroStepOver|Step over]]
* [[Std_MacroStepInto|Step into]]
* Toggle breakpoint
* [[Std_ToggleBreakpoint|Toggle breakpoint]]


==Macros directory== <!--T:8-->
==Macros directory== <!--T:8-->


</translate>
<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
<translate>
Macros are created in a specific folder under the user's FreeCAD directory. This directory can be configured in the [[Std_DlgMacroExecuteDirect|execute macro dialog]], or in the [[Preferences Editor]], through the menu {{MenuCommand|Edit → Preferences → General → Macro → Macro recording settings}}.


<!--T:178-->
External macros should also be placed in this directory.
Macros are created in a specific folder under the user's FreeCAD directory. This directory can be configured in the [[Std_DlgMacroExecute|Execute macro dialog]], or in the [[Preferences Editor|Preferences Editor]], through the menu {{MenuCommand|Edit → Preferences → General → Macro → Macro recording settings}}.


<!--T:146-->
Downloaded macros should also be placed in this directory.

</translate>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<translate>
<!--T:10-->

1. Open the menu {{MenuCommand|Macro → [[Image:Std DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Macros]]}} to open the [[Std_DlgMacroExecuteDirect|Execute macro dialog]].
=== Default directory === <!--T:147-->
Macros can be simply copied into

</translate>
{{Code|code=
$ROOT_DIR/
}}
<translate>

<!--T:148-->
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup.

<!--T:149-->
The {{incode|$ROOT_DIR}} could be a system wide directory, in which case the macro is installed for all users.
* On Linux it is usually {{incode|/usr/share/freecad/}}
* On Windows it is usually {{incode|C:\Program Files\FreeCAD\}}
* On Mac OSX it is usually {{incode|/Applications/FreeCAD/}}

<!--T:150-->
The {{incode|$ROOT_DIR}} could be a particular user's directory.
* On Linux it is usually {{incode|/home/username/.FreeCAD/}}
* On Windows it is usually {{incode|C:\Users\username\Application Data\FreeCAD\}}
* On Mac OSX it is usually {{incode|/Users/username/Library/Preferences/FreeCAD/}}

=== Configuring the user directory === <!--T:10-->
1. Open the menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Macros...]]}} to open the [[Std_DlgMacroExecute|Execute macro dialog]].


<!--T:11-->
<!--T:11-->
[[Image:Dxf_Importer_Install_01.png|center]]
[[Image:Dxf_Importer_Install_01.png|center]]
{{Caption|align=center|Opening the macro dialog}}
{{Caption|align=center|Opening the Execute macro dialog}}


<!--T:13-->
<!--T:13-->
2. Set the appropriate {{incode|User macros location}}.
2. Set the appropriate {{incode|User macros location}}.
* Linux: usually {{incode|/home/your_user_name/.FreeCAD}}
* Linux: usually {{incode|/home/username/.FreeCAD/}}
* Windows: usually {{incode|C:\Users\your_user_name\AppData\Roaming\FreeCAD\}}
* Windows: usually {{incode|C:\Users\username\AppData\Roaming\FreeCAD\}}
* MacOS: usually {{incode|/Users/your_user_name/Library/Preferences/FreeCAD}}
* MacOS: usually {{incode|/Users/username/Library/Preferences/FreeCAD/}}


<!--T:16-->
<!--T:16-->
Line 81: Line 121:
{{Caption|align=center|Macros directory}}
{{Caption|align=center|Macros directory}}


</translate>
{{clear}}
{{clear}}
</div>
</div>
</div>
</div>
<translate>


== Adding macros ==
== Installing macros == <!--T:152-->


</translate>
<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
<translate>
===Method 1. Copy the code to the macro editor=== <!--T:46-->


=== Automatic method === <!--T:153-->
For macros that are small, the code can be copied and pasted directly into the FreeCAD macro editor.


<!--T:154-->
Starting with FreeCAD 0.17, use the [[Addon Manager|Addon Manager]] in {{MenuCommand|Tools → Addon manager}} to install a macro that has been included in the [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-macros] repository.

</translate>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<translate>
<!--T:47-->

<!--T:179-->
In past versions of FreeCAD you could use two automated ways to install macros and other addons:
* [https://github.com/FreeCAD/FreeCAD-addons addons_installer.FCMacro]: itself a macro, this was the precursor to the Addon Manager, and is hosted in the [https://github.com/FreeCAD/FreeCAD-addons FreeCAD-addons] repository. You don't need to use this tool in new installations of FreeCAD.
* [https://github.com/microelly2/freecad-pluginloader freecad-pluginloader]: also a macro, it could be used to install new components to FreeCAD. It is no longer developed.

<!--T:156-->
The recommended way to install addons, that is, [[external workbenches|external workbenches]] and macros, is the [[Addon Manager|Addon Manager]]. However, you can still add macros to your system with the manual methods described in the following sections; this is useful if you are developing and testing your own code.

</translate>
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed">
<translate>

===Manual method 1. Copy the code to the macro editor=== <!--T:46-->

<!--T:158-->
For macros that are relatively small, 300 lines or less, the code can be copied and pasted directly into the FreeCAD macro editor.

</translate>
<div class="mw-collapsible-content">
<translate>

<!--T:180-->
We will use [[Image:Part_Prism_Apothem.svg|24px]] [[Macro_Apothem_Based_Prism_GUI|Macro Apothem Based Prism GUI]] as an example.
We will use [[Image:Part_Prism_Apothem.svg|24px]] [[Macro_Apothem_Based_Prism_GUI|Macro Apothem Based Prism GUI]] as an example.


<!--T:48-->
<!--T:48-->
1. Go to the macro wiki page, which should be listed in [[Macros recipes]].
1. Go to the macro wiki page, which should be listed in [[Macros recipes|Macros recipes]].


<!--T:159-->
If there is a custom icon download it; click on it with the right mouse button and select {{incode|Save image as...}}; place the icon in the macros directory. This icon can be used as a shortcut for the macro in a [[Customize_Toolbars|custom toolbar]]. The default icon is [[Image:Text-x-python.png|24px]].
If there is a custom icon download it; click on it with the right mouse button and select {{incode|Save image as...}}; place the icon in the macros directory. This icon can be used as a shortcut for the macro in a [[Customize_Toolbars|custom toolbar]]. The default icon is [[Image:Text-x-python.png|24px]].


Line 109: Line 183:


<!--T:51-->
<!--T:51-->
3. In FreeCAD, open the menu {{MenuCommand|Macro → [[Image:Std DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Macros]]}} to open the [[Std_DlgMacroExecuteDirect|Execute macro dialog]].
3. In FreeCAD, open the menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Macros...]]}} to open the [[Std_DlgMacroExecute|Execute macro dialog]].


<!--T:52-->
<!--T:52-->
[[Image:Dxf_Importer_Install_01.png|center]]
[[Image:Dxf_Importer_Install_01.png|center]]
{{Caption|align=center|Opening the execute macro dialog}}
{{Caption|align=center|Opening the Execute macro dialog}}


<!--T:53-->
<!--T:53-->
Line 146: Line 220:
8. A window appears asking for confirmation to save the code; click on {{Button|Yes}}. You can also use {{KEY|Ctrl}}+{{KEY|S}} to save the file.
8. A window appears asking for confirmation to save the code; click on {{Button|Yes}}. You can also use {{KEY|Ctrl}}+{{KEY|S}} to save the file.


<!--T:160-->
Restart FreeCAD to correctly register the new macro.
Restart FreeCAD to correctly register the new macro.


Line 153: Line 228:


<!--T:64-->
<!--T:64-->
9. Open the menu again, {{MenuCommand|Macro → [[Image:Std DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Macros]]}}, select the new macro and press {{Button|Execute}}.
9. Open the menu again, {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Macros...]]}}, select the new macro and press {{Button|Execute}}.


<!--T:65-->
<!--T:65-->
Line 169: Line 244:
11. This macro should return an error if no document is active; other macros open a new document if none exists.
11. This macro should return an error if no document is active; other macros open a new document if none exists.


<!--T:161-->
Create a new document with {{MenuCommand|File → [[Image:Document-new.svg|16px]] [[Std_New|New]]}}, and then repeat the previous steps to execute the macro.
Create a new document with {{MenuCommand|File → [[Image:Std_New.svg|16px]] [[Std_New|New]]}}, and then repeat the previous steps to execute the macro.


<!--T:69-->
<!--T:69-->
Line 183: Line 259:


<!--T:72-->
<!--T:72-->
13. You can open the macro in the editor again to run it or modify it. Go to {{MenuCommand|Macro → [[Image:Std DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Macros]]}}, select the macro and press {{Button|Edit}}.
13. You can open the macro in the editor again to run it or modify it. Go to {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Macros...]]}}, select the macro and press {{Button|Edit}}.


<!--T:73-->
<!--T:73-->
Line 190: Line 266:


<!--T:74-->
<!--T:74-->
14. The macro can now be run with {{MenuCommand|Macro → [[Image:Macro-execute.svg|16px]] [[Std_DlgMacroExecute|Execute macro]]}}, or by clicking on the {{Button|[[Image:Macro-execute.svg|16px]] [[Std_DlgMacroExecute|Execute]]}} button in the toolbar.
14. The macro can now be run with {{MenuCommand|Macro → [[Image:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Execute macro]]}}, or by clicking on the {{Button|[[Image:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Std DlgMacroExecuteDirect]]}} button in the toolbar.


<!--T:75-->
<!--T:75-->
[[Image:Macro Install HowTo 26.png|center]]
[[Image:Macro Install HowTo 26.png|center]]
{{Caption|align=center|Running the macro that is loaded in the editor}}
{{Caption|align=center|Running the macro that is loaded in the editor}}
</translate>

</div>
</div>
</div>
</div>


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
<translate>


===Method 2. Add a macro file from a compressed .zip file=== <!--T:78-->
===Manual method 2. Add a macro file from a compressed .zip file=== <!--T:78-->


<!--T:79-->
<!--T:79-->
Some macros are too big that they cannot be hosted on the wiki. In this case the code may be placed somewhere else, in a Github repository, or in the [https://forum.freecadweb.org/ FreeCAD forum]. Moreover it may be compressed into a {{incode|.zip}} file, {{incode|.tar.xz}}, or other archive.
Some macros are too big that it's inconvenient to copy and paste them into the macro editor, or they cannot be hosted in the wiki. In this case, the code may be hosted somewhere else, in a Github repository, or in the [https://forum.freecadweb.org/ FreeCAD forum]. The code may also be compressed into a {{incode|.zip}} file, tarball {{incode|.tar.xz}}, or other type of archive if it contains several files. If the code is distributed in this way, the archive should be extracted and the files placed in the macros directory.


</translate>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<translate>

<!--T:181-->
We will use [[Image:Text-x-python.png|24px]] [[Macro_screw_maker1_2|Macro screw maker]] as an example.
We will use [[Image:Text-x-python.png|24px]] [[Macro_screw_maker1_2|Macro screw maker]] as an example.


<!--T:164-->
1. Download the compressed code from the forum, [http://forum.freecadweb.org/viewtopic.php?f=22&t=6558#p52887 Screw Maker].
1. Download the compressed code from the forum, [http://forum.freecadweb.org/viewtopic.php?f=22&t=6558#p52887 Screw Maker].


<!--T:80-->
<!--T:80-->
You need to use a decompressor to get the internal files.
You need to use a decompressor to get the internal files.
* For Windows you can use and application like [http://www.7-zip.org/ 7-zip] or [http://www.kanmandet.dk/?p=37 L-Zarc] or [http://www.quickzip.org/quickzip51.html quickzip].
* For Windows you can use an application like [http://www.7-zip.org/ 7-zip] or [http://www.kanmandet.dk/?p=37 L-Zarc] or [http://www.quickzip.org/quickzip51.html quickzip].
* For Linux you can use a command from the terminal
* For Linux you can use a command from the terminal

</translate>
{{Code|code=
{{Code|code=
unzip your_file.zip -d your_directory
unzip your_file.zip -d your_directory
}}
}}
<translate>


<!--T:85-->
<!--T:85-->
Line 254: Line 341:


<!--T:95-->
<!--T:95-->
7. In FreeCAD, open the menu {{MenuCommand|Macro → [[Image:Std DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Macros]]}} to open the [[Std_DlgMacroExecuteDirect|Execute macro dialog]].
7. In FreeCAD, open the menu {{MenuCommand|Macro → [[Image:Std_DlgMacroExecute.svg|16px]] [[Std_DlgMacroExecute|Macros...]]}} to open the [[Std_DlgMacroExecute|Execute macro dialog]].


<!--T:96-->
<!--T:96-->
[[Image:Macro Install HowTo 06.png|center]]
[[Image:Macro Install HowTo 06.png|center]]
{{Caption|align=center|Opening the execute macro dialog}}
{{Caption|align=center|Opening the Execute macro dialog}}


<!--T:97-->
<!--T:97-->
Line 277: Line 364:
[[Image:Macro Install HowTo 30.png|center]]
[[Image:Macro Install HowTo 30.png|center]]
{{Caption|align=center|Object created by the macro}}
{{Caption|align=center|Object created by the macro}}

</translate>
</div>
</div>
</div>
</div>
<translate>


== Errors in the macros ==
== Execute a macro in command line == <!--T:182-->

</translate>
<div class="toccolours mw-collapsible mw-collapsed">
<translate>

<!--T:183-->
Command line execute a macro (.FCMacro or .py)

</translate>
<div class="mw-collapsible-content">
<translate>

<!--T:184-->
on Windows

</translate>
{{Code|code=
"C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"
}}
<translate>

<!--T:185-->
on Linux

</translate>
{{Code|code=
todo
}}

</div>
</div>
<translate>

== Errors in macros == <!--T:165-->


<!--T:136-->
<!--T:136-->
Line 286: Line 410:


=== Indentation errors === <!--T:22-->
=== Indentation errors === <!--T:22-->
<div class="mw-collapsible-content">


<!--T:23-->
<!--T:23-->
The indentation in the python programming is very important and integral part of the code, a space or an inappropriate shift causes an indentation error ex :
The white space at the beginning of the lines (indentation) in the [[Python|Python]] programming language is very important, and an integral part of the code. An inappropriate space may cause the code to not run or present errors.

<!--T:166-->
This section describes some errors that may be encountered when copying and pasting, and writing macro code.

<!--T:167-->
<div class="mw-collapsible-content">


<!--T:24-->
<!--T:24-->
A typical indentation error looks like this:
<span style="color:red">
'''<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))'''
</span>


</translate>
<!--T:25-->
{{Code|code=
gives the error returned 'expected an indented block' block indentation expected to line '''21, 3,''' normal after a '''class p ():''' must be the next line an indentation at least one space.
<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))
}}
<translate>

==== Example 1 ==== <!--T:26-->

<!--T:169-->
If the code lacks any indentation, the code won't work. Class ({{incode|class}}) and function definitions ({{incode|def()}}), as well as control structures ({{incode|if}}, {{incode|while}}, {{incode|for}}) should be followed by a block of indented code.


<!--T:26-->
<!--T:170-->
This error is possible if the user doesn't copy the code correctly, and all spaces are accidentally removed.
'''1 :''' In this example, the code was stuck without any indentation and of course does not work! here definitely a programmer error when pasting the code on the page as it would have never known it to work.


<!--T:27-->
<!--T:27-->
[[Image:Macro Install HowTo 09.png|center|the code was stuck without any indentation]]
[[Image:Macro Install HowTo 09.png|center]]
{{Caption|align=center|Python code that lacks any indentation; it will cause an error when it's run}}


<!--T:28-->
<!--T:28-->
Indentation problem fixed.
'''2 :''' the code was correct indentations in the right place.


<!--T:29-->
<!--T:29-->
[[Image:Macro Install HowTo 10.png|center|the code was correct indentations in the right place]]
[[Image:Macro Install HowTo 10.png|center]]
{{Caption|align=center|Python code with the correct indentation}}


<!--T:30-->
<!--T:30-->
'''3 :''' we select the code, and we see that the selection is at the edge of the code, the macro must works so good
If the code is selected, all lines should be highlighted all the way to the left edge, indicating that the lines are aligned.


<!--T:31-->
<!--T:31-->
[[Image:Macro Install HowTo 11.png|center|the macro must works so good]]
[[Image:Macro Install HowTo 11.png|center]]
{{Caption|align=center|Python code highlighted, showing that all lines start at the left edge}}


<!--T:32-->
==== Example 2 ==== <!--T:32-->

'''4 :''' Here additional space is selected (it can happen) then you need to copy the code into a word processor to remove '''one space all lines'''
<!--T:171-->
If an additional space is introduced at the beginning of all lines, the Python interpreter will fail and complain about unnecessary indentation. In this case, all lines need the initial space removed.


<!--T:33-->
<!--T:33-->
[[Image:Macro Install HowTo 12.png|center|remove one space all lines]]
[[Image:Macro Install HowTo 12.png|center]]
{{Caption|align=center|Python code with additional space on each line}}

==== Example 3 ==== <!--T:34-->


<!--T:34-->
<!--T:172-->
'''5 :''' Here the code has been copied in a forum window with the {{KEY|Select all}} button apparently the selection is good
Here the code has been copied from a forum thread by using the {{Button|Select all}} button. Apparently the selection is good.


<!--T:35-->
<!--T:35-->
[[Image:Macro Install HowTo 14.png|center|640px|Here the code has been copied in a forum]]
[[Image:Macro Install HowTo 14.png|center]]
{{Caption|align=center|Python code copied from a forum}}


<!--T:36-->
<!--T:36-->
'''6 :''' But the selection pasted into the FreeCAD editor gives a surprise, an indent of four spaces has been added by the system ? the code is not good
However, when the selection is pasted into the macro editor, undesirable indentation seems to appear.


<!--T:37-->
<!--T:37-->
[[Image:Macro Install HowTo 15.png|center|640px|But the selection pasted into the FreeCAD editor gives a surprise]]
[[Image:Macro Install HowTo 15.png|center]]
{{Caption|align=center|Python code copied from a forum into the macro editor; unnecessary indentation is added}}


<!--T:38-->
<!--T:38-->
In this case, the initial spaces need to be removed. This can be done with a specialized text editor to quickly decrease the indentation of the lines.
'''7 :''' You must delete all the extra space that is four spaces on each line, for Windows word processing [http://notepad-plus-plus.org/ notepad-plus-plus] enables vertical selection with a combination of buttons {{KEY|Alt}} + Mouse dragging or Menu> Edit> Indent> Decrease the indentation

<!--T:173-->
In Windows, [http://notepad-plus-plus.org/ Notepad++] can perform selection with {{KEY|Alt}} + Mouse dragging, and then use {{MenuCommand|Edit → Indent → Decrease the indentation}}.


<!--T:39-->
<!--T:39-->
[[Image:Macro Install HowTo 16.png|center|640px|You must delete all the extra space]]
[[Image:Macro Install HowTo 16.png|center]]
{{Caption|align=center|Python code with the correct indentation}}

==== Example 4 ==== <!--T:40-->


<!--T:40-->
<!--T:174-->
Here the selection also selects the line numbers in the code example. If this selection is pasted into the macro editor, it won't work. All line numbers need to be removed, and the spaces adjusted so that the Python code has the proper indentation.
'''8 :''' Here the selection also take the column numbers which will also give an error


<!--T:41-->
<!--T:41-->
[[Image:Macro_Install_HowTo_29.png|center|640px|Here the selection also take the column numbers]]
[[Image:Macro_Install_HowTo_29.png|center]]
{{Caption|align=center|Selection that also selects the line numbers; if this code is pasted into the macro editor, it won't work}}


<!--T:42-->
==== Good code ==== <!--T:42-->
'''9 :''' Perfect code.


<!--T:43-->
<!--T:43-->
[[Image:Macro Install HowTo 13.png|center|Perfect code]]
[[Image:Macro Install HowTo 13.png|center]]
{{Caption|align=center|Python code with the correct indentation}}

</translate>
</div>
</div>
</div>
</div>


<div class="toccolours mw-collapsible mw-collapsed">
<div class="toccolours mw-collapsible mw-collapsed">
<translate>
===No text output from the macros=== <!--T:108-->

===No text output from macros=== <!--T:108-->

<!--T:175-->
Macros may output information to the report view to detail what the code is doing when it is running.

<!--T:176-->
If no information is displayed, make sure the report view and [[Python|Python]] console are visible, and that the output is directed tot he report view.

</translate>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<translate>
Some macros display information on the screen in general they are displayed in the report view.


<!--T:109-->
==== Printing information ==== <!--T:177-->
FreeCAD use two methods to display the information in the window view report.
FreeCAD macros have two methods to print information to the report view.


<!--T:110-->
<!--T:110-->
The FreeCAD functions
'''1 : Commands'''
</translate>
</translate>

{{Code|code=
{{Code|code=
FreeCAD.Console.PrintMessage("Hello World! \n")
App = FreeCAD
App.Console.PrintMessage ("Hello World ! \n")
FreeCAD.Console.PrintError("Hello World! \n")
App.Console.PrintError ("Hello World ! \n")
FreeCAD.Console.PrintWarning("Hello World! \n")
App.Console.PrintWarning ("Hello World ! \n")
}}
<translate>
<!--T:111-->
or
</translate>
{{Code|code=
FreeCAD.Console.PrintMessage ("Hello World ! \n")
FreeCAD.Console.PrintError ("Hello World ! \n")
FreeCAD.Console.PrintWarning ("Hello World ! \n")
}}
}}
<translate>
<translate>

<!--T:137-->
<!--T:137-->
The simple Python function
or
</translate>
</translate>

{{Code|code=
{{Code|code=
print "Hello World !"
print("Hello World!")
}}
}}
<translate>
<translate>

<!--T:112-->
==== Enabling the report view ==== <!--T:112-->
To see the information displayed in the console you should:
To see the information displayed in the console you should:


<!--T:113-->
<!--T:113-->
1. Go to the menu {{MenuCommand|View → Panels}}.
'''1 :''' Open FreeCAD


<!--T:114-->
<!--T:114-->
[[Image:Macro Install HowTo 31.png|center|640px|Open FreeCAD]]
[[Image:Macro Install HowTo 31.png|center]]

<!--T:115-->
'''2 :''' Click the '''View menu''' and '''Views'''


<!--T:116-->
<!--T:116-->
[[Image:Macro Install HowTo 32.png|center|640px|Click the View menu and Views]]
[[Image:Macro Install HowTo 32.png|center]]
{{Caption|align=center|Making the panels visible in the menu View → Panels}}


<!--T:117-->
<!--T:117-->
'''3 :''' Check '''Report View''' and '''Python Console'''
2. Enable the {{incode|Report view}} and the {{incode|Python console}}.


<!--T:118-->
<!--T:118-->
[[Image:Macro Install HowTo 33.png|center|640px|Check Report View and Python Console]]
[[Image:Macro Install HowTo 33.png|center]]
{{Caption|align=center|Enabling the report view and the Python console}}


<!--T:119-->
<!--T:119-->
'''4 :''' the windows are enabled and available commands like "'''App.Console.PrintMessage'''" is configured to the "Report View"
3. The panels are now visible, and commands like {{incode|FreeCAD.Console.PrintMessage()}} now print information that appears in the {{incode|Report view}}.


<!--T:120-->
<!--T:120-->
[[Image:Macro Install HowTo 34.png|center|640px|Hello World!]]
[[Image:Macro Install HowTo 34.png|center]]
{{Caption|align=center|FreeCAD main window with the Report view and the Python console}}


==== Enabling the <tt>print()</tt> command ==== <!--T:121-->

FreeCAD may need to be configured so the {{incode|print()}} function of [[Python|Python]] redirects its output correctly to the report view.
<!--T:121-->
'''2 : command "print" which is a Python command.'''

<!--T:122-->
It is possible that this command does not display the expected string.

<!--T:123-->
For information to be displayed in the window do this :


<!--T:124-->
<!--T:124-->
'''1 :''' Click the '''Edit menu''' and then '''Preferences'''
1. Go into the [[Preferences Editor|Preferences Editor]] with the menu {{MenuCommand|Edit Preferences}}.


<!--T:125-->
<!--T:125-->
[[Image:Macro Install HowTo 35.png|center|640px|Edit menu]]
[[Image:Macro Install HowTo 35.png|center]]
{{Caption|align=center|Going into the preferences editor}}


<!--T:126-->
<!--T:126-->
2. Go to {{MenuCommand|General}} section, and then {{MenuCommand|Output window → Python interpreter}}.
'''2 :''' In the new window, click '''General''', and select the '''Output window''' tab


<!--T:127-->
<!--T:127-->
[[Image:Macro Install HowTo 36.png|center|640px|General]]
[[Image:Macro Install HowTo 36.png|center]]
{{Caption|align=center|Output window preferences}}


<!--T:128-->
<!--T:128-->
'''3 :''' check both boxes:
3. Check both boxes:


<!--T:129-->
<!--T:129-->
[[Image:Case_a_cocher_O.png|16px]] Redirect internal Python output to Report view
* [[Image:Case_a_cocher_O.png|16px]] Redirect internal Python output to report view


<!--T:130-->
<!--T:130-->
[[Image:Case_a_cocher_O.png|16px]] Redirect internal Python errors to Report view
* [[Image:Case_a_cocher_O.png|16px]] Redirect internal Python errors to report view


<!--T:131-->
<!--T:131-->
and click the {{KEY|OK}} button
and then press the {{Button|OK}} button.


<!--T:132-->
<!--T:132-->
[[Image:Macro Install HowTo 37.png|center|640px|Redirect internal]]
[[Image:Macro Install HowTo 37.png|center]]
{{Caption|align=center|Redirecting the Python output to the report view}}

<!--T:133-->
'''4 :''' the setup is complete you should see all.


<!--T:134-->
<!--T:134-->
[[Image:Macro Install HowTo 38.png|center|640px|the setup is complete]]
[[Image:Macro Install HowTo 38.png|center]]
{{Caption|align=center|Python commands printing information to the report view}}

</translate>
<!--T:135-->
</div>
</div>
</div>
</div>


{{Powerdocnavi{{#translation:}}}}

[[Category:Developer Documentation{{#translation:}}]]
==Links== <!--T:105-->
[[Category:Python Code{{#translation:}}]]

{{clear}}
<!--T:106-->
Macro [https://github.com/FreeCAD/FreeCAD-addons addons_installer.FCMacro] for easy install the macro

<!--T:138-->
Other easy macro installer [https://github.com/microelly2/freecad-pluginloader freecad-pluginloader]

<!--T:139-->
The [[Macros_recipes|Macros recipes]] page

</translate>

Revision as of 13:42, 15 June 2020

Tutorial
Topic
Programming
Level
Medium programmer
Time to complete
15 minutes
Authors
Mario52
FreeCAD version
All
Example files
None
See also
None

Description

Since v0.17 it is easy to add macros by using the Addon Manager. A regular user doesn't need to do more than use this tool. Keep reading for more information regarding installation of macros.

Macros are sequences of commands which are used to perform a complex drawing operation. Macros are Python scripts, which means they are text files that can be written and edited with a text editor.

While Python scripts normally have the .py extension, FreeCAD macros should have the .FCMacro extension. A collection of macros written by experienced users is found in the macros recipes page.

See Introduction to Python to learn about the Python programming language, and then Python scripting tutorial and FreeCAD Scripting Basics to learn about writing macros.

Here is a video on installing FreeCAD macros in Ubuntu.

The Macro menu and toolbar

Toolbar

Menu

Besides the tools in the toolbar, the following functions are also available in the Macro menu.

Macros directory

Macros are created in a specific folder under the user's FreeCAD directory. This directory can be configured in the Execute macro dialog, or in the Preferences Editor, through the menu Edit → Preferences → General → Macro → Macro recording settings.

Downloaded macros should also be placed in this directory.

Default directory

Macros can be simply copied into

$ROOT_DIR/

where $ROOT_DIR is a top level directory searched by FreeCAD on startup.

The $ROOT_DIR could be a system wide directory, in which case the macro is installed for all users.

  • On Linux it is usually /usr/share/freecad/
  • On Windows it is usually C:\Program Files\FreeCAD\
  • On Mac OSX it is usually /Applications/FreeCAD/

The $ROOT_DIR could be a particular user's directory.

  • On Linux it is usually /home/username/.FreeCAD/
  • On Windows it is usually C:\Users\username\Application Data\FreeCAD\
  • On Mac OSX it is usually /Users/username/Library/Preferences/FreeCAD/

Configuring the user directory

1. Open the menu Macro → Macros... to open the Execute macro dialog.

Opening the Execute macro dialog

2. Set the appropriate User macros location.

  • Linux: usually /home/username/.FreeCAD/
  • Windows: usually C:\Users\username\AppData\Roaming\FreeCAD\
  • MacOS: usually /Users/username/Library/Preferences/FreeCAD/

Setting of the macros directory

3. Navigate to that directory in your computer.

  • Linux: paste the address into your file manager, "Nautilus" or other. You may have to press Ctrl+H to make the hidden directory .FreeCAD/ visible.
  • Windows: paste the address into your "File explorer" and confirm.
  • MacOS: locate the folder in the "Finder" or paste the address into a "File explorer"; remember the file:/// prefix in the "File explorer" for a file on disk.

Accessing the macros directory in the operating system

4. Add macro files to this directory.

  • Linux: leave the file manager open, and bookmark the location for faster access.
  • Windows: leave open the file explorer.
  • MacOS: either leave a "Finder" window open, or bookmark the location in your "File explorer", or set up an "Alias" to point to it, or drag the folder into the "SideBar" of the "Finder" so it is there to use from other programs such as text editors.

Macros directory

Installing macros

Automatic method

Starting with FreeCAD 0.17, use the Addon Manager in Tools → Addon manager to install a macro that has been included in the FreeCAD-macros repository.

In past versions of FreeCAD you could use two automated ways to install macros and other addons:

  • addons_installer.FCMacro: itself a macro, this was the precursor to the Addon Manager, and is hosted in the FreeCAD-addons repository. You don't need to use this tool in new installations of FreeCAD.
  • freecad-pluginloader: also a macro, it could be used to install new components to FreeCAD. It is no longer developed.

The recommended way to install addons, that is, external workbenches and macros, is the Addon Manager. However, you can still add macros to your system with the manual methods described in the following sections; this is useful if you are developing and testing your own code.

Manual method 1. Copy the code to the macro editor

For macros that are relatively small, 300 lines or less, the code can be copied and pasted directly into the FreeCAD macro editor.

We will use Macro Apothem Based Prism GUI as an example.

1. Go to the macro wiki page, which should be listed in Macros recipes.

If there is a custom icon download it; click on it with the right mouse button and select Save image as...; place the icon in the macros directory. This icon can be used as a shortcut for the macro in a custom toolbar. The default icon is .

Downloading the icon from the macro page

2. In the macro page, select the code inside the Script or Macro sections, and copy it.

3. In FreeCAD, open the menu Macro → Macros... to open the Execute macro dialog.

Opening the Execute macro dialog

4. Click Create.

Creating a new macro

5. Enter the macro name, here Macro_Apothem_Based_Prism_GUI, and press OK.

Entering the macro name

6. The macro editor opens, showing the full path of the new macro.

The macro editor

7. Paste the code in the editor window, and then click the cross on the tab to close the window.

Closing the macro editor

8. A window appears asking for confirmation to save the code; click on Yes. You can also use Ctrl+S to save the file.

Restart FreeCAD to correctly register the new macro.

Asking for confirmation to save the code

9. Open the menu again, Macro → Macros..., select the new macro and press Execute.

Selecting the macro to run it

10. The macro now runs. Fill in the fields with your values and click the OK button.

The macro in action; fill in the information and press OK when ready

11. This macro should return an error if no document is active; other macros open a new document if none exists.

Create a new document with File → New, and then repeat the previous steps to execute the macro.

The macro returning an error if no document is active

12. Once an active document is available, the macro runs and creates an object.

Object created by the macro

13. You can open the macro in the editor again to run it or modify it. Go to Macro → Macros..., select the macro and press Edit.

Opening the macro in the editor

14. The macro can now be run with Macro → Execute macro, or by clicking on the Std DlgMacroExecuteDirect button in the toolbar.

Running the macro that is loaded in the editor

Manual method 2. Add a macro file from a compressed .zip file

Some macros are too big that it's inconvenient to copy and paste them into the macro editor, or they cannot be hosted in the wiki. In this case, the code may be hosted somewhere else, in a Github repository, or in the FreeCAD forum. The code may also be compressed into a .zip file, tarball .tar.xz, or other type of archive if it contains several files. If the code is distributed in this way, the archive should be extracted and the files placed in the macros directory.

We will use Macro screw maker as an example.

1. Download the compressed code from the forum, Screw Maker.

You need to use a decompressor to get the internal files.

  • For Windows you can use an application like 7-zip or L-Zarc or quickzip.
  • For Linux you can use a command from the terminal
unzip your_file.zip -d your_directory

2. Download the compressed archive with the macro code to a local folder.

Downloading the compressed archive to a local directory

3. Decompress the file in the folder.

Decompressing the file in the folder

4. The decompressor creates a new directory with the unpacked files.

New directory created after unpacking the archive

5. Go inside the new directory, and copy or cut the macro file.

Entering the newly created directory with the decompressed macro file

6. Go to the macro directory and paste the file there.

Placing the macro file in the macro directory

7. In FreeCAD, open the menu Macro → Macros... to open the Execute macro dialog.

Opening the Execute macro dialog

8. Select the new macro and press Execute.

Selecting the macro to run it

9. The macro now runs. Select the desired options, and click the Create button.

The macro in action; select the desired options, and press Create when ready

Object created by the macro

Execute a macro in command line

Command line execute a macro (.FCMacro or .py)

on Windows

"C:\Program Files\FreeCAD\bin\FreeCAD.exe" "C:\Users\userName\AppData\Roaming\FreeCAD\Mod\WorkFeature\start_WF.FCMacro"

on Linux

todo

Errors in macros

Indentation errors

The white space at the beginning of the lines (indentation) in the Python programming language is very important, and an integral part of the code. An inappropriate space may cause the code to not run or present errors.

This section describes some errors that may be encountered when copying and pasting, and writing macro code.

A typical indentation error looks like this:

<unknown exception traceback><type 'exceptions.IndentationError'>: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))

Example 1

If the code lacks any indentation, the code won't work. Class (class) and function definitions (def()), as well as control structures (if, while, for) should be followed by a block of indented code.

This error is possible if the user doesn't copy the code correctly, and all spaces are accidentally removed.

Python code that lacks any indentation; it will cause an error when it's run

Indentation problem fixed.

Python code with the correct indentation

If the code is selected, all lines should be highlighted all the way to the left edge, indicating that the lines are aligned.

Python code highlighted, showing that all lines start at the left edge

Example 2

If an additional space is introduced at the beginning of all lines, the Python interpreter will fail and complain about unnecessary indentation. In this case, all lines need the initial space removed.

Python code with additional space on each line

Example 3

Here the code has been copied from a forum thread by using the Select all button. Apparently the selection is good.

Python code copied from a forum

However, when the selection is pasted into the macro editor, undesirable indentation seems to appear.

Python code copied from a forum into the macro editor; unnecessary indentation is added

In this case, the initial spaces need to be removed. This can be done with a specialized text editor to quickly decrease the indentation of the lines.

In Windows, Notepad++ can perform selection with Alt + Mouse dragging, and then use Edit → Indent → Decrease the indentation.

Python code with the correct indentation

Example 4

Here the selection also selects the line numbers in the code example. If this selection is pasted into the macro editor, it won't work. All line numbers need to be removed, and the spaces adjusted so that the Python code has the proper indentation.

Selection that also selects the line numbers; if this code is pasted into the macro editor, it won't work

Good code

Python code with the correct indentation

No text output from macros

Macros may output information to the report view to detail what the code is doing when it is running.

If no information is displayed, make sure the report view and Python console are visible, and that the output is directed tot he report view.

Printing information

FreeCAD macros have two methods to print information to the report view.

The FreeCAD functions

FreeCAD.Console.PrintMessage("Hello World! \n")
FreeCAD.Console.PrintError("Hello World! \n")
FreeCAD.Console.PrintWarning("Hello World! \n")

The simple Python function

print("Hello World!")

Enabling the report view

To see the information displayed in the console you should:

1. Go to the menu View → Panels.

Making the panels visible in the menu View → Panels

2. Enable the Report view and the Python console.

Enabling the report view and the Python console

3. The panels are now visible, and commands like FreeCAD.Console.PrintMessage() now print information that appears in the Report view.

FreeCAD main window with the Report view and the Python console

Enabling the print() command

FreeCAD may need to be configured so the print() function of Python redirects its output correctly to the report view.

1. Go into the Preferences Editor with the menu Edit → Preferences.

Going into the preferences editor

2. Go to General section, and then Output window → Python interpreter.

Output window preferences

3. Check both boxes:

  • Redirect internal Python output to report view
  • Redirect internal Python errors to report view

and then press the OK button.

Redirecting the Python output to the report view

Python commands printing information to the report view