-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cura 5555 ufp specification #12
Open
alekseisasin
wants to merge
6
commits into
master/s-line
Choose a base branch
from
CURA-5555_ufp_specification
base: master/s-line
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
fcbe403
Added simple description of ufp file extension
alekseisasin 058bd9d
Update ufp.md
alekseisasin 539c76b
Merge branch 'master' into CURA-5555_ufp_specification
f01e8aa
Update ufp.md
alekseisasin 6403723
Update ufp.md
alekseisasin a01319b
Update UFP specification so that it contains more of the rationale be…
nallath File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Ultimaker Format Package (UFP) | ||
|
||
The Ultimaker Format package is an OPC (Open Package Convention) based file format. It's designed to allow for various other payloads, apart from the "default" toolpath that is provided by a regular g-code file. The initial implementation / release of this standard allows for thumbnails and toolpath metadata to be added. Future versions might include more payloads such as material files. UFP files should always describe a single "print job". | ||
|
||
## Forwards compatible with 3MF | ||
One of the main features of UFP is that it's fully forwards compatible with 3MF. | ||
|
||
The main reason to not directly extend 3MF with the functionality Ultimaker needs on their printer is due to storage constraints. UFP is intended to be lighter / smaller than 3MF, since 3MF forces the 3D model data of the print job to be a part of the file. | ||
|
||
However, we do expect that this will no longer be an issue with future generations of printers. As such, we have made UFP forwards compatible with 3MF. This makes it possible for older machines to accept 3MF files that have an UFP extension, without needing to update them. | ||
|
||
## Structure | ||
### Required files | ||
* `.rels` The root relations file, which describes the relations of the package as a whole. | ||
* `Metadata/thumbnail.png` An png tumbnail (300x300px) of the 3D model that is to be printed | ||
* `3D/model.gcode` The actual toolpath that needs to be printed. | ||
* `[Content_Types].xml` Definitions of all the MIME types stored in the package. | ||
|
||
### Optional files | ||
* `Materials/*.xml.fdm_material` 0-n material files, which describe the material that the toolpath was sliced with. If this is a material that is unknown to the 3D printer that recieves this print-job it could add this material to it's database for future reference / automatic NFC detection. | ||
* `Materials/*.xml.fdm_material.sig` 0-n signature files. Ultimaker 3D printers, from the UM3 and upwards, support the signing of material files. Since unknown materials could be added to the internal database of the machine, it might need to be signed if this is a protected material profile. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall the documentation is very marginal. I'm missing things like: