diff options
| -rw-r--r-- | kvmd/plugins/ugpio/servo.py | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/kvmd/plugins/ugpio/servo.py b/kvmd/plugins/ugpio/servo.py new file mode 100644 index 00000000..448cfdb1 --- /dev/null +++ b/kvmd/plugins/ugpio/servo.py @@ -0,0 +1,88 @@ +# ========================================================================== # +# # +# KVMD - The main Pi-KVM daemon. # +# # +# Copyright (C) 2018-2021 Maxim Devaev <[email protected]> # +# Shantur Rathore <[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 Dict + +from ... import aiotools + +from ...yamlconf import Option + +from ...validators.basic import valid_number +from ...validators.basic import valid_int_f0 + +from .pwm import Plugin as PwmPlugin + + +# ===== +class Plugin(PwmPlugin): + def __init__( # pylint: disable=super-init-not-called,too-many-arguments + self, + instance_name: str, + notifier: aiotools.AioNotifier, + + chip: int, + period: int, + duty_cycle_min: int, + duty_cycle_max: int, + angle_min: float, + angle_max: float, + angle_push: float, + angle_release: float, + ) -> None: + + angle_push = min(max(angle_push, angle_min), angle_max) + angle_release = min(max(angle_release, angle_min), angle_max) + + duty_cycle_per_degree = (duty_cycle_max - duty_cycle_min) / (angle_max - angle_min) + + duty_cycle_push = int(duty_cycle_per_degree * (angle_push - angle_min) + duty_cycle_min) + duty_cycle_release = int(duty_cycle_per_degree * (angle_release - angle_min) + duty_cycle_min) + + super().__init__( + instance_name=instance_name, + notifier=notifier, + + chip=chip, + period=period, + duty_cycle_push=duty_cycle_push, + duty_cycle_release=duty_cycle_release, + ) + + @classmethod + def get_plugin_options(cls) -> Dict: + valid_angle = (lambda arg: valid_number(arg, min=-360.0, max=360.0, type=float)) + return { + "chip": Option(0, type=valid_int_f0), + "period": Option(20000000, type=valid_int_f0), + "duty_cycle_min": Option(1000000, type=valid_int_f0), + "duty_cycle_max": Option(2000000, type=valid_int_f0), + "angle_min": Option(0.0, type=valid_angle), + "angle_max": Option(180.0, type=valid_angle), + "angle_push": Option(100.0, type=valid_angle), + "angle_release": Option(120.0, type=valid_angle), + } + + def __str__(self) -> str: + return f"Servo({self._instance_name})" + + __repr__ = __str__ |