Skip to content

SwitchResource

SwitchResource

Multi-port KVM switch and EDID management for PiKVM.

Source code in src/aiopikvm/resources/switch.py 
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class SwitchResource(BaseResource):
    """Multi-port KVM switch and EDID management for PiKVM."""

    async def get_state(self) -> SwitchState:
        """Get the current switch state.

        Returns:
            Current switch state with active port and port list.
        """
        result = await self._get("/api/switch")
        return SwitchState.model_validate(result)

    async def set_active(self, port: str) -> None:
        """Set the active port.

        Args:
            port: Port identifier to activate.
        """
        await self._post("/api/switch/set_active", params={"port": port})

    async def get_edids(self) -> list[EDID]:
        """Get all EDID profiles.

        Returns:
            List of available EDID profiles.
        """
        result = await self._get("/api/switch/edids")
        return [EDID.model_validate(e) for e in result.get("edids", [])]

    async def create_edid(
        self, edid_id: str, data: str, *, description: str = ""
    ) -> None:
        """Create a new EDID profile.

        Args:
            edid_id: EDID profile identifier.
            data: Raw EDID data as hex string.
            description: Optional human-readable description.
        """
        body: dict[str, str] = {"id": edid_id, "data": data}
        if description:
            body["description"] = description
        await self._post("/api/switch/edids/create", json=body)

    async def change_edid(self, port: str, edid_id: str) -> None:
        """Change the EDID profile for a port.

        Args:
            port: Port identifier.
            edid_id: EDID profile identifier to assign.
        """
        await self._post(
            "/api/switch/edids/change",
            params={"port": port, "edid_id": edid_id},
        )

    async def remove_edid(self, edid_id: str) -> None:
        """Remove an EDID profile.

        Args:
            edid_id: EDID profile identifier to remove.
        """
        await self._post("/api/switch/edids/remove", params={"edid_id": edid_id})

    async def set_active_prev(self) -> None:
        """Switch to the previous port."""
        await self._post("/api/switch/set_active_prev")

    async def set_active_next(self) -> None:
        """Switch to the next port."""
        await self._post("/api/switch/set_active_next")

    async def set_beacon(
        self,
        state: bool,
        *,
        port: int | float | None = None,
        uplink: int | None = None,
        downlink: int | None = None,
    ) -> None:
        """Control indicator beacon lights.

        Args:
            state: Turn beacon on or off.
            port: Port number (``0``-``19`` or unit.port like ``0.3``).
            uplink: Uplink beacon number.
            downlink: Downlink beacon number.
        """
        params: dict[str, Any] = {"state": int(state)}
        if port is not None:
            params["port"] = port
        if uplink is not None:
            params["uplink"] = uplink
        if downlink is not None:
            params["downlink"] = downlink
        await self._post("/api/switch/set_beacon", params=params)

    async def set_port_params(
        self,
        port: int | float,
        *,
        edid_id: str | None = None,
        dummy: bool | None = None,
        name: str | None = None,
        atx_click_power_delay: float | None = None,
        atx_click_power_long_delay: float | None = None,
        atx_click_reset_delay: float | None = None,
    ) -> None:
        """Configure port parameters.

        Args:
            port: Port number (``0``-``19`` or unit.port notation).
            edid_id: EDID profile identifier.
            dummy: Pretend host has display attached.
            name: Port name (ASCII letters and numbers).
            atx_click_power_delay: ATX power click delay in seconds (``0``-``10``).
            atx_click_power_long_delay: ATX long power click delay in seconds
                (``0``-``10``).
            atx_click_reset_delay: ATX reset click delay in seconds (``0``-``10``).
        """
        params: dict[str, Any] = {"port": port}
        if edid_id is not None:
            params["edid_id"] = edid_id
        if dummy is not None:
            params["dummy"] = int(dummy)
        if name is not None:
            params["name"] = name
        if atx_click_power_delay is not None:
            params["atx_click_power_delay"] = atx_click_power_delay
        if atx_click_power_long_delay is not None:
            params["atx_click_power_long_delay"] = atx_click_power_long_delay
        if atx_click_reset_delay is not None:
            params["atx_click_reset_delay"] = atx_click_reset_delay
        await self._post("/api/switch/set_port_params", params=params)

    async def set_colors(self, beacon: str) -> None:
        """Set beacon indicator colors.

        Args:
            beacon: Color in ``RRGGBB:brightness:interval`` hex format
                (e.g. ``"FFA500:BF:0028"``).
        """
        await self._post("/api/switch/set_colors", params={"beacon": beacon})

    async def reset(self, unit: int, *, bootloader: bool = False) -> None:
        """Reboot a switch unit.

        Args:
            unit: Unit number (``0``-``4``).
            bootloader: Enter reflashing mode after reboot.
        """
        params: dict[str, Any] = {"unit": unit}
        if bootloader:
            params["bootloader"] = 1
        await self._post("/api/switch/reset", params=params)

    async def atx_power(self, port: int | float, action: str) -> None:
        """ATX power control for a specific port.

        Args:
            port: Port number (``0``-``19`` or unit.port notation).
            action: Power action (``"on"``, ``"off"``, ``"off_hard"``,
                ``"reset_hard"``).
        """
        await self._post(
            "/api/switch/atx/power", params={"port": port, "action": action}
        )

    async def atx_click(self, port: int | float, button: str) -> None:
        """Simulate an ATX button click for a specific port.

        Args:
            port: Port number (``0``-``19`` or unit.port notation).
            button: Button to simulate (``"power"``, ``"power_long"``,
                ``"reset"``).
        """
        await self._post(
            "/api/switch/atx/click", params={"port": port, "button": button}
        )

get_state() async

Get the current switch state.

Returns:

Type Description
SwitchState

Current switch state with active port and port list.
Source code in src/aiopikvm/resources/switch.py 
12
13
14
15
16
17
18
19
async def get_state(self) -> SwitchState:
    """Get the current switch state.

    Returns:
        Current switch state with active port and port list.
    """
    result = await self._get("/api/switch")
    return SwitchState.model_validate(result)

set_active(port) async

Set the active port.

Parameters:

Name Type Description Default
port str

Port identifier to activate.

 required
Source code in src/aiopikvm/resources/switch.py 
21
22
23
24
25
26
27
async def set_active(self, port: str) -> None:
    """Set the active port.

    Args:
        port: Port identifier to activate.
    """
    await self._post("/api/switch/set_active", params={"port": port})

get_edids() async

Get all EDID profiles.

Returns:

Type Description
list[EDID]

List of available EDID profiles.
Source code in src/aiopikvm/resources/switch.py 
29
30
31
32
33
34
35
36
async def get_edids(self) -> list[EDID]:
    """Get all EDID profiles.

    Returns:
        List of available EDID profiles.
    """
    result = await self._get("/api/switch/edids")
    return [EDID.model_validate(e) for e in result.get("edids", [])]

create_edid(edid_id, data, *, description='') async

Create a new EDID profile.

Parameters:

Name Type Description Default
edid_id str

EDID profile identifier.

 required
data str

Raw EDID data as hex string.

 required
description str

Optional human-readable description.

 ''
Source code in src/aiopikvm/resources/switch.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
async def create_edid(
    self, edid_id: str, data: str, *, description: str = ""
) -> None:
    """Create a new EDID profile.

    Args:
        edid_id: EDID profile identifier.
        data: Raw EDID data as hex string.
        description: Optional human-readable description.
    """
    body: dict[str, str] = {"id": edid_id, "data": data}
    if description:
        body["description"] = description
    await self._post("/api/switch/edids/create", json=body)

change_edid(port, edid_id) async

Change the EDID profile for a port.

Parameters:

Name Type Description Default
port str

Port identifier.

 required
edid_id str

EDID profile identifier to assign.

 required
Source code in src/aiopikvm/resources/switch.py 
53
54
55
56
57
58
59
60
61
62
63
async def change_edid(self, port: str, edid_id: str) -> None:
    """Change the EDID profile for a port.

    Args:
        port: Port identifier.
        edid_id: EDID profile identifier to assign.
    """
    await self._post(
        "/api/switch/edids/change",
        params={"port": port, "edid_id": edid_id},
    )

remove_edid(edid_id) async

Remove an EDID profile.

Parameters:

Name Type Description Default
edid_id str

EDID profile identifier to remove.

 required
Source code in src/aiopikvm/resources/switch.py 
65
66
67
68
69
70
71
async def remove_edid(self, edid_id: str) -> None:
    """Remove an EDID profile.

    Args:
        edid_id: EDID profile identifier to remove.
    """
    await self._post("/api/switch/edids/remove", params={"edid_id": edid_id})

set_active_prev() async

Switch to the previous port.

Source code in src/aiopikvm/resources/switch.py 
73
74
75
async def set_active_prev(self) -> None:
    """Switch to the previous port."""
    await self._post("/api/switch/set_active_prev")

set_active_next() async

Switch to the next port.

Source code in src/aiopikvm/resources/switch.py 
77
78
79
async def set_active_next(self) -> None:
    """Switch to the next port."""
    await self._post("/api/switch/set_active_next")

set_beacon(state, *, port=None, uplink=None, downlink=None) async

Control indicator beacon lights.

Parameters:

Name Type Description Default
state bool

Turn beacon on or off.

 required
port int | float | None

Port number (0-19 or unit.port like 0.3).

 None
uplink int | None

Uplink beacon number.

 None
downlink int | None

Downlink beacon number.

 None
Source code in src/aiopikvm/resources/switch.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
async def set_beacon(
    self,
    state: bool,
    *,
    port: int | float | None = None,
    uplink: int | None = None,
    downlink: int | None = None,
) -> None:
    """Control indicator beacon lights.

    Args:
        state: Turn beacon on or off.
        port: Port number (``0``-``19`` or unit.port like ``0.3``).
        uplink: Uplink beacon number.
        downlink: Downlink beacon number.
    """
    params: dict[str, Any] = {"state": int(state)}
    if port is not None:
        params["port"] = port
    if uplink is not None:
        params["uplink"] = uplink
    if downlink is not None:
        params["downlink"] = downlink
    await self._post("/api/switch/set_beacon", params=params)

set_port_params(port, *, edid_id=None, dummy=None, name=None, atx_click_power_delay=None, atx_click_power_long_delay=None, atx_click_reset_delay=None) async

Configure port parameters.

Parameters:

Name Type Description Default
port int | float

Port number (0-19 or unit.port notation).

 required
edid_id str | None

EDID profile identifier.

 None
dummy bool | None

Pretend host has display attached.

 None
name str | None

Port name (ASCII letters and numbers).

 None
atx_click_power_delay float | None

ATX power click delay in seconds (0-10).

 None
atx_click_power_long_delay float | None

ATX long power click delay in seconds (0-10).

 None
atx_click_reset_delay float | None

ATX reset click delay in seconds (0-10).

 None
Source code in src/aiopikvm/resources/switch.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
async def set_port_params(
    self,
    port: int | float,
    *,
    edid_id: str | None = None,
    dummy: bool | None = None,
    name: str | None = None,
    atx_click_power_delay: float | None = None,
    atx_click_power_long_delay: float | None = None,
    atx_click_reset_delay: float | None = None,
) -> None:
    """Configure port parameters.

    Args:
        port: Port number (``0``-``19`` or unit.port notation).
        edid_id: EDID profile identifier.
        dummy: Pretend host has display attached.
        name: Port name (ASCII letters and numbers).
        atx_click_power_delay: ATX power click delay in seconds (``0``-``10``).
        atx_click_power_long_delay: ATX long power click delay in seconds
            (``0``-``10``).
        atx_click_reset_delay: ATX reset click delay in seconds (``0``-``10``).
    """
    params: dict[str, Any] = {"port": port}
    if edid_id is not None:
        params["edid_id"] = edid_id
    if dummy is not None:
        params["dummy"] = int(dummy)
    if name is not None:
        params["name"] = name
    if atx_click_power_delay is not None:
        params["atx_click_power_delay"] = atx_click_power_delay
    if atx_click_power_long_delay is not None:
        params["atx_click_power_long_delay"] = atx_click_power_long_delay
    if atx_click_reset_delay is not None:
        params["atx_click_reset_delay"] = atx_click_reset_delay
    await self._post("/api/switch/set_port_params", params=params)

set_colors(beacon) async

Set beacon indicator colors.

Parameters:

Name Type Description Default
beacon str

Color in RRGGBB:brightness:interval hex format (e.g. "FFA500:BF:0028").

 required
Source code in src/aiopikvm/resources/switch.py 
144
145
146
147
148
149
150
151
async def set_colors(self, beacon: str) -> None:
    """Set beacon indicator colors.

    Args:
        beacon: Color in ``RRGGBB:brightness:interval`` hex format
            (e.g. ``"FFA500:BF:0028"``).
    """
    await self._post("/api/switch/set_colors", params={"beacon": beacon})

reset(unit, *, bootloader=False) async

Reboot a switch unit.

Parameters:

Name Type Description Default
unit int

Unit number (0-4).

 required
bootloader bool

Enter reflashing mode after reboot.

 False
Source code in src/aiopikvm/resources/switch.py 
153
154
155
156
157
158
159
160
161
162
163
async def reset(self, unit: int, *, bootloader: bool = False) -> None:
    """Reboot a switch unit.

    Args:
        unit: Unit number (``0``-``4``).
        bootloader: Enter reflashing mode after reboot.
    """
    params: dict[str, Any] = {"unit": unit}
    if bootloader:
        params["bootloader"] = 1
    await self._post("/api/switch/reset", params=params)

atx_power(port, action) async

ATX power control for a specific port.

Parameters:

Name Type Description Default
port int | float

Port number (0-19 or unit.port notation).

 required
action str

Power action ("on", "off", "off_hard", "reset_hard").

 required
Source code in src/aiopikvm/resources/switch.py 
165
166
167
168
169
170
171
172
173
174
175
async def atx_power(self, port: int | float, action: str) -> None:
    """ATX power control for a specific port.

    Args:
        port: Port number (``0``-``19`` or unit.port notation).
        action: Power action (``"on"``, ``"off"``, ``"off_hard"``,
            ``"reset_hard"``).
    """
    await self._post(
        "/api/switch/atx/power", params={"port": port, "action": action}
    )

atx_click(port, button) async

Simulate an ATX button click for a specific port.

Parameters:

Name Type Description Default
port int | float

Port number (0-19 or unit.port notation).

 required
button str

Button to simulate ("power", "power_long", "reset").

 required
Source code in src/aiopikvm/resources/switch.py 
177
178
179
180
181
182
183
184
185
186
187
async def atx_click(self, port: int | float, button: str) -> None:
    """Simulate an ATX button click for a specific port.

    Args:
        port: Port number (``0``-``19`` or unit.port notation).
        button: Button to simulate (``"power"``, ``"power_long"``,
            ``"reset"``).
    """
    await self._post(
        "/api/switch/atx/click", params={"port": port, "button": button}
    )