3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add notes about sending M112 gcodes 

Also  document the new "full_version_string" field reported by the update_manager.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2021-04-09 14:57:06 -04:00
parent 7d3bba75e1
commit 4d1a2668f5
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/web_api.md
View File

@ -163,6 +163,12 @@ JSON-RPC request:
"id": 4564 "id": 4564
} }
``` ```
!!! note
This endpoint will immediately halt the printer and put it in a "shutdown"
state. It should be used to implement an "emergency stop" button and
also used if a user enters `M112`(emergency stop) via a console.
Returns: Returns:
`ok` `ok`
@ -659,6 +665,14 @@ JSON-RPC request:
"id": 7466} "id": 7466}
``` ```
!!! warning
When `M112`(emergency stop) is requested via this endpoint it will not
immediately stop the printer. `M112` will be placed on the gcode queue and
executed after all previous gcodes are complete. If a client detects
`M112` via user input (such as a console) it should request the
`/printer/emergency_stop` endpoint to immediately halt the printer. This
may be done in addition to sending the `M112` gcode if desired.
Returns: Returns:
`ok` when the gcode has completed execution. `ok` when the gcode has completed execution.
@ -1707,6 +1721,7 @@ and `fluidd` are present as clients configured in `moonraker.conf`
"owner": "Arksine", "owner": "Arksine",
"version": "v0.4.1-45", "version": "v0.4.1-45",
"remote_version": "v0.4.1-45", "remote_version": "v0.4.1-45",
"full_version_string": "v0.4.1-45-g7e230c1c",
"current_hash": "7e230c1c77fa406741ab99fb9156951c4e5c9cb4", "current_hash": "7e230c1c77fa406741ab99fb9156951c4e5c9cb4",
"remote_hash": "7e230c1c77fa406741ab99fb9156951c4e5c9cb4", "remote_hash": "7e230c1c77fa406741ab99fb9156951c4e5c9cb4",
"is_dirty": false, "is_dirty": false,
@ -1733,6 +1748,7 @@ and `fluidd` are present as clients configured in `moonraker.conf`
"owner": "KevinOConnor", "owner": "KevinOConnor",
"version": "v0.9.1-317", "version": "v0.9.1-317",
"remote_version": "v0.9.1-324", "remote_version": "v0.9.1-324",
"full_version_string": "v0.9.1-324-gd77928b1",
"current_hash": "d77928b17ba6b32189033b3d6decdb5bcc7c342c", "current_hash": "d77928b17ba6b32189033b3d6decdb5bcc7c342c",
"remote_hash": "22753f3b389e3f21a6047bac70abc42b6cf4a7dc", "remote_hash": "22753f3b389e3f21a6047bac70abc42b6cf4a7dc",
"is_dirty": false, "is_dirty": false,
@ -1783,8 +1799,9 @@ as git repos have the following fields:
be "master". be "master".
- `remote_alias`: the alias for the remote. This should typically be - `remote_alias`: the alias for the remote. This should typically be
"origin". "origin".
- `version`: version of the current repo on disk - `version`: abbreviated version of the current repo on disk
- `remote_version`: version of the latest available update - `remote_version`: abbreviated version of the latest available update
- `full_version_string`: The complete version string of the current repo.
- `current_hash`: hash of the most recent commit on disk - `current_hash`: hash of the most recent commit on disk
- `remote_hash`: hash of the most recent commit pushed to the remote - `remote_hash`: hash of the most recent commit pushed to the remote
- `is_valid`: true if installation is a valid git repo on the master branch - `is_valid`: true if installation is a valid git repo on the master branch