https://github.com/cp2004/octoprint-gcodemacros
Configure custom gcode macros you can use anywhere!
https://github.com/cp2004/octoprint-gcodemacros
gcode macro octoprint
Last synced: 10 months ago
JSON representation
Configure custom gcode macros you can use anywhere!
- Host: GitHub
- URL: https://github.com/cp2004/octoprint-gcodemacros
- Owner: cp2004
- License: agpl-3.0
- Created: 2021-08-09T16:22:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-27T13:00:32.000Z (about 2 years ago)
- Last Synced: 2025-03-19T07:33:08.899Z (10 months ago)
- Topics: gcode, macro, octoprint
- Language: Python
- Homepage: https://plugins.octoprint.org/plugins/gcode_macro
- Size: 204 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# OctoPrint Gcode Macros Plugin
Create custom commands you can add anywhere: in your gcode file, OctoPrint's terminal, gcode scripts, or other plugins
to run a configured script.
Use macros for preheating your printer, levelling the bed, changing filament... Possibilities are (nearly) endless!
## Installation
Install from the [plugin repository](https://plugins.octoprint.org/plugins/gcode_macro) or manually using this URL:
https://github.com/cp2004/OctoPrint-GCodeMacros/releases/latest/download/release.zip
**Warning:** This plugin only supports Python 3 installs. To find out more about upgrading your OctoPrint install to
Python 3, you can take a look
[at this post](https://community.octoprint.org/t/upgrading-your-octoprint-install-to-python-3/35158?u=charlie_powell)
**Warning 2:** Don't try installing this plugin from the source code on GitHub, there may be some breakage as the CSS is
only built on releases. If you are interested in contributing, please see [the Contribution Guidelines](CONTRIBUTING.md)
## Configuration
Once installed, you can start defining your macros.
### Macro Commands
All commands are prefixed with an `@`, so they don't interfere with standard gcode commands. However, this means that
**some commands are reserved**. OctoPrint uses
[these specific commands](https://docs.octoprint.org/en/master/features/atcommands.html) for pausing & resuming prints,
but also other plugins can use custom @ commands. For example, OctoLapse uses `@OCTOLAPSE TAKE-SNAPSHOT` or the WLED
plugin uses `@WLED ON` or `@WLED OFF` to control some LEDs.
The commands are **case-sensitive**, and you can have spaces, numbers and punctuation in them!
_These commands will not work while printing from the printer's SD card_
### Macro Content
Macros can contain anything, even other macros!
You can nest macros up to 5 levels deep. For example, you may have a macro `@preheat`, and one for `@bedlevel`. Maybe
you want to preheat your bed before running the levelling commands!
In addition to nesting commands, you can also use the Jinja2 template syntax to implement some logic in scripts.
For example, this one will make the printer move to a random position in X and Y:
`@random`
```
G1 X{{ range(200) | random}} Y{{ range(200) | random }} F3000.0;
```
Or maybe you fancy having a bit of fun, making your printer into a random number generator:
`@random-number`
```
M117 Random number... {{ range(100) | random }}!
```
Should you want to write _really, really_ long macros, the plugin supports including them as templates using Jinja.
See the [template syntax documentation](./docs/template_syntax.md) for more information.
**Check out the full [Jinja2 Template Designer Documentation](https://jinja.palletsprojects.com/en/2.11.x/templates/#random)
for more information about the templates**
## Sponsors
- [@KenLucke](https://github.com/KenLucke)
- [@CmdrCody51](https://github.com/CmdrCody51)
As well as 2 others supporting me regularly through [GitHub Sponsors](https://github.com/sponsors/cp2004)!
## Supporting my efforts
I created this project in my spare time, and do my best to support the community with issues and help using it. If you have found this useful or enjoyed using it then please consider [supporting it's development! ❤️](https://github.com/sponsors/cp2004). You can sponsor monthly or one time, for any amount you choose.
## Check out my other plugins
You can see all of my published OctoPrint plugins [on the OctoPrint Plugin Repository!](https://plugins.octoprint.org/by_author/#charlie-powell) Or, if you're feeling nosy and want to see what else I'm working on, check out my [GitHub profile](https://github.com/cp2004).
## 👷