https://github.com/killerboss2019/touchportal-octoprint
TouchPortal Plugin that controls 3D printer
https://github.com/killerboss2019/touchportal-octoprint
Last synced: 3 months ago
JSON representation
TouchPortal Plugin that controls 3D printer
- Host: GitHub
- URL: https://github.com/killerboss2019/touchportal-octoprint
- Owner: KillerBOSS2019
- License: gpl-3.0
- Created: 2022-09-17T03:53:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-04T00:46:01.000Z (over 2 years ago)
- Last Synced: 2025-01-25T22:22:24.036Z (5 months ago)
- Language: JavaScript
- Size: 74.2 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TouchPortal-OctoPrint
- [TouchPortal OctoPrint](#TouchPortal-OctoPrint)
- [Description](#description)
- [Settings Overview](#Settings-Overview)
- [Features](#Features)
- [Actions](#actions)
- [TouchPortal OctoPrint](#com.github.killerboss2019.TPPlugins.OctoPrint.mainactions)
- [States](#states)
- [TouchPortal OctoPrint](#com.github.killerboss2019.TPPlugins.OctoPrint.mainstates)
- [Bugs and Support](#bugs-and-suggestion)
- [License](#license)
# Description
This documentation generated for TouchPortal OctoPrint V1000 with [Python TouchPortal SDK](https://github.com/KillerBOSS2019/TouchPortal-API).
## Settings Overview
| Read-only | Type | Default Value |
| --- | --- | --- |
| False | text | |
List of octoprint url to octoprint separated by comma.
| Read-only | Type | Default Value |
| --- | --- | --- |
| False | text | |
List of API Keys in same order as Hosts separated by comma.
# Features
## Actions
Category: TouchPortal OctoPrint (Click to expand)
Action NameDescriptionFormatData
choices/default (in bold)On
Hold
Print Job controlAbility to select a printer and Start, Cancel, Restart, Pause, Resume and TogglePause prints.Printer[1][2] print job
- Type: choice
<empty>
- Type: choice
Default: Start Possible choices: ['Start', 'Cancel', 'Restart', 'Pause', 'Resume', 'TogglePause']
No
Home axesHome selected printer X, Y, Z or All axes[1] Home[2]axes
- Type: choice
<empty>
- Type: choice
Default: All Possible choices: ['All', 'X', 'Y', 'Z']
No
Moving axesMoving selected printer axes by X mmMove[1][2]by[3]mm
- Type: choice
<empty>
- Type: choice
Default: X Possible choices: ['X', 'Y', 'Z']
- Type: text
Default: 1
No
Set target temperatureChange selected printer bed or nozzle temperature.[1]Set target temperature to[2]°C
- Type: choice
<empty>
- Type: text
<empty>
No
## States
Category: TouchPortal OctoPrint (Click to expand)
| Id | Description | DefaultValue | parentGroup |
| --- | --- | --- | --- |
| .state.dynamic.printerState | Printer state | Offline | |
| .state.dynamic.completion | Percentage of print completion | | |
| .state.dynamic.filepos | Bytes printed from start of print | | |
| .state.dynamic.printTime | Print time | 0 | |
| .state.dynamic.printTimeLeft | Print time left | 0 | |
| .state.dynamic.printTimeLeftOrigin | Print time left origin | 0 | |
| .state.dynamic.bedTargetTemp | Print bed target temperature | 0 | |
| .state.dynamic.bedoffsetTemp | Print bed offset temperature | 0 | |
| .state.dynamic.bedActualTemp | Print bed actual temperature | 0 | |
| .state.dynamic.tool0TargetTemp | Print nozzle target temperature | 0 | |
| .state.dynamic.tool0offsetTemp | Print nozzle offset temperature | 0 | |
| .state.dynamic.tool0ActualTemp | Print nozzle actual temperature | 0 | |
| .state.dynamic.chamberTargetTemp | Print chamber target temperature | 0 | |
| .state.dynamic.chamberoffsetTemp | Print chamber offset temperature | 0 | |
| .state.dynamic.chamberActualTemp | Print chamber actual temperature | 0 | |
| .state.dynamic.fileName | Printing file name | | |
| .state.dynamic.fileSize | Printing file sizes in bytes | 0 | |
| .state.dynamic.fileDate | Printing file uploaded date | 0/0/00 | |
| .state.dynamic.estimatedPrintTime | Estimated print time | 0:00 | |
| .state.dynamic.adveragePrintTime | Adverage print time | 0:00 | |
| .state.dynamic.filamentLength | Filament length required to print in mm | 0:00 | |
| .state.dynamic.printerName | Printer name | | |
| .state.dynamic.cameraView | Printer camera view | | |
# Bugs and Suggestion
Open an issue on github or join offical [TouchPortal Discord](https://discord.gg/MgxQb8r) for support.
# License
This plugin is licensed under the [GPL 3.0 License] - see the [LICENSE](LICENSE) file for more information.