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
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
188
189
|
# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2024 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/>. #
# #
# ========================================================================== #
import asyncio
import contextlib
import functools
from typing import Callable
from typing import Any
import hid
from ...logging import get_logger
from ... import tools
from ... import aiotools
from ...yamlconf import Option
from ...validators.basic import valid_number
from ...validators.basic import valid_float_f01
from ...validators.os import valid_abs_path
from . import GpioDriverOfflineError
from . import UserGpioModes
from . import BaseUserGpioDriver
# =====
class Plugin(BaseUserGpioDriver):
# http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface
# https://github.com/trezor/cython-hidapi/blob/6057d41b5a2552a70ff7117a9d19fc21bf863867/chid.pxd
def __init__( # pylint: disable=super-init-not-called
self,
instance_name: str,
notifier: aiotools.AioNotifier,
device_path: str,
state_poll: float,
) -> None:
super().__init__(instance_name, notifier)
self.__device_path = device_path
self.__state_poll = state_poll
self.__device: (hid.device | None) = None # type: ignore
self.__stop = False
self.__initials: dict[int, (bool | None)] = {}
@classmethod
def get_plugin_options(cls) -> dict:
return {
"device": Option("", type=valid_abs_path, unpack_as="device_path"),
"state_poll": Option(5.0, type=valid_float_f01),
}
@classmethod
def get_modes(cls) -> set[str]:
return set([UserGpioModes.OUTPUT])
@classmethod
def get_pin_validator(cls) -> Callable[[Any], Any]:
return functools.partial(valid_number, min=0, max=7, name="HID relay channel")
def register_output(self, pin: str, initial: (bool | None)) -> None:
self.__initials[int(pin)] = initial
def prepare(self) -> None:
logger = get_logger(0)
logger.info("Probing driver %s on %s ...", self, self.__device_path)
try:
with self.__ensure_device("probing"):
pass
except Exception as ex:
logger.error("Can't probe %s on %s: %s",
self, self.__device_path, tools.efmt(ex))
self.__reset_pins()
async def run(self) -> None:
prev_raw = -1
while True:
try:
raw = self.__inner_read_raw()
except Exception:
raw = -1
if raw != prev_raw:
self._notifier.notify()
prev_raw = raw
await asyncio.sleep(self.__state_poll)
async def cleanup(self) -> None:
self.__reset_pins()
self.__close_device()
self.__stop = True
async def read(self, pin: str) -> bool:
try:
return self.__inner_read(int(pin))
except Exception:
raise GpioDriverOfflineError(self)
async def write(self, pin: str, state: bool) -> None:
try:
return self.__inner_write(int(pin), state)
except Exception:
raise GpioDriverOfflineError(self)
# =====
def __reset_pins(self) -> None:
logger = get_logger(0)
for (pin, state) in self.__initials.items():
if state is not None:
logger.info("Resetting pin=%d to state=%d of %s on %s: ...",
pin, state, self, self.__device_path)
try:
self.__inner_write(pin, state)
except Exception as ex:
logger.error("Can't reset pin=%d of %s on %s: %s",
pin, self, self.__device_path, tools.efmt(ex))
def __inner_read(self, pin: int) -> bool:
assert 0 <= pin <= 7
return bool(self.__inner_read_raw() & (1 << pin))
def __inner_read_raw(self) -> int:
with self.__ensure_device("reading") as device:
return device.get_feature_report(1, 8)[7]
def __inner_write(self, pin: int, state: bool) -> None:
assert 0 <= pin <= 7
with self.__ensure_device("writing") as device:
report = [(0xFF if state else 0xFD), pin + 1] # Pin numeration starts from 0
result = device.send_feature_report(report)
if result < 0:
raise RuntimeError(f"Retval of send_feature_report() < 0: {result}")
@contextlib.contextmanager
def __ensure_device(self, context: str) -> hid.device: # type: ignore
assert not self.__stop
if self.__device is None:
device = hid.device() # type: ignore
device.open_path(self.__device_path.encode("utf-8"))
device.set_nonblocking(True)
self.__device = device
get_logger(0).info("Opened %s on %s while %s", self, self.__device_path, context)
try:
yield self.__device
except Exception as ex:
get_logger(0).error("Error occured on %s on %s while %s: %s",
self, self.__device_path, context, tools.efmt(ex))
self.__close_device()
raise
def __close_device(self) -> None:
if self.__device:
try:
self.__device.close()
except Exception:
pass
self.__device = None
get_logger(0).info("Closed %s on %s", self, self.__device_path)
def __str__(self) -> str:
return f"HidRelay({self._instance_name})"
__repr__ = __str__
|
