docs: document status endpoint and notification

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2024-01-20 12:14:12 -05:00
parent d410731faa
commit b620ebbc29
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 56 additions and 0 deletions

View File

@ -5335,6 +5335,45 @@ An object containing all measurements for every configured sensor:
### Spoolman APIs
The following APIs are available to interact with the Spoolman integration:
### Get Spoolman Status
Returns the current status of the spoolman module.
HTTP request:
```http
GET /server/spoolman/status
```
JSON-RPC request:
```json
{
"jsonrpc": "2.0",
"method": "server.spoolman.status",
"id": 4654
}
```
Returns:
An object containing details about the current status:
```json
{
"spoolman_connected": false,
"pending_reports": [
{
"spool_id": 1,
"filament_used": 10
}
],
"spool_id": 2
}
```
- `spoolman_connected`: A boolean indicating if Moonraker is connected to
Spoolman. When `false` Spoolman is unavailable.
- `pending_reports`: A list of objects containing spool data that has
yet to be reported to Spoolman.
- `spool_id`: The current Spool ID. Can be an integer value or `null`.
#### Set active spool
Set the ID of the spool that Moonraker should report usage to Spoolman of.
@ -7045,6 +7084,23 @@ See the [Spoolman API](#spoolman-apis) for more information.
}
```
#### Spoolman Status Changed
Moonraker will emit the `notify_spoolman_status_changed` event when the
connection state to the Spoolman service has changed:
```json
{
"jsonrpc": "2.0",
"method": "notify_spoolman_status_changed",
"params": [
{
"spoolman_connected": false
}
]
}
```
#### Agent Events
Moonraker will emit the `notify_agent_event` notification when it
an agent event is received.