PowerNamespace

pymoonraker.api.PowerNamespace

Power device control.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py

class PowerNamespace:
    """Power device control.

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

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

    async def devices(self) -> PowerDevicesResponse:
        """List all configured power devices."""
        raw = await self._client.call("machine.device_power.devices")
        return PowerDevicesResponse.model_validate(raw)

    async def get_device(self, device: str) -> builtins.dict[str, str]:
        """Get power state of a device.

        Args:
            device: Device name

        """
        params: dict[str, Any] = {}
        params["device"] = device
        raw = await self._client.call("machine.device_power.get_device", params)
        return cast("builtins.dict[str, str]", raw)

    async def set_device(self, device: str, action: str) -> builtins.dict[str, str]:
        """Set power state of a device.

        Args:
            device: Device name
            action: Action: on, off, or toggle

        """
        params: dict[str, Any] = {}
        params["device"] = device
        params["action"] = action
        raw = await self._client.call("machine.device_power.post_device", params)
        return cast("builtins.dict[str, str]", raw)

devices async

devices() -> PowerDevicesResponse

List all configured power devices.

Source code in src/pymoonraker/api/_generated.py

async def devices(self) -> PowerDevicesResponse:
    """List all configured power devices."""
    raw = await self._client.call("machine.device_power.devices")
    return PowerDevicesResponse.model_validate(raw)

get_device async

get_device(device: str) -> builtins.dict[str, str]

Get power state of a device.

Parameters:

Name	Type	Description	Default
device	str	Device name	required

Source code in src/pymoonraker/api/_generated.py

async def get_device(self, device: str) -> builtins.dict[str, str]:
    """Get power state of a device.

    Args:
        device: Device name

    """
    params: dict[str, Any] = {}
    params["device"] = device
    raw = await self._client.call("machine.device_power.get_device", params)
    return cast("builtins.dict[str, str]", raw)

set_device async

set_device(device: str, action: str) -> builtins.dict[str, str]

Set power state of a device.

Parameters:

Name	Type	Description	Default
device	str	Device name	required
action	str	Action: on, off, or toggle	required

Source code in src/pymoonraker/api/_generated.py

async def set_device(self, device: str, action: str) -> builtins.dict[str, str]:
    """Set power state of a device.

    Args:
        device: Device name
        action: Action: on, off, or toggle

    """
    params: dict[str, Any] = {}
    params["device"] = device
    params["action"] = action
    raw = await self._client.call("machine.device_power.post_device", params)
    return cast("builtins.dict[str, str]", raw)