Skip to content

Commit

Permalink
Update manifest
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
cpeuschel committed Dec 27, 2020
1 parent 3bdd204 commit 4c854a5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# Stream Deck Plugin for OctoPrint
# StreamDeck Plugin for OctoPrint

This plugin shows your printer completion state in percent on your StreamDeck with OctoPrint.
This plugin shows your 3D-Printer completion state in percent on your StreamDeck ([OctoPrint](https://github.com/OctoPrint/OctoPrint) required)

## Installation
1. Download the latest release. Double click on the file `com.cpeuschel.octodeck.streamDeckPlugin` to install.
2. You should see in the StreamDeck Application under `Custom` the octodeck plugin.

## Configuration
1. Choose your favourite color and font (see example)

![txt_conf.png](readme/txt_conf.png)
2. Add your OctoPrint Url e.g `http://192.168.178.13`
3. Add your API-Key (https://docs.octoprint.org/en/master/api/general.html#authorization)
3. Add your API-Key [click](https://docs.octoprint.org/en/master/api/general.html#authorization)
4. Hit Save.

![configuration.png](readme/configuration.png)

## Use
Click the icon on your StreamDeck to update the current completion. Automatic update every 5 minutes
Click the icon on your StreamDeck to update the completion. Automatic update every 5 minutes

## Available States
- `rdy` => the printer is connected and is ready to print
Expand Down
4 changes: 2 additions & 2 deletions com.cpeuschel.octodeck.sdPlugin/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
}
],
"SupportedInMultiActions": false,
"Tooltip": "Show the current print state with OctoPrint",
"Tooltip": "This plugin shows your 3D-Printer completion state in percent on your StreamDeck (OctoPrint required)",
"UUID": "com.cpeuschel.octodeck.action"
}
],
Expand All @@ -36,4 +36,4 @@
"Software": {
"MinimumVersion" : "4.1"
}
}
}

0 comments on commit 4c854a5

Please sign in to comment.