docs: respect OctoPrint's case
Make sure that all references capitalize the "P" in OctoPrint. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
parent
8f7f824a47
commit
0d93cf2c39
|
@ -34,7 +34,7 @@ The following projects deploy Moonraker via Docker:
|
|||
|
||||
- [prind](https://github.com/mkuf/prind) by mkuf
|
||||
- A suite of containers which allow you to run Klipper in
|
||||
Docker. Includes support for Octoprint and Moonraker.
|
||||
Docker. Includes support for OctoPrint and Moonraker.
|
||||
|
||||
### Changes
|
||||
|
||||
|
|
|
@ -201,7 +201,7 @@ by a `callback` is wrapped in a dict:
|
|||
It is only necessary to set this to false if you need to return a body that
|
||||
does not match this result. For example, the `[octoprint_compat]` component
|
||||
uses this functionality to return results in a format that match what
|
||||
Octoprint itself would return.
|
||||
OctoPrint itself would return.
|
||||
|
||||
#### *Server.register_event_handler(event, callback)*
|
||||
|
||||
|
|
|
@ -262,9 +262,9 @@ force_logins: False
|
|||
```
|
||||
|
||||
### `[octoprint_compat]`
|
||||
Enables partial support of Octoprint API is implemented with the purpose of
|
||||
Enables partial support of OctoPrint API is implemented with the purpose of
|
||||
allowing uploading of sliced prints to a moonraker instance.
|
||||
Currently we support Slic3r derivatives and Cura with Cura-Octoprint.
|
||||
Currently we support Slic3r derivatives and Cura with Cura-OctoPrint.
|
||||
|
||||
```ini
|
||||
# moonraker.conf
|
||||
|
@ -286,7 +286,7 @@ rotate_90: False
|
|||
stream_url: /webcam/?action=stream
|
||||
# The URL to use for streaming the webcam. It can be set to an absolute
|
||||
# URL if needed. In order to get the webcam to work in Cura through
|
||||
# an Octoprint connection, you can set this value to
|
||||
# an OctoPrint connection, you can set this value to
|
||||
# http://<octoprint ip>/webcam/?action=stream. The default value is
|
||||
# /webcam/?action=stream.
|
||||
webcam_enabled: True
|
||||
|
|
|
@ -181,7 +181,7 @@
|
|||
metadata from gcode files.
|
||||
- Clean up API registration. All endpoints are now registered by Klippy
|
||||
host modules outside of static files and `/api/version`, which is used for
|
||||
compatibility with Octoprint's legacy file upload API.
|
||||
compatibility with OctoPrint's file upload API.
|
||||
- The server now runs in its own process. Communication between the Host and
|
||||
the server is done over a duplex pipe. Currently this results in a second
|
||||
log file being generated specifically for the server at
|
||||
|
|
|
@ -14,7 +14,7 @@ cors_domains:
|
|||
# Allow CORS requests for Fluidd
|
||||
http://app.fluidd.xyz
|
||||
|
||||
# Enable Octoprint compatibility for Slicer uploads
|
||||
# Enable OctoPrint compatibility for Slicer uploads
|
||||
# Supports Cura, Slic3r, and Slic3r dervivatives
|
||||
# (PrusaSlicer, SuperSlicer)
|
||||
[octoprint_compat]
|
||||
|
|
|
@ -72,7 +72,7 @@ such as a configuration change or a reinstallation.
|
|||
by Moonraker for the typical user.
|
||||
|
||||
### March 4th 2021
|
||||
- To enable Octoprint compatibility with slicer uploads it is now
|
||||
- To enable OctoPrint compatibility with slicer uploads it is now
|
||||
required to add `[octoprint_compat]` to `moonraker.conf`. After
|
||||
making this change it is necessary to restart the Moonraker service
|
||||
so the module is loaded.
|
||||
|
|
|
@ -1638,7 +1638,7 @@ Arguments available only for the `gcodes` root:
|
|||
|
||||
- `print`: If set to "true", Klippy will attempt to start the print after
|
||||
uploading. Note that this value should be a string type, not boolean. This
|
||||
provides compatibility with Octoprint's legacy upload API.
|
||||
provides compatibility with OctoPrint's upload API.
|
||||
|
||||
JSON-RPC request: Not Available
|
||||
|
||||
|
@ -3028,10 +3028,10 @@ An object containing power state for each requested device:
|
|||
}
|
||||
```
|
||||
|
||||
### Octoprint API emulation
|
||||
Partial support of Octoprint API is implemented with the purpose of
|
||||
### OctoPrint API emulation
|
||||
Partial support of OctoPrint API is implemented with the purpose of
|
||||
allowing uploading of sliced prints to a moonraker instance.
|
||||
Currently we support Slic3r derivatives and Cura with Cura-Octoprint.
|
||||
Currently we support Slic3r derivatives and Cura with Cura-OctoPrint.
|
||||
|
||||
#### Version information
|
||||
HTTP request:
|
||||
|
@ -3042,12 +3042,12 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing simulated Octoprint version information
|
||||
An object containing simulated OctoPrint version information
|
||||
```json
|
||||
{
|
||||
"server": "1.5.0",
|
||||
"api": "0.1",
|
||||
"text": "Octoprint (Moonraker v0.3.1-12)"
|
||||
"text": "OctoPrint (Moonraker v0.3.1-12)"
|
||||
}
|
||||
```
|
||||
|
||||
|
@ -3060,7 +3060,7 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing simulated Octoprint server status
|
||||
An object containing simulated OctoPrint server status
|
||||
```json
|
||||
{
|
||||
"server": "1.5.0",
|
||||
|
@ -3077,7 +3077,7 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing stubbed Octoprint login/user verification
|
||||
An object containing stubbed OctoPrint login/user verification
|
||||
```json
|
||||
{
|
||||
"_is_external_client": false,
|
||||
|
@ -3101,9 +3101,9 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing stubbed Octoprint settings.
|
||||
An object containing stubbed OctoPrint settings.
|
||||
The webcam route is hardcoded to Fluidd/Mainsail default path.
|
||||
We say we have the UFP plugin installed so that Cura-Octoprint will
|
||||
We say we have the UFP plugin installed so that Cura-OctoPrint will
|
||||
upload in the preferred UFP format.
|
||||
```json
|
||||
{
|
||||
|
@ -3133,7 +3133,7 @@ upload in the preferred UFP format.
|
|||
}
|
||||
```
|
||||
|
||||
#### Octoprint File Upload
|
||||
#### OctoPrint File Upload
|
||||
HTTP request:
|
||||
```http
|
||||
POST /api/files/local
|
||||
|
@ -3151,7 +3151,7 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing stubbed Octoprint Job status
|
||||
An object containing stubbed OctoPrint Job status
|
||||
```json
|
||||
{
|
||||
"job": {
|
||||
|
@ -3180,7 +3180,7 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing Octoprint Printer status
|
||||
An object containing OctoPrint Printer status
|
||||
```json
|
||||
{
|
||||
"temperature": {
|
||||
|
@ -3239,7 +3239,7 @@ JSON-RPC request: Not Available
|
|||
|
||||
Returns:
|
||||
|
||||
An object containing simulates Octoprint Printer profile
|
||||
An object containing simulates OctoPrint Printer profile
|
||||
```json
|
||||
{
|
||||
"profiles": {
|
||||
|
|
Loading…
Reference in New Issue