Skip to content

UpdateManagerNamespace

pymoonraker.api.UpdateManagerNamespace

Software update management.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
class UpdateManagerNamespace:
    """Software update management.

    Auto-generated from schema/moonraker_api.yaml.
    """

    def __init__(self, client: MoonrakerClient) -> None:
        self._client = client

    async def status(self, refresh: bool | None = None) -> UpdateManagerStatusResponse:
        """Get update status for all tracked software.

        Args:
            refresh: Refresh update state from remote

        """
        params: dict[str, Any] = {}
        if refresh is not None:
            params["refresh"] = refresh
        raw = await self._client.call("machine.update.status", params)
        return UpdateManagerStatusResponse.model_validate(raw)

    async def refresh(self) -> UpdateManagerStatusResponse:
        """Force refresh of update state from remote."""
        raw = await self._client.call("machine.update.refresh")
        return UpdateManagerStatusResponse.model_validate(raw)

refresh async

refresh() -> UpdateManagerStatusResponse

Force refresh of update state from remote.

Source code in src/pymoonraker/api/_generated.py
557
558
559
560
async def refresh(self) -> UpdateManagerStatusResponse:
    """Force refresh of update state from remote."""
    raw = await self._client.call("machine.update.refresh")
    return UpdateManagerStatusResponse.model_validate(raw)

status async

status(refresh: bool | None = None) -> UpdateManagerStatusResponse

Get update status for all tracked software.

Parameters:

Name Type Description Default
refresh bool | None

Refresh update state from remote

None
Source code in src/pymoonraker/api/_generated.py
544
545
546
547
548
549
550
551
552
553
554
555
async def status(self, refresh: bool | None = None) -> UpdateManagerStatusResponse:
    """Get update status for all tracked software.

    Args:
        refresh: Refresh update state from remote

    """
    params: dict[str, Any] = {}
    if refresh is not None:
        params["refresh"] = refresh
    raw = await self._client.call("machine.update.status", params)
    return UpdateManagerStatusResponse.model_validate(raw)