Skip to content
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

added tabinfo plugin #1294

Merged
merged 6 commits into from
May 16, 2024
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions _plugins/tabinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---

Check warning on line 1 in _plugins/tabinfo.md

View workflow job for this annotation

GitHub Actions / Validate changed plugin files

image 'https://github.com/dakhnod/OctoPrint-TabInfo/assets/26143255/0cfb75bb-41e6-4b7e-94f7-dc35010727c5' is hosted externally, should be moved to /assets/img/plugins/tabinfo @ data['screenshots'][0]['url']

Check warning on line 1 in _plugins/tabinfo.md

View workflow job for this annotation

GitHub Actions / Validate changed plugin files

image 'https://github.com/dakhnod/OctoPrint-TabInfo/assets/26143255/0cfb75bb-41e6-4b7e-94f7-dc35010727c5' is hosted externally, should be moved to /assets/img/plugins/tabinfo @ data['featuredimage']
layout: plugin

id: tabinfo
title: TabInfo
description: display print information as browser tab title
authors:
- Daniel Dakhno
license: your plugin's license

# today's date in format YYYY-MM-DD, e.g.
date: 2024-05-16

homepage: https://github.com/dakhnod/OctoPrint-TabInfo
source: https://github.com/dakhnod/OctoPrint-TabInfo
archive: https://github.com/dakhnod/OctoPrint-TabInfo/archive/master.zip

# Set this if your plugin heavily interacts with any kind of cloud services.
#privacypolicy: your plugin's privacy policy URL

# Set this to true if your plugin uses the dependency_links setup parameter to include
# library versions not yet published on pypi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
#follow_dependency_links: false

tags:
- information
- progress
- tab
- browser
- overview

screenshots:
- url: https://github.com/dakhnod/OctoPrint-TabInfo/assets/26143255/0cfb75bb-41e6-4b7e-94f7-dc35010727c5
dakhnod marked this conversation as resolved.
Show resolved Hide resolved
alt: plugin preview in browser
caption: plugin preview in browser

featuredimage: https://github.com/dakhnod/OctoPrint-TabInfo/assets/26143255/0cfb75bb-41e6-4b7e-94f7-dc35010727c5
dakhnod marked this conversation as resolved.
Show resolved Hide resolved

compatibility:
python: ">=2.7,>=3" # Python 2 & 3

---

# OctoPrint-TabInfo

TabInfo shows information about your print in the browser tab.
The information displayed can be changed using format strings.


## Configuration

The plugin can be configured in OctoPrint's settings using format strings.
Currently, two format strings can be defined, one for the Printing state and one for Idle state.
The format string can be any text. everything inside curly brackets is replaced by it's value in a data object.
That data object can be printed to the browsers developer console by ticking the checkbox.
In Chrome, the developer console can be accessed by pressing F12.

Two special cases are relevat:
- when the path points to a zero-argument function, the function is called and the result is used
- when the path points to a float, the value is floored. For instance, 1.123 would become 1
Loading