Document different gcode data block encoding format in specification
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the existing G-Code data block specification and the source code that implements the MeatPack and modified MeatPack encodings. Document the meaning of encoding values 0, 1, and 2, including whether value 0 is plain text G-code, so readers can interoperate with the format.
Written by the indexing model from the issue text.
Description
Right now the G-Code data block just lists the encoding header format and lists the possible values for the header field:
0 = No encoding
1 = MeatPack algorithm
2 = MeatPack algorithm modified to keep comment lines
without defining what MeatPack or the modified MeatPack algorithms are. It would be good if the definition of those encoding types were documented (also assuming no encoding just means the text gcode). While you can look at the source code, documenting the actual specifics of the encoding formats will make the specification more useful for people trying to interoperate with the format.
- Dominant language
- G-code
- Stars
- 73
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from prusa3d/libbgcode
-
Extending bgcodeOpen
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Broken on big-endian architecturesPossibly taken @onitake claimed this 334 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
PyPI releaseMay be free again @tomasbedrich claimed this 1035 days ago, and no pull request is open. Open
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
All issues in prusa3d/libbgcode
Similar issues
-
bug documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
daniel-ospina/tortoise#13607 ·
Maintainers usually reply within 1 day
-
documentation priority: medium
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 66/100
Robin-IA/Congressional-Letters-Dev#1347 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
hemilabs/ui-monorepo#2741 ·
Maintainers usually reply within 1 day