-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Arjan Mels <[email protected]>
- Loading branch information
Arjan Mels
committed
Mar 14, 2021
1 parent
fa2db70
commit f9655d7
Showing
1 changed file
with
9 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,25 @@ | ||
# moonraker Binding | ||
# Klipper/Moonraker Binding | ||
|
||
_Give some details about what this binding is meant for - a protocol, system, specific device._ | ||
|
||
_If possible, provide some resources like pictures, a YouTube video, etc. to give an impression of what can be done with this binding. You can place such resources into a `doc` folder next to this README.md._ | ||
This binding supports 3D printer running Klipper via the Moonraker API. | ||
For more information on Klipper: [klipper | Klipper is a 3d-printer firmware (klipper3d.org)](https://www.klipper3d.org/) | ||
For more information on the Moonraker Web API: [Arksine/moonraker: Web API Server for Klipper (github.com)](https://github.com/Arksine/moonraker) | ||
|
||
## Supported Things | ||
|
||
_Please describe the different supported things / devices within this section._ | ||
_Which different types are supported, which models were tested etc.?_ | ||
_Note that it is planned to generate some part of this based on the XML files within ```src/main/resources/OH-INF/thing``` of your binding._ | ||
3D Printer controlled by Klipper | ||
|
||
## Discovery | ||
|
||
_Describe the available auto-discovery features here. Mention for what it works and what needs to be kept in mind when using it._ | ||
Auto discovery is not supported. The hostname of the machine runnign Moonraker must be entered manually | ||
|
||
## Binding Configuration | ||
|
||
_If your binding requires or supports general configuration settings, please create a folder ```cfg``` and place the configuration file ```<bindingId>.cfg``` inside it. In this section, you should link to this file and provide some information about the options. The file could e.g. look like:_ | ||
|
||
``` | ||
# Configuration for the Philips Hue Binding | ||
# | ||
# Default secret key for the pairing of the Philips Hue Bridge. | ||
# It has to be between 10-40 (alphanumeric) characters | ||
# This may be changed by the user for security reasons. | ||
secret=openHABSecret | ||
``` | ||
|
||
_Note that it is planned to generate some part of this based on the information that is available within ```src/main/resources/OH-INF/binding``` of your binding._ | ||
|
||
_If your binding does not offer any generic configurations, you can remove this section completely._ | ||
No binding configuration | ||
|
||
## Thing Configuration | ||
|
||
_Describe what is needed to manually configure a thing, either through the (Paper) UI or via a thing-file. This should be mainly about its mandatory and optional configuration parameters. A short example entry for a thing file can help!_ | ||
|
||
_Note that it is planned to generate some part of this based on the XML files within ```src/main/resources/OH-INF/thing``` of your binding._ | ||
Host is the hostname or ipaddress of the machine running Moonraker. You can customize the port on which Moonraker is running and optionally you can specify an API Key. | ||
|
||
## Channels | ||
|
||
_Here you should provide information about available channel types, what their meaning is and how they can be used._ | ||
|
||
_Note that it is planned to generate some part of this based on the XML files within ```src/main/resources/OH-INF/thing``` of your binding._ | ||
|
||
| channel | type | description | | ||
|----------|--------|------------------------------| | ||
| control | Switch | This is the control channel | | ||
|
||
## Full Example | ||
|
||
_Provide a full usage example based on textual configuration files (*.things, *.items, *.sitemap)._ | ||
|
||
## Any custom content here! | ||
|
||
_Feel free to add additional sections for whatever you think should also be mentioned about your binding!_ | ||
Almost all field documented in: https://github.com/Arksine/moonraker/blob/master/docs/printer_objects.md are made accessible. |