https://github.com/infeeeee/dynfreecad
Dynamo nodes for FreeCAD
https://github.com/infeeeee/dynfreecad
dynamo dynamobim freecad
Last synced: about 1 year ago
JSON representation
Dynamo nodes for FreeCAD
- Host: GitHub
- URL: https://github.com/infeeeee/dynfreecad
- Owner: infeeeee
- License: mit
- Created: 2020-08-23T16:08:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-14T23:55:28.000Z (over 5 years ago)
- Last Synced: 2025-04-11T20:06:46.130Z (about 1 year ago)
- Topics: dynamo, dynamobim, freecad
- Language: Python
- Homepage:
- Size: 1.92 MB
- Stars: 55
- Watchers: 10
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DynFreeCAD
Dynamo nodes for the FreeCAD API
**Early, work in progress**, PRs are welcomed!
## Requirements
- Dynamo 2.8+. Download from [dynamobuilds.com](https://dynamobuilds.com/)
- Select one of DynamoCoreRuntimes. Download, extract, you will find DynamoSandbox.exe inside
- FreeCAD built with python 3.8:
- **Recommended:** Daily 0.19 **Conda** build: [Release 0.19_pre · FreeCAD/FreeCAD · GitHub](https://github.com/FreeCAD/FreeCAD/releases/tag/0.19_pre) *(Python 3.8.6)*
- If daily builds are down: [Release FreeCAD Win Conda PY3.8 · sgrogan/FreeCAD · GitHub](https://github.com/sgrogan/FreeCAD/releases/tag/PY3.8) The 'site_packages1' version works better. *(Python 3.8.1)*
- You can build yourself a different verision, follow FreeCAD's doumentation
## Installation
- Clone this repo
- Open DynamoSandbox.exe
- Settings ➡ Manage Node and Package Paths... ➡ Add a new folder with ➕, select the `Dyf` subfolder from where you cloned ➡ Accept changes
- (Dynamo package manager soon!)
### FreeCAD API in Dynamo
Dynamo 2.7 added support for CPython 3.7, so FreeCAD can be called inside dynamo. Everything should work inside Python nodes, I want to add more common FreeCAD commands as nodes, so graphical programming can get a boost in FreeCAD.
Unfortunately due to a bug in Dynamo 2.7, these nodes are only usable in 2.8 with Python 3.8.
### Compatibility matrix
Table updated: 2020-11-13
| Dynamo | Stable Dynamo | cPython in Dynamo | FreeCAD API | DynFreeCAD | Revit |
| ------ |:-------------:|:-----------------:|:-----------:|:----------:|:------:|
| 2.6 | ✔ | ❌ | ❌ | ❌ | 2021.1 |
| 2.7 | ✔ | 3.7.3 | ✔ | ❌ | ❌ |
| 2.8 | ✔ | 3.8.3 | ✔ | ✔ | ❌ |
| 2.9 | ✔ | 3.8.3 | ✔ | ✔ | ❌ |
| 2.10 | ❌ | 3.8.3 | ✔ | ✔ | ❌ |
## Usage and tips
⚠️As DynFreeCAD is under developement, it's possible that some screenshots and documentation are outdated⚠️
Detailed documentation is in the [wiki](https://github.com/infeeeee/DynFreeCAD/wiki).
See `Examples` folder for some Dynamo documents.
### Load the FreeCAD API
[There is a bug in Dynamo](https://forum.dynamobim.com/t/how-to-use-import-from-custom-path-in-multiple-cpython-blocks/55071), so you cannot load FreeCAD libs on latter nodes, unless they were loaded in a first python node. So before using DynFreeCAD, you have to load libraries:
- Open `ApiLoader.dyn` from `Examples\ApiLoaders` folder.
- If you want to use Arch and Draft nodes open `ApiLoaderArch.dyn` instead. They require other dependencies, see [Arch and Draft Setup in the wiki](https://github.com/infeeeee/DynFreeCAD/wiki/Arch-and-Draft-Setup)
- Click `Run`
- If no errors given, just close this graph. Do not close Dynamo, only close the graph!
- You can now start working with the FreeCAD api, create new graphs, or open other examples.
You have to do this every time you want to use the FreeCAD api in Dynamo. I hope sometimes this will be fixed, or at least I find a better workaround.
### Using with the FreeCAD Gui visible
*Soon...*
Currently it's not possible. Run the graph, save the file, than open it in FreeCAD.
### Open or create a new document
Always start with these nodes. Add the path to the `bin` folder of FreeCAD.
### Manage documents
Use the ouput of the OpenDocument or CreateDocument nodes output if you just work on one document. The bottom nodes just showing how these nodes are connectable.
### Manage properties
### Python script
You can use the FreeCAD API in a Python Script this way:
See UseTheApi.dyn in Examples folder.
## Troubleshooting
If you have some problems, open an issue!
You can also ask questions on the related project's forums:
- [Dynamo Forum](https://forum.dynamobim.com/)
- [FreeCAD Forum](https://forum.freecadweb.org/)
- [OSArch Community](https://community.osarch.org/)
## Alternativ graphical programing interfaces for FreeCAD
- [GitHub - microelly2/NodeEditor: Node editor for FreeCAD with PyFLow](https://github.com/microelly2/NodeEditor)
- [GitHub - nortikin/sverchok: Sverchok](https://github.com/nortikin/sverchok) Blender addin with FreeCAD support
## License
MIT