1
2
3
4
5
6
7
8
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
|
# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2023 Maxim Devaev <[email protected]> #
# #
# This program is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, either version 3 of the License, or #
# (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with this program. If not, see <https://www.gnu.org/licenses/>. #
# #
# ========================================================================== #
from typing import Callable
from typing import Any
from ...errors import OperationError
from ... import aiotools
from .. import BasePlugin
from .. import get_plugin_class
# =====
class GpioError(Exception):
pass
class GpioOperationError(OperationError, GpioError):
pass
class GpioDriverOfflineError(GpioOperationError):
def __init__(self, driver: "BaseUserGpioDriver") -> None:
super().__init__(f"GPIO driver {driver} is offline")
# =====
class UserGpioModes:
INPUT = "input"
OUTPUT = "output"
ALL = set([INPUT, OUTPUT])
# =====
class BaseUserGpioDriver(BasePlugin):
def __init__( # pylint: disable=super-init-not-called
self,
instance_name: str,
notifier: aiotools.AioNotifier,
**_: Any,
) -> None:
self._instance_name = instance_name
self._notifier = notifier
def get_instance_id(self) -> str:
return self._instance_name
@classmethod
def get_modes(cls) -> set[str]:
return set(UserGpioModes.ALL)
@classmethod
def get_pin_validator(cls) -> Callable[[Any], Any]:
# XXX: The returned value will be forcibly converted to a string
# in kvmd/apps/kvmd/ugpio.py, i.e. AFTER validation.
raise NotImplementedError
def register_input(self, pin: str, debounce: float) -> None:
_ = pin
_ = debounce
def register_output(self, pin: str, initial: (bool | None)) -> None:
_ = pin
_ = initial
def prepare(self) -> None:
pass
async def run(self) -> None:
await aiotools.wait_infinite()
async def cleanup(self) -> None:
pass
async def read(self, pin: str) -> bool:
raise NotImplementedError
async def write(self, pin: str, state: bool) -> None:
raise NotImplementedError
# =====
def get_ugpio_driver_class(name: str) -> type[BaseUserGpioDriver]:
return get_plugin_class("ugpio", name) # type: ignore
|
