summaryrefslogtreecommitdiff
path: root/kvmd/plugins/ugpio/locator.py
blob: b30c0530dcd64742e0cc3ba8aaa0c55bd4dc71b1 (plain)
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
# ========================================================================== #
#                                                                            #
#    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/>.  #
#                                                                            #
# ========================================================================== #


import asyncio

from typing import Callable
from typing import Any

import gpiod

from ... import aiotools

from ...yamlconf import Option

from ...validators.os import valid_abs_path
from ...validators.hw import valid_gpio_pin

from . import UserGpioModes
from . import BaseUserGpioDriver


# =====
class Plugin(BaseUserGpioDriver):
    def __init__(
        self,
        instance_name: str,
        notifier: aiotools.AioNotifier,

        device_path: str,
    ) -> None:

        super().__init__(instance_name, notifier)

        self.__device_path = device_path

        self.__tasks: dict[int, (asyncio.Task | None)] = {}

        self.__chip: (gpiod.Chip | None) = None
        self.__lines: dict[int, gpiod.Line] = {}

    @classmethod
    def get_plugin_options(cls) -> dict:
        return {
            "device": Option("/dev/gpiochip0", type=valid_abs_path, unpack_as="device_path"),
        }

    @classmethod
    def get_modes(cls) -> set[str]:
        return set([UserGpioModes.OUTPUT])

    @classmethod
    def get_pin_validator(cls) -> Callable[[Any], Any]:
        return valid_gpio_pin

    def register_output(self, pin: str, initial: (bool | None)) -> None:
        _ = initial
        self.__tasks[int(pin)] = None

    def prepare(self) -> None:
        self.__chip = gpiod.Chip(self.__device_path)
        for pin in self.__tasks:
            line = self.__chip.get_line(pin)
            line.request("kvmd::locator::outputs", gpiod.LINE_REQ_DIR_OUT, default_vals=[0])
            self.__lines[pin] = line

    async def cleanup(self) -> None:
        tasks = [
            task
            for task in self.__tasks.values()
            if task is not None
        ]
        for task in tasks:
            task.cancel()
        await asyncio.gather(*tasks, return_exceptions=True)
        if self.__chip:
            try:
                self.__chip.close()
            except Exception:
                pass

    async def read(self, pin: str) -> bool:
        return (self.__tasks[int(pin)] is not None)

    async def write(self, pin: str, state: bool) -> None:
        pin_int = int(pin)
        task = self.__tasks[pin_int]
        if state and task is None:
            self.__tasks[pin_int] = asyncio.create_task(self.__blink(pin_int))
        elif not state and task is not None:
            task.cancel()
            await task
            self.__tasks[pin_int] = None

    async def __blink(self, pin: int) -> None:
        line = self.__lines[pin]
        try:
            state = 1
            while True:
                line.set_value(state)
                state = int(not state)
                await asyncio.sleep(0.1)
        except asyncio.CancelledError:
            pass
        finally:
            line.set_value(0)

    def __str__(self) -> str:
        return f"Locator({self._instance_name})"

    __repr__ = __str__