|
| 1 | +--- |
| 2 | +layout: plugin |
| 3 | + |
| 4 | +id: tabinfo |
| 5 | +title: TabInfo |
| 6 | +description: display print information as browser tab title |
| 7 | +authors: |
| 8 | +- Daniel Dakhno |
| 9 | +license: your plugin's license |
| 10 | + |
| 11 | +# today's date in format YYYY-MM-DD, e.g. |
| 12 | +date: 2024-05-16 |
| 13 | + |
| 14 | +homepage: https://github.com/dakhnod/OctoPrint-TabInfo |
| 15 | +source: https://github.com/dakhnod/OctoPrint-TabInfo |
| 16 | +archive: https://github.com/dakhnod/OctoPrint-TabInfo/archive/master.zip |
| 17 | + |
| 18 | +# Set this if your plugin heavily interacts with any kind of cloud services. |
| 19 | +#privacypolicy: your plugin's privacy policy URL |
| 20 | + |
| 21 | +# Set this to true if your plugin uses the dependency_links setup parameter to include |
| 22 | +# library versions not yet published on pypi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION! |
| 23 | +#follow_dependency_links: false |
| 24 | + |
| 25 | +tags: |
| 26 | +- information |
| 27 | +- progress |
| 28 | +- tab |
| 29 | +- browser |
| 30 | +- overview |
| 31 | + |
| 32 | +screenshots: |
| 33 | +- url: /assets/img/plugins/tabinfo/banner.png |
| 34 | + alt: plugin preview in browser |
| 35 | + caption: plugin preview in browser |
| 36 | + |
| 37 | +featuredimage: /assets/img/plugins/tabinfo/banner.png |
| 38 | + |
| 39 | +compatibility: |
| 40 | + python: ">=2.7,>=3" # Python 2 & 3 |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +# OctoPrint-TabInfo |
| 45 | + |
| 46 | +TabInfo shows information about your print in the browser tab. |
| 47 | +The information displayed can be changed using format strings. |
| 48 | + |
| 49 | + |
| 50 | +## Configuration |
| 51 | + |
| 52 | +The plugin can be configured in OctoPrint's settings using format strings. |
| 53 | +Currently, two format strings can be defined, one for the Printing state and one for Idle state. |
| 54 | +The format string can be any text. everything inside curly brackets is replaced by it's value in a data object. |
| 55 | +That data object can be printed to the browsers developer console by ticking the checkbox. |
| 56 | +In Chrome, the developer console can be accessed by pressing F12. |
| 57 | + |
| 58 | +Two special cases are relevat: |
| 59 | +- when the path points to a zero-argument function, the function is called and the result is used |
| 60 | +- when the path points to a float, the value is floored. For instance, 1.123 would become 1 |
0 commit comments