Tested with OctoPrint 1.10.3
Features
Information
- Get version information
- Get printer information (when
operational) - Get current print job information (when
printing) - Get file list information (when not
printing)
Tools
- Set tool temperature (when
operational) - Set bed temperature (when
operational) - Extrude / Retract (when
operational)
Commands
- Printer: Connect, disconnect and home
- Job: Start, Pause, Resume, Cancel, Restart
- SD-Card: Init, Refresh, Release
- Custom Printer Commands
- System Commands
- Jog X, Y and Z axis
- Select a file or print it
Supported Plugins
- Display Layer Progress - tested with version 1.28.0 (requires adapter version 2.1.0 or later)
- Slicer Thumbnails - tested with version 1.0.0 (requires adapter version 2.2.0 or later)
Important!
DO NOT restart your OctoPrint instance (or any other instance) with code like this:
var obj = getObject('system.adapter.octoprint.0');
obj.common.enabled = false;
setObject('system.adapter.octoprint.0', obj);
Since the API key is a protected attribute since version 1.1.0, this will remove the configured API key. The reason is, that getObject doesn't return protected information (so the api key is not included in the returned object). When you save the object, you will save an object without the key.
Please use state system.adapter.octoprint.0.alive to stop/start the instance.
Changelog
7.0.0 (2026-05-05)
- (copilot) Adapter requires node.js >= 22 now
- (@klein0r) Updated dependencies
- (@klein0r) admin 7.6.20 and js-controller 6.0.11 (or later) are required
6.0.1 (2025-08-25)
- (@klein0r) Updated dependencies
- (@klein0r) admin 7.6.17 and js-controller 6.0.11 (or later) are required
6.0.0 (2025-01-07)
NodeJS >= 20.x and js-controller >= 6 is required
Tested with OctoPrint 1.10.3
5.1.0 (2023-10-25)
NodeJS 16.x is required
Tested with OctoPrint 1.9.3
- (klein0r) Added admin icons
5.0.1 (2023-05-30)
- (klein0r) Allow self-signed certificates
License
The MIT License (MIT)
Copyright (c) 2026 Matthias Kleine info@haus-automatisierung.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.