Compare commits
43 Commits
v0.0.1
...
8db1f59cfe
| Author | SHA1 | Date | |
|---|---|---|---|
| 8db1f59cfe | |||
| 7051eba9b9 | |||
| 04780bd0dd | |||
| 41fb2b3c61 | |||
| 41d9b13e71 | |||
| 463a61a001 | |||
| 1fab228272 | |||
| fc82ec0eb9 | |||
| de1774f60e | |||
| 8c145ef2ff | |||
| 0ecd86bd64 | |||
| 555c781aed | |||
| 604cb61870 | |||
| 69e370f964 | |||
| 6eb7eeea40 | |||
| 18e6fb3d14 | |||
| fe614d026a | |||
| 870a55042e | |||
| 2848fdcf54 | |||
| d0f641f2b5 | |||
| e8eba43647 | |||
| 0d601f623c | |||
| 66735a9eba | |||
| 7525c9f653 | |||
| 3909fab379 | |||
| 9ce36c78e7 | |||
| c24c78761f | |||
| 3cc64f514f | |||
| 865d2ca7a9 | |||
| 157b7bd118 | |||
| 26c3ac0afb | |||
| f8bc1532e3 | |||
| 7207845b13 | |||
| 3f808c55f8 | |||
| 4ccc328d0b | |||
| 76b53423c1 | |||
| 114cbd8099 | |||
| 487d5b3d46 | |||
| 93b328bf3f | |||
| bde3920fc1 | |||
| a4ccb9081f | |||
| 4c1dc1c9b5 | |||
| e756d68556 |
@@ -1,4 +1,4 @@
|
|||||||
<!-- /etc/dbus-1/system.d/revpi-middleware.conf -->
|
<!-- /usr/share/dbus-1/system.d/com.revolutionpi.middleware1.conf -->
|
||||||
<busconfig>
|
<busconfig>
|
||||||
<!-- Allow full access to root as the bus owner -->
|
<!-- Allow full access to root as the bus owner -->
|
||||||
<policy user="root">
|
<policy user="root">
|
||||||
@@ -12,7 +12,7 @@
|
|||||||
<allow send_destination="com.revolutionpi.middleware1"
|
<allow send_destination="com.revolutionpi.middleware1"
|
||||||
send_interface="org.freedesktop.DBus.Introspectable"/>
|
send_interface="org.freedesktop.DBus.Introspectable"/>
|
||||||
<allow send_destination="com.revolutionpi.middleware1"
|
<allow send_destination="com.revolutionpi.middleware1"
|
||||||
send_interface="com.revolutionpi.middleware1.picontrol"/>
|
send_interface="com.revolutionpi.middleware1.PiControl"/>
|
||||||
</policy>
|
</policy>
|
||||||
|
|
||||||
<!-- Standard-Policy -->
|
<!-- Standard-Policy -->
|
||||||
|
|||||||
@@ -5,12 +5,11 @@
|
|||||||
This module provides the foundation for the RevPi middleware CLI commands
|
This module provides the foundation for the RevPi middleware CLI commands
|
||||||
and argument parsing setup.
|
and argument parsing setup.
|
||||||
"""
|
"""
|
||||||
from argparse import ArgumentParser
|
|
||||||
from logging import getLogger
|
from logging import getLogger
|
||||||
|
|
||||||
from revpi_middleware.cli_commands import cli_picontrol
|
from . import cli_config, cli_picontrol
|
||||||
from revpi_middleware.proginit import StdLogOutput
|
|
||||||
from .. import proginit as pi
|
from .. import proginit as pi
|
||||||
|
from ..proginit import StdLogOutput
|
||||||
|
|
||||||
log = getLogger(__name__)
|
log = getLogger(__name__)
|
||||||
|
|
||||||
@@ -30,6 +29,11 @@ def setup_command_line_arguments():
|
|||||||
help="RevPi PiControl object",
|
help="RevPi PiControl object",
|
||||||
)
|
)
|
||||||
cli_picontrol.add_subparsers(obj_picontrol)
|
cli_picontrol.add_subparsers(obj_picontrol)
|
||||||
|
obj_config = rpictl_obj.add_parser(
|
||||||
|
"config",
|
||||||
|
help="RevPi configuration object (revpi-config)",
|
||||||
|
)
|
||||||
|
cli_config.add_subparsers(obj_config)
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
def main() -> int:
|
||||||
@@ -40,6 +44,9 @@ def main() -> int:
|
|||||||
if obj == "picontrol":
|
if obj == "picontrol":
|
||||||
rc = cli_picontrol.main()
|
rc = cli_picontrol.main()
|
||||||
|
|
||||||
|
elif obj == "config":
|
||||||
|
rc = cli_config.main()
|
||||||
|
|
||||||
else:
|
else:
|
||||||
log.error(f"Unknown object: {obj}")
|
log.error(f"Unknown object: {obj}")
|
||||||
rc = 1
|
rc = 1
|
||||||
|
|||||||
93
src/revpi_middleware/cli_commands/cli_config.py
Normal file
93
src/revpi_middleware/cli_commands/cli_config.py
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
"""Command-Line for the picontrol object of CLI."""
|
||||||
|
from argparse import ArgumentParser
|
||||||
|
from logging import getLogger
|
||||||
|
|
||||||
|
from .dbus_helper import BusType, get_properties, simple_call
|
||||||
|
from .. import proginit as pi
|
||||||
|
from ..dbus_middleware1 import extend_interface
|
||||||
|
|
||||||
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def add_subparsers(parent_parser: ArgumentParser):
|
||||||
|
parent_parser.add_argument(
|
||||||
|
"action",
|
||||||
|
choices=["enable", "disable", "status", "available", "list-features"],
|
||||||
|
help="Action to be executed: enable, disable, status or available. "
|
||||||
|
"To get all available features, use 'list-features'.",
|
||||||
|
)
|
||||||
|
parent_parser.add_argument(
|
||||||
|
"feature",
|
||||||
|
nargs="?",
|
||||||
|
default="",
|
||||||
|
help="Name of the feature to configer. To list all features use 'list-features' as action.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
action = pi.pargs.action
|
||||||
|
dbus_value = False
|
||||||
|
try:
|
||||||
|
|
||||||
|
if action == "list-features":
|
||||||
|
dbus_value = get_properties(
|
||||||
|
"available_features",
|
||||||
|
interface=extend_interface("RevpiConfig"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
|
for feature in dbus_value:
|
||||||
|
print(feature)
|
||||||
|
|
||||||
|
return 0
|
||||||
|
|
||||||
|
# For the following actions, a feature name is required
|
||||||
|
if pi.pargs.feature == "":
|
||||||
|
raise Exception("Feature name is required")
|
||||||
|
|
||||||
|
if action == "enable":
|
||||||
|
simple_call(
|
||||||
|
"Enable",
|
||||||
|
pi.pargs.feature,
|
||||||
|
interface=extend_interface("RevpiConfig"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
|
|
||||||
|
elif action == "disable":
|
||||||
|
simple_call(
|
||||||
|
"Disable",
|
||||||
|
pi.pargs.feature,
|
||||||
|
interface=extend_interface("RevpiConfig"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
|
|
||||||
|
elif action == "status":
|
||||||
|
dbus_value = simple_call(
|
||||||
|
"GetStatus",
|
||||||
|
pi.pargs.feature,
|
||||||
|
interface=extend_interface("RevpiConfig"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
|
|
||||||
|
elif action == "available":
|
||||||
|
dbus_value = simple_call(
|
||||||
|
"GetAvailability",
|
||||||
|
pi.pargs.feature,
|
||||||
|
interface=extend_interface("RevpiConfig"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise Exception(f"Unknown action: {action}")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
log.error(f"Error: {e}")
|
||||||
|
return 1
|
||||||
|
|
||||||
|
log.debug(
|
||||||
|
f"D-Bus call of method {action} for feature {pi.pargs.feature} returned: {dbus_value}"
|
||||||
|
)
|
||||||
|
print(int(dbus_value))
|
||||||
|
|
||||||
|
return 0
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
from argparse import ArgumentParser
|
from argparse import ArgumentParser
|
||||||
from logging import getLogger
|
from logging import getLogger
|
||||||
|
|
||||||
from .dbus_helper import await_signal, simple_call
|
from .dbus_helper import BusType, await_signal, simple_call
|
||||||
from .. import proginit as pi
|
from .. import proginit as pi
|
||||||
from ..dbus_middleware1 import extend_interface
|
from ..dbus_middleware1 import extend_interface
|
||||||
|
|
||||||
@@ -36,12 +36,21 @@ def add_subparsers(parent_parser: ArgumentParser):
|
|||||||
|
|
||||||
def method_reset():
|
def method_reset():
|
||||||
log.debug("D-Bus call of method ResetDriver")
|
log.debug("D-Bus call of method ResetDriver")
|
||||||
simple_call("ResetDriver", interface=extend_interface("picontrol"))
|
simple_call(
|
||||||
|
"ResetDriver",
|
||||||
|
interface=extend_interface("PiControl"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
log.info("ResetDriver called via D-Bus")
|
log.info("ResetDriver called via D-Bus")
|
||||||
|
|
||||||
|
|
||||||
def method_await_reset(timout: int = 0):
|
def method_await_reset(timeout: int = 0):
|
||||||
detected_signal = await_signal("NotifyDriverReset", timout, extend_interface("picontrol"))
|
detected_signal = await_signal(
|
||||||
|
"NotifyDriverReset",
|
||||||
|
timeout,
|
||||||
|
extend_interface("PiControl"),
|
||||||
|
bus_type=BusType.SESSION if pi.pargs.use_session_bus else BusType.SYSTEM,
|
||||||
|
)
|
||||||
if detected_signal:
|
if detected_signal:
|
||||||
log.info("ResetDriver signal received")
|
log.info("ResetDriver signal received")
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -1,50 +1,113 @@
|
|||||||
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
"""D-Bus helper functions for cli commands."""
|
"""D-Bus helper functions for cli commands."""
|
||||||
|
from enum import Enum
|
||||||
from threading import Thread
|
from threading import Thread
|
||||||
from time import sleep
|
from time import sleep
|
||||||
|
|
||||||
from gi.repository import GLib
|
from gi.repository import GLib
|
||||||
from pydbus import SystemBus
|
from pydbus import SessionBus, SystemBus
|
||||||
|
|
||||||
from ..dbus_middleware1 import REVPI_DBUS_BASE_PATH
|
from ..dbus_middleware1 import REVPI_DBUS_BASE_PATH
|
||||||
from ..dbus_middleware1 import REVPI_DBUS_NAME
|
from ..dbus_middleware1 import REVPI_DBUS_NAME
|
||||||
|
|
||||||
PICONTROL_INTERFACE = "com.revolutionpi.middleware1.picontrol"
|
|
||||||
RESET_DRIVER_METHOD = "ResetDriver"
|
class BusType(Enum):
|
||||||
|
SESSION = "session"
|
||||||
|
SYSTEM = "system"
|
||||||
|
|
||||||
|
|
||||||
def simple_call(method: str, *args, interface: str, object_path=REVPI_DBUS_BASE_PATH):
|
def get_properties(
|
||||||
|
property_name: str,
|
||||||
|
interface: str,
|
||||||
|
object_path=REVPI_DBUS_BASE_PATH,
|
||||||
|
bus_type=BusType.SYSTEM,
|
||||||
|
):
|
||||||
|
bus = SessionBus() if bus_type is BusType.SESSION else SystemBus()
|
||||||
|
revpi = bus.get(REVPI_DBUS_NAME, object_path)
|
||||||
|
iface = revpi[interface]
|
||||||
|
return getattr(iface, property_name)
|
||||||
|
|
||||||
|
|
||||||
|
def simple_call(
|
||||||
|
method: str,
|
||||||
|
*args,
|
||||||
|
interface: str,
|
||||||
|
object_path=REVPI_DBUS_BASE_PATH,
|
||||||
|
bus_type=BusType.SYSTEM,
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Executes a method on a specific D-Bus object interface within the RevPi system. This function
|
Performs a call to a D-Bus method on a specified interface and object.
|
||||||
connects to the system bus, retrieves the desired interface and object path, and invokes
|
|
||||||
the specified method with provided arguments.
|
This function uses the D-Bus messaging system to dynamically call a method
|
||||||
|
of a specified interface, using the given object path and bus type. It
|
||||||
|
provides a way to interact with D-Bus interfaces, using either a system or
|
||||||
|
session bus, and returns the result of executing the specified method.
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
method: str
|
method: str
|
||||||
The name of the method to be invoked on the targeted interface.
|
The name of the method to invoke on the D-Bus interface.
|
||||||
*args: tuple
|
*args:
|
||||||
Positional arguments to be passed to the method being invoked.
|
Additional positional arguments to pass to the specified D-Bus method.
|
||||||
interface: str
|
interface: str
|
||||||
The name of the D-Bus interface providing the required functionality.
|
The name of the D-Bus interface containing the method.
|
||||||
object_path: str, optional
|
object_path:
|
||||||
The D-Bus object path of the RevPi interface. Defaults to REVPI_DBUS_BASE_PATH.
|
The path of the D-Bus object on which the interface is defined. Defaults
|
||||||
|
to REVPI_DBUS_BASE_PATH.
|
||||||
|
bus_type: BusType
|
||||||
|
Specifies whether to use the system or session bus. Defaults to BusType.SYSTEM.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Any
|
The value returned by the D-Bus method.
|
||||||
The result of the method invocation on the targeted D-Bus interface.
|
|
||||||
|
Raises:
|
||||||
|
Any errors raised from the D-Bus call will propagate to the caller.
|
||||||
"""
|
"""
|
||||||
bus = SystemBus()
|
bus = SessionBus() if bus_type is BusType.SESSION else SystemBus()
|
||||||
revpi = bus.get(REVPI_DBUS_NAME, object_path)
|
revpi = bus.get(REVPI_DBUS_NAME, object_path)
|
||||||
iface = revpi[interface]
|
iface = revpi[interface]
|
||||||
return getattr(iface, method)(*args)
|
return getattr(iface, method)(*args)
|
||||||
|
|
||||||
|
|
||||||
def await_signal(signal_name: str, timeout: int, interface: str, object_path=REVPI_DBUS_BASE_PATH):
|
def await_signal(
|
||||||
|
signal_name: str,
|
||||||
|
timeout: int,
|
||||||
|
interface: str,
|
||||||
|
object_path=REVPI_DBUS_BASE_PATH,
|
||||||
|
bus_type=BusType.SYSTEM,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Waits for a specific signal and returns whether the signal was detected.
|
||||||
|
|
||||||
|
This function connects to a D-Bus interface and waits for a specific signal
|
||||||
|
to be emitted. If the signal is not received within the specified timeout
|
||||||
|
period, the function will return False. If the signal is detected within
|
||||||
|
the timeout, the function will return True. It can connect to either the
|
||||||
|
system bus or the session bus, depending on the provided `bus_type`.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
signal_name: str
|
||||||
|
The name of the signal to be awaited.
|
||||||
|
timeout: int
|
||||||
|
The maximum time to wait for the signal, in seconds. A value of 0 or
|
||||||
|
less means that there is no timeout.
|
||||||
|
interface: str
|
||||||
|
The name of the D-Bus interface to listen on.
|
||||||
|
object_path
|
||||||
|
The D-Bus object path where the interface resides. Defaults to
|
||||||
|
REVPI_DBUS_BASE_PATH.
|
||||||
|
bus_type
|
||||||
|
The type of D-Bus to connect to. Can be either BusType.SYSTEM or
|
||||||
|
BusType.SESSION. Defaults to BusType.SYSTEM.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool
|
||||||
|
True if the signal was detected within the timeout period, False
|
||||||
|
otherwise.
|
||||||
|
"""
|
||||||
detected_signal = False
|
detected_signal = False
|
||||||
timeout = int(timeout)
|
timeout = int(timeout)
|
||||||
loop = GLib.MainLoop()
|
loop = GLib.MainLoop()
|
||||||
th_sleep = Thread()
|
|
||||||
|
|
||||||
def th_timeout():
|
def th_timeout():
|
||||||
sleep(timeout)
|
sleep(timeout)
|
||||||
@@ -55,7 +118,7 @@ def await_signal(signal_name: str, timeout: int, interface: str, object_path=REV
|
|||||||
detected_signal = True
|
detected_signal = True
|
||||||
loop.quit()
|
loop.quit()
|
||||||
|
|
||||||
bus = SystemBus()
|
bus = SessionBus() if bus_type is BusType.SESSION else SystemBus()
|
||||||
revpi = bus.get(REVPI_DBUS_NAME, object_path)
|
revpi = bus.get(REVPI_DBUS_NAME, object_path)
|
||||||
iface = revpi[interface]
|
iface = revpi[interface]
|
||||||
|
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ class MiddlewareDaemon:
|
|||||||
if self.bus_provider and self.bus_provider.is_alive():
|
if self.bus_provider and self.bus_provider.is_alive():
|
||||||
return
|
return
|
||||||
|
|
||||||
self.bus_provider = BusProvider()
|
self.bus_provider = BusProvider(use_system_bus=not pi.pargs.use_session_bus)
|
||||||
self.bus_provider.start()
|
self.bus_provider.start()
|
||||||
|
|
||||||
log.debug("leave MiddlewareDaemon.dbus_start")
|
log.debug("leave MiddlewareDaemon.dbus_start")
|
||||||
|
|||||||
@@ -2,27 +2,7 @@
|
|||||||
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
"""D-Bus middleware version 1 of revpi_middleware."""
|
"""D-Bus middleware version 1 of revpi_middleware."""
|
||||||
from ..__about__ import __author__, __copyright__, __license__, __version__
|
from .dbus_helper import REVPI_DBUS_BASE_PATH, REVPI_DBUS_NAME
|
||||||
|
from .dbus_helper import extend_interface
|
||||||
|
|
||||||
REVPI_DBUS_NAME = "com.revolutionpi.middleware1"
|
from .bus_provider import BusProvider
|
||||||
REVPI_DBUS_BASE_PATH = "/com/revolutionpi/middleware1"
|
|
||||||
|
|
||||||
|
|
||||||
def extend_interface(*args) -> str:
|
|
||||||
"""
|
|
||||||
Extends an interface name by appending additional segments to a pre-defined base name.
|
|
||||||
|
|
||||||
This function takes multiple arguments, concatenates them with a predefined base
|
|
||||||
interface name, and returns the resulting string, effectively constructing an
|
|
||||||
extended interface name.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
*args: str
|
|
||||||
Components to be appended to the base interface name.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
str
|
|
||||||
Fully constructed interface name by joining the base interface name with
|
|
||||||
the provided segments.
|
|
||||||
"""
|
|
||||||
return ".".join([REVPI_DBUS_NAME, *args])
|
|
||||||
|
|||||||
@@ -6,35 +6,71 @@ from logging import getLogger
|
|||||||
from threading import Thread
|
from threading import Thread
|
||||||
|
|
||||||
from gi.repository import GLib
|
from gi.repository import GLib
|
||||||
from pydbus import SystemBus
|
from pydbus import SessionBus, SystemBus
|
||||||
|
|
||||||
from . import REVPI_DBUS_NAME
|
from . import REVPI_DBUS_NAME
|
||||||
from .process_image import InterfacePiControl
|
from .process_image import InterfacePiControl
|
||||||
|
from .system_config import InterfaceRevpiConfig
|
||||||
|
|
||||||
log = getLogger(__name__)
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class BusProvider(Thread):
|
class BusProvider(Thread):
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(
|
||||||
|
self,
|
||||||
|
picontrol_device="/dev/piControl0",
|
||||||
|
config_rsc="/etc/revpi/config.rsc",
|
||||||
|
use_system_bus=True,
|
||||||
|
):
|
||||||
log.debug("enter BusProvider.__init__")
|
log.debug("enter BusProvider.__init__")
|
||||||
super().__init__()
|
super().__init__()
|
||||||
|
|
||||||
self._bus = SystemBus()
|
self._bus = SystemBus() if use_system_bus else SessionBus()
|
||||||
self._loop = GLib.MainLoop()
|
self._loop = GLib.MainLoop()
|
||||||
|
|
||||||
|
self.picontrol_device = picontrol_device
|
||||||
|
self.config_rsc = config_rsc
|
||||||
|
|
||||||
def run(self):
|
def run(self):
|
||||||
log.debug("enter BusProvider.run")
|
log.debug("enter BusProvider.run")
|
||||||
|
|
||||||
|
# The 2nd, 3rd, ... arguments can be objects or tuples of a path and an object
|
||||||
|
# Example(),
|
||||||
|
# ("Subdir1", Example()),
|
||||||
|
# ("Subdir2", Example()),
|
||||||
|
# ("Subdir2/Whatever", Example())
|
||||||
|
lst_interfaces = [
|
||||||
|
InterfacePiControl(self.picontrol_device, self.config_rsc),
|
||||||
|
InterfaceRevpiConfig(),
|
||||||
|
]
|
||||||
|
|
||||||
|
try:
|
||||||
self._bus.publish(
|
self._bus.publish(
|
||||||
REVPI_DBUS_NAME,
|
REVPI_DBUS_NAME,
|
||||||
InterfacePiControl(),
|
*lst_interfaces,
|
||||||
)
|
)
|
||||||
|
except Exception as e:
|
||||||
|
log.error(f"can not publish dbus {REVPI_DBUS_NAME}: {e}")
|
||||||
|
|
||||||
|
try:
|
||||||
self._loop.run()
|
self._loop.run()
|
||||||
|
except Exception as e:
|
||||||
|
log.error(f"can not run dbus mainloop: {e}")
|
||||||
|
|
||||||
|
# Clean up all interfaces
|
||||||
|
for interface in lst_interfaces:
|
||||||
|
if type(interface) is tuple:
|
||||||
|
_, interface = interface
|
||||||
|
interface.cleanup()
|
||||||
|
|
||||||
log.debug("leave BusProvider.run")
|
log.debug("leave BusProvider.run")
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
log.debug("enter BusProvider.stop")
|
log.debug("enter BusProvider.stop")
|
||||||
self._loop.quit()
|
self._loop.quit()
|
||||||
log.debug("leave BusProvider.stop")
|
log.debug("leave BusProvider.stop")
|
||||||
|
|
||||||
|
@property
|
||||||
|
def running(self):
|
||||||
|
return self._loop.is_running()
|
||||||
|
|||||||
78
src/revpi_middleware/dbus_middleware1/dbus_helper.py
Normal file
78
src/revpi_middleware/dbus_middleware1/dbus_helper.py
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
"""Helper for dbus."""
|
||||||
|
|
||||||
|
from logging import getLogger
|
||||||
|
|
||||||
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
REVPI_DBUS_NAME = "com.revolutionpi.middleware1"
|
||||||
|
REVPI_DBUS_BASE_PATH = "/com/revolutionpi/middleware1"
|
||||||
|
|
||||||
|
|
||||||
|
class DbusInterface:
|
||||||
|
|
||||||
|
def cleanup(self):
|
||||||
|
"""
|
||||||
|
Represents a method responsible for performing cleanup operations. This method is executed to properly
|
||||||
|
release resources, close connections, or perform other necessary finalization tasks.
|
||||||
|
|
||||||
|
This method does not take any arguments or return a value.
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def extend_interface(*args) -> str:
|
||||||
|
"""
|
||||||
|
Extends an interface name by appending additional segments to a pre-defined base name.
|
||||||
|
|
||||||
|
This function takes multiple arguments, concatenates them with a predefined base
|
||||||
|
interface name, and returns the resulting string, effectively constructing an
|
||||||
|
extended interface name.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
*args: str
|
||||||
|
Components to be appended to the base interface name.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
str
|
||||||
|
Fully constructed interface name by joining the base interface name with
|
||||||
|
the provided segments.
|
||||||
|
"""
|
||||||
|
return ".".join([REVPI_DBUS_NAME, *args])
|
||||||
|
|
||||||
|
|
||||||
|
def grep(pattern, filename):
|
||||||
|
"""
|
||||||
|
Searches for lines in a file that contain a given pattern and returns them as a list.
|
||||||
|
|
||||||
|
The function reads lines from the specified file and checks whether each line
|
||||||
|
contains the provided pattern. It returns a list of lines that match the
|
||||||
|
pattern. If the file is not found, an empty list is returned. Any other
|
||||||
|
exceptions during the file reading process are caught and logged.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
pattern (str): The substring to search for within the file's lines.
|
||||||
|
filename (str): The path to the file that will be searched.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list[str]: A list containing lines that include the provided pattern, with
|
||||||
|
leading and trailing spaces removed.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
FileNotFoundError: This error is caught if the file specified is not
|
||||||
|
found.
|
||||||
|
Exception: Any unforeseen exception during file operations is caught and
|
||||||
|
logged.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with open(filename, "r") as file:
|
||||||
|
# Gibt alle Zeilen zurück, die das Muster enthalten
|
||||||
|
matching_lines = [line.strip() for line in file if pattern in line]
|
||||||
|
return matching_lines
|
||||||
|
except FileNotFoundError:
|
||||||
|
return []
|
||||||
|
except Exception as e:
|
||||||
|
log.error(f"Error reading file: {e}")
|
||||||
|
return []
|
||||||
@@ -2,21 +2,20 @@
|
|||||||
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
"""D-Bus interfaces for piControl."""
|
"""D-Bus interfaces for piControl."""
|
||||||
import os
|
|
||||||
from fcntl import ioctl
|
|
||||||
from logging import getLogger
|
from logging import getLogger
|
||||||
|
|
||||||
from pydbus.generic import signal
|
from pydbus.generic import signal
|
||||||
|
|
||||||
from ..interface_helper import ResetDriverWatchdog
|
from .process_image_helper import PiControlIoctl, ResetDriverWatchdog
|
||||||
|
from ..dbus_helper import DbusInterface
|
||||||
|
|
||||||
log = getLogger(__name__)
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class InterfacePiControl:
|
class InterfacePiControl(DbusInterface):
|
||||||
"""
|
"""
|
||||||
<node>
|
<node>
|
||||||
<interface name='com.revolutionpi.middleware1.picontrol'>
|
<interface name='com.revolutionpi.middleware1.PiControl'>
|
||||||
<signal name="NotifyDriverReset">
|
<signal name="NotifyDriverReset">
|
||||||
</signal>
|
</signal>
|
||||||
<method name='ResetDriver'>
|
<method name='ResetDriver'>
|
||||||
@@ -27,12 +26,16 @@ class InterfacePiControl:
|
|||||||
|
|
||||||
NotifyDriverReset = signal()
|
NotifyDriverReset = signal()
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self, picontrol_device: str, config_rsc: str):
|
||||||
self.pi_control = "/dev/piControl0"
|
self.picontrol_device = picontrol_device
|
||||||
|
self.config_rsc = config_rsc
|
||||||
|
|
||||||
self.wd_reset_driver = ResetDriverWatchdog(self.pi_control)
|
self.wd_reset_driver = ResetDriverWatchdog(self.picontrol_device)
|
||||||
self.wd_reset_driver.register_call(self.notify_reset_driver)
|
self.wd_reset_driver.register_call(self.notify_reset_driver)
|
||||||
|
|
||||||
|
def cleanup(self):
|
||||||
|
self.wd_reset_driver.stop()
|
||||||
|
|
||||||
def notify_reset_driver(self):
|
def notify_reset_driver(self):
|
||||||
self.NotifyDriverReset()
|
self.NotifyDriverReset()
|
||||||
|
|
||||||
@@ -40,21 +43,9 @@ class InterfacePiControl:
|
|||||||
log.debug("enter InterfacePiControl.ResetDriver")
|
log.debug("enter InterfacePiControl.ResetDriver")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
fd = os.open(self.pi_control, os.O_WRONLY)
|
picontrol_ioctl = PiControlIoctl(self.picontrol_device)
|
||||||
except Exception as e:
|
picontrol_ioctl.ioctl(PiControlIoctl.IOCTL_RESET_DRIVER)
|
||||||
log.warning(f"could not open ${self.pi_control} to reset driver")
|
|
||||||
raise e
|
|
||||||
|
|
||||||
execption = None
|
|
||||||
try:
|
|
||||||
# KB_RESET _IO('K', 12 ) // reset the piControl driver including the config file
|
|
||||||
ioctl(fd, 19212)
|
|
||||||
log.info("reset piControl driver")
|
log.info("reset piControl driver")
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
log.warning(f"could not reset piControl driver: ${e}")
|
log.warning(f"could not reset piControl driver: ${e}")
|
||||||
execption = e
|
raise e
|
||||||
finally:
|
|
||||||
os.close(fd)
|
|
||||||
|
|
||||||
if execption:
|
|
||||||
raise execption
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# SPDX-FileCopyrightText: 2020-2023 Sven Sager
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
# SPDX-License-Identifier: GPL-2.0-or-later
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
"""
|
"""
|
||||||
Helper for the process image.
|
Helper for the process image.
|
||||||
@@ -7,8 +7,8 @@ Helper for the process image.
|
|||||||
The ResetDriverWatchdog class is a copy of revpipyload project module "watchdogs"
|
The ResetDriverWatchdog class is a copy of revpipyload project module "watchdogs"
|
||||||
https://github.com/naruxde/revpipyload/blob/b51c2b617a57cc7d96fd67e1da9f090a0624eacb/src/revpipyload/watchdogs.py
|
https://github.com/naruxde/revpipyload/blob/b51c2b617a57cc7d96fd67e1da9f090a0624eacb/src/revpipyload/watchdogs.py
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
from ctypes import c_int
|
||||||
from fcntl import ioctl
|
from fcntl import ioctl
|
||||||
from logging import getLogger
|
from logging import getLogger
|
||||||
from threading import Thread
|
from threading import Thread
|
||||||
@@ -19,9 +19,9 @@ log = getLogger(__name__)
|
|||||||
class ResetDriverWatchdog(Thread):
|
class ResetDriverWatchdog(Thread):
|
||||||
"""Watchdog to catch the reset_driver action."""
|
"""Watchdog to catch the reset_driver action."""
|
||||||
|
|
||||||
def __init__(self, pi_control_device="/dev/piControl0"):
|
def __init__(self, picontrol_device: str):
|
||||||
super(ResetDriverWatchdog, self).__init__()
|
super(ResetDriverWatchdog, self).__init__()
|
||||||
self.procimg = pi_control_device
|
self.procimg = picontrol_device
|
||||||
self.daemon = True
|
self.daemon = True
|
||||||
self._calls = []
|
self._calls = []
|
||||||
self._exit = False
|
self._exit = False
|
||||||
@@ -51,7 +51,7 @@ class ResetDriverWatchdog(Thread):
|
|||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
# The ioctl will return 2 byte (c-type int)
|
# The ioctl will return 2 bytes (c-type int)
|
||||||
byte_buff = bytearray(2)
|
byte_buff = bytearray(2)
|
||||||
while not self._exit:
|
while not self._exit:
|
||||||
try:
|
try:
|
||||||
@@ -73,7 +73,7 @@ class ResetDriverWatchdog(Thread):
|
|||||||
def register_call(self, function):
|
def register_call(self, function):
|
||||||
"""Register a function, if watchdog triggers."""
|
"""Register a function, if watchdog triggers."""
|
||||||
if not callable(function):
|
if not callable(function):
|
||||||
return ValueError("Function is not callable.")
|
raise ValueError("Function is not callable.")
|
||||||
if function not in self._calls:
|
if function not in self._calls:
|
||||||
self._calls.append(function)
|
self._calls.append(function)
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ class ResetDriverWatchdog(Thread):
|
|||||||
log.debug("leave ResetDriverWatchdog.stop()")
|
log.debug("leave ResetDriverWatchdog.stop()")
|
||||||
|
|
||||||
def unregister_call(self, function=None):
|
def unregister_call(self, function=None):
|
||||||
"""Remove a function call on watchdog trigger."""
|
"""Remove a function from the watchdog trigger."""
|
||||||
if function is None:
|
if function is None:
|
||||||
self._calls.clear()
|
self._calls.clear()
|
||||||
elif function in self._calls:
|
elif function in self._calls:
|
||||||
@@ -101,3 +101,24 @@ class ResetDriverWatchdog(Thread):
|
|||||||
rc = self._triggered
|
rc = self._triggered
|
||||||
self._triggered = False
|
self._triggered = False
|
||||||
return rc
|
return rc
|
||||||
|
|
||||||
|
|
||||||
|
class PiControlIoctl:
|
||||||
|
IOCTL_RESET_DRIVER = 19212
|
||||||
|
|
||||||
|
def __init__(self, picontrol_device: str):
|
||||||
|
self.picontrol_device = picontrol_device
|
||||||
|
|
||||||
|
def ioctl(self, request, arg=0):
|
||||||
|
if type(arg) is c_int:
|
||||||
|
arg = arg.value
|
||||||
|
|
||||||
|
_fd = os.open(self.picontrol_device, os.O_WRONLY)
|
||||||
|
return_value = ioctl(_fd, 19212, arg)
|
||||||
|
os.close(_fd)
|
||||||
|
|
||||||
|
return return_value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def name(self):
|
||||||
|
return self.picontrol_device
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
"""D-Bus interfaces for system configuration."""
|
||||||
|
from .interface_config import InterfaceRevpiConfig
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
"""D-Bus interfaces for hardware configuration."""
|
||||||
|
from collections import namedtuple
|
||||||
|
from logging import getLogger
|
||||||
|
|
||||||
|
from .revpi_config import (
|
||||||
|
ConfigActions,
|
||||||
|
configure_avahi_daemon,
|
||||||
|
configure_bluetooth,
|
||||||
|
configure_con_can,
|
||||||
|
configure_dphys_swapfile,
|
||||||
|
configure_external_antenna,
|
||||||
|
configure_gui,
|
||||||
|
configure_wlan,
|
||||||
|
simple_systemd,
|
||||||
|
)
|
||||||
|
from ..dbus_helper import DbusInterface
|
||||||
|
|
||||||
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
FeatureFunction = namedtuple("FeatureFunction", ["function", "args"])
|
||||||
|
|
||||||
|
|
||||||
|
class InterfaceRevpiConfig(DbusInterface):
|
||||||
|
"""
|
||||||
|
<node>
|
||||||
|
<interface name="com.revolutionpi.middleware1.RevpiConfig">
|
||||||
|
<method name="Disable">
|
||||||
|
<arg name="feature" type="s" direction="in"/>
|
||||||
|
</method>
|
||||||
|
<method name="Enable">
|
||||||
|
<arg name="feature" type="s" direction="in"/>
|
||||||
|
</method>
|
||||||
|
<method name="GetStatus">
|
||||||
|
<arg name="feature" type="s" direction="in"/>
|
||||||
|
<arg name="status" type="b" direction="out"/>
|
||||||
|
</method>
|
||||||
|
<method name="GetAvailability">
|
||||||
|
<arg name="feature" type="s" direction="in"/>
|
||||||
|
<arg name="available" type="b" direction="out"/>
|
||||||
|
</method>
|
||||||
|
<property name="available_features" type="as" access="read"/>
|
||||||
|
</interface>
|
||||||
|
</node>
|
||||||
|
"""
|
||||||
|
|
||||||
|
def Disable(self, feature: str) -> None:
|
||||||
|
"""Disable the feature."""
|
||||||
|
feature_function = get_feature(feature)
|
||||||
|
feature_function.function(ConfigActions.DISABLE, *feature_function.args)
|
||||||
|
|
||||||
|
def Enable(self, feature: str) -> None:
|
||||||
|
"""Enable the feature."""
|
||||||
|
feature_function = get_feature(feature)
|
||||||
|
feature_function.function(ConfigActions.ENABLE, *feature_function.args)
|
||||||
|
|
||||||
|
def GetStatus(self, feature: str) -> bool:
|
||||||
|
"""Get feature status."""
|
||||||
|
feature_function = get_feature(feature)
|
||||||
|
return feature_function.function(ConfigActions.STATUS, *feature_function.args)
|
||||||
|
|
||||||
|
def GetAvailability(self, feature: str) -> bool:
|
||||||
|
"""Get feature availability on the RevPi."""
|
||||||
|
feature_function = get_feature(feature)
|
||||||
|
return feature_function.function(ConfigActions.AVAILABLE, *feature_function.args)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def available_features(self) -> list[str]:
|
||||||
|
return list(AVAILABLE_FEATURES.keys())
|
||||||
|
|
||||||
|
|
||||||
|
def get_feature(feature: str) -> FeatureFunction:
|
||||||
|
if feature not in AVAILABLE_FEATURES:
|
||||||
|
raise ValueError(f"feature {feature} does not exist")
|
||||||
|
feature_function = AVAILABLE_FEATURES[feature]
|
||||||
|
if not feature_function:
|
||||||
|
raise NotImplementedError(f"feature {feature} is not implemented")
|
||||||
|
return feature_function
|
||||||
|
|
||||||
|
|
||||||
|
AVAILABLE_FEATURES = {
|
||||||
|
"gui": FeatureFunction(configure_gui, []),
|
||||||
|
"revpi-con-can": FeatureFunction(configure_con_can, []),
|
||||||
|
"dphys-swapfile": FeatureFunction(configure_dphys_swapfile, []),
|
||||||
|
"pimodbus-master": FeatureFunction(simple_systemd, ["pimodbus-master.service"]),
|
||||||
|
"pimodbus-slave": FeatureFunction(simple_systemd, ["pimodbus-slave.service"]),
|
||||||
|
"systemd-timesyncd": FeatureFunction(simple_systemd, ["systemd-timesyncd.service"]),
|
||||||
|
"ssh": FeatureFunction(simple_systemd, ["ssh.service"]),
|
||||||
|
"nodered": FeatureFunction(simple_systemd, ["nodered.service"]),
|
||||||
|
"noderedrevpinodes-server": FeatureFunction(
|
||||||
|
simple_systemd, ["noderedrevpinodes-server.service"]
|
||||||
|
),
|
||||||
|
"revpipyload": FeatureFunction(simple_systemd, ["revpipyload.service"]),
|
||||||
|
"bluetooth": FeatureFunction(configure_bluetooth, []),
|
||||||
|
"wlan": FeatureFunction(configure_wlan, []),
|
||||||
|
"avahi": FeatureFunction(configure_avahi_daemon, []),
|
||||||
|
"external-antenna": FeatureFunction(configure_external_antenna, []),
|
||||||
|
}
|
||||||
@@ -0,0 +1,712 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
from collections import namedtuple
|
||||||
|
from enum import Enum, IntEnum
|
||||||
|
from glob import glob
|
||||||
|
from logging import getLogger
|
||||||
|
from os import X_OK, access
|
||||||
|
from os.path import exists, join
|
||||||
|
from typing import List, Optional
|
||||||
|
|
||||||
|
from pydbus import SystemBus
|
||||||
|
|
||||||
|
from ..dbus_helper import grep
|
||||||
|
|
||||||
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
ConfigVariable = namedtuple("ConfigVariable", ["name", "value", "line_index"])
|
||||||
|
|
||||||
|
LINUX_BT_CLASS_PATH = "/sys/class/bluetooth"
|
||||||
|
LINUX_WLAN_CLASS_PATH = "/sys/class/ieee80211"
|
||||||
|
CONFIG_TXT_LOCATIONS = ("/boot/firmware/config.txt", "/boot/config.txt")
|
||||||
|
|
||||||
|
|
||||||
|
class ComputeModuleTypes(IntEnum):
|
||||||
|
"""
|
||||||
|
Enumeration class to represent compute module types.
|
||||||
|
|
||||||
|
This class is an enumeration that defines various types of compute
|
||||||
|
modules and assigns them associated integer values for identifying
|
||||||
|
different module types.
|
||||||
|
|
||||||
|
Attributes:
|
||||||
|
UNKNOWN (int): Represents an unknown or undefined compute module type.
|
||||||
|
CM1 (int): Represents a Compute Module 1.
|
||||||
|
CM3 (int): Represents a Compute Module 3.
|
||||||
|
CM4 (int): Represents a Compute Module 4.
|
||||||
|
CM4S (int): Represents a Compute Module 4S.
|
||||||
|
CM5 (int): Represents a Compute Module 5.
|
||||||
|
"""
|
||||||
|
UNKNOWN = 0
|
||||||
|
CM1 = 6
|
||||||
|
CM3 = 10
|
||||||
|
CM4 = 20
|
||||||
|
CM4S = 21
|
||||||
|
CM5 = 24
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigActions(Enum):
|
||||||
|
"""
|
||||||
|
Enumeration class for defining configuration actions.
|
||||||
|
|
||||||
|
This enumeration provides predefined constants for common configuration
|
||||||
|
actions. It can be used to ensure consistency when working with or defining
|
||||||
|
such actions in a system.
|
||||||
|
"""
|
||||||
|
ENABLE = "enable"
|
||||||
|
DISABLE = "disable"
|
||||||
|
STATUS = "status"
|
||||||
|
AVAILABLE = "available"
|
||||||
|
|
||||||
|
|
||||||
|
class RevPiConfig:
|
||||||
|
"""
|
||||||
|
Represents the configuration and hardware details of a Revolution Pi system.
|
||||||
|
|
||||||
|
This class provides methods and properties to initialize and fetch
|
||||||
|
information related to the Revolution Pi device, such as model, serial
|
||||||
|
number, compute module type, WLAN capability, and the presence of a
|
||||||
|
connection bridge. The class works by parsing system-level files (e.g.,
|
||||||
|
`/proc/cpuinfo`) and using this data to identify hardware characteristics
|
||||||
|
and features.
|
||||||
|
|
||||||
|
Attributes:
|
||||||
|
serial (str): The serial number of the Revolution Pi device.
|
||||||
|
model (str): The model name of the Revolution Pi device.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._cm_type = ComputeModuleTypes.UNKNOWN
|
||||||
|
|
||||||
|
self._revpi_with_con_bridge = False
|
||||||
|
self._wlan_class_path = ""
|
||||||
|
|
||||||
|
self.serial = ""
|
||||||
|
self.model = ""
|
||||||
|
|
||||||
|
self._init_device_info()
|
||||||
|
|
||||||
|
def _init_device_info(self):
|
||||||
|
"""
|
||||||
|
Initialize and retrieve detailed hardware information, including CPU details,
|
||||||
|
device type, WLAN interface, and connectivity features.
|
||||||
|
|
||||||
|
This method gathers information from system files and other sources to
|
||||||
|
initialize device-specific attributes such as model, serial number,
|
||||||
|
compute module type, and optional features like integrated WLAN
|
||||||
|
or ConBridge support. It performs checks specific to the detected
|
||||||
|
module type to accurately populate necessary device details.
|
||||||
|
|
||||||
|
Attributes
|
||||||
|
----------
|
||||||
|
model : str
|
||||||
|
The model of the CPU based on information from /proc/cpuinfo.
|
||||||
|
serial : str
|
||||||
|
The serial number extracted from /proc/cpuinfo.
|
||||||
|
_cm_type : ComputeModuleTypes, optional
|
||||||
|
The type of the compute module derived from the hardware revision value.
|
||||||
|
_wlan_class_path : str, optional
|
||||||
|
Filesystem path to the detected WLAN interface, if any.
|
||||||
|
_revpi_with_con_bridge : bool
|
||||||
|
Indicates whether the device supports the ConBridge feature.
|
||||||
|
"""
|
||||||
|
dc_cpuinfo = {}
|
||||||
|
|
||||||
|
# Extract CPU information
|
||||||
|
with open("/proc/cpuinfo", "r") as f:
|
||||||
|
line = "\n"
|
||||||
|
while line:
|
||||||
|
line = f.readline()
|
||||||
|
if line.startswith(("Revision", "Serial", "Model")):
|
||||||
|
key, value = line.split(":", 1)
|
||||||
|
key = key.strip().lower()
|
||||||
|
value = value.strip()
|
||||||
|
dc_cpuinfo[key] = value
|
||||||
|
|
||||||
|
self.model = dc_cpuinfo.get("model", "")
|
||||||
|
self.serial = dc_cpuinfo.get("serial", "")
|
||||||
|
|
||||||
|
# Detect Compute Module type
|
||||||
|
revision = dc_cpuinfo.get("revision", "")
|
||||||
|
if revision:
|
||||||
|
revision = int(revision, 16)
|
||||||
|
mask = 4080 # 0xFF0 in dezimal
|
||||||
|
try:
|
||||||
|
self._cm_type = ComputeModuleTypes((revision & mask) >> 4)
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Detect WLAN on CM module
|
||||||
|
could_have_wlan = self._cm_type in (ComputeModuleTypes.CM4, ComputeModuleTypes.CM5)
|
||||||
|
if could_have_wlan:
|
||||||
|
wlan_interface = join(LINUX_WLAN_CLASS_PATH, "phy0")
|
||||||
|
if grep("DRIVER=brcmfmac", join(wlan_interface, "device", "uevent")):
|
||||||
|
self._wlan_class_path = wlan_interface
|
||||||
|
|
||||||
|
# If no build in WLAN on the CM, detect third party WLAN on RevPi Flat
|
||||||
|
if not self._wlan_class_path and grep("revpi-flat", "/proc/device-tree/compatible"):
|
||||||
|
lst_wlan_interfaces = glob("/sys/class/ieee80211/*")
|
||||||
|
for wlan_interface in lst_wlan_interfaces:
|
||||||
|
if grep("DRIVER=mwifiex_sdio", join(wlan_interface, "device", "uevent")):
|
||||||
|
self._wlan_class_path = wlan_interface
|
||||||
|
|
||||||
|
# Detect ConBridge
|
||||||
|
could_have_con_bridge = self._cm_type in (ComputeModuleTypes.CM3, ComputeModuleTypes.CM4S)
|
||||||
|
if could_have_con_bridge:
|
||||||
|
lst_grep = grep("kunbus,revpi-connect", "/proc/device-tree/compatible")
|
||||||
|
self._revpi_with_con_bridge = len(lst_grep) > 0
|
||||||
|
|
||||||
|
@property
|
||||||
|
def class_path_wlan(self) -> str:
|
||||||
|
"""
|
||||||
|
Provides access to the WLAN class path.
|
||||||
|
|
||||||
|
This property retrieves the stored WLAN class path, allowing the user to access it when
|
||||||
|
needed.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
str: The WLAN class path.
|
||||||
|
"""
|
||||||
|
return self._wlan_class_path
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cm_type(self) -> ComputeModuleTypes:
|
||||||
|
"""
|
||||||
|
Gets the type of the compute module.
|
||||||
|
|
||||||
|
The property provides access to the type of the compute
|
||||||
|
module used. The type is represented as an instance of
|
||||||
|
the `ComputeModuleTypes` class.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
ComputeModuleTypes
|
||||||
|
The type of the compute module.
|
||||||
|
"""
|
||||||
|
return self._cm_type
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_con_bridge(self) -> bool:
|
||||||
|
"""
|
||||||
|
Indicates if the device is configured with a connection bridge.
|
||||||
|
|
||||||
|
This property checks the internal status and determines whether the device setup
|
||||||
|
includes a connection bridge functionality. It is read-only.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if the connection bridge is configured, False otherwise.
|
||||||
|
"""
|
||||||
|
return self._revpi_with_con_bridge
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_wlan(self) -> bool:
|
||||||
|
"""
|
||||||
|
Checks if WLAN is available.
|
||||||
|
|
||||||
|
This property evaluates whether WLAN is enabled or available by checking
|
||||||
|
the presence or value of the internal attribute `_wlan_class_path`.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if WLAN is available, False otherwise.
|
||||||
|
"""
|
||||||
|
return bool(self._wlan_class_path)
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigTxt:
|
||||||
|
"""
|
||||||
|
Configuration file handler for managing 'config.txt'.
|
||||||
|
|
||||||
|
This class provides an interface to read, modify, save, and reload
|
||||||
|
Raspbian's configuration file `config.txt`. It includes functionalities
|
||||||
|
to manipulate specific parameters within the configuration and supports
|
||||||
|
managing dtoverlay and dtparam entries. The primary aim of this class
|
||||||
|
is to abstract file operations and make modifications user-friendly.
|
||||||
|
|
||||||
|
Attributes:
|
||||||
|
_config_txt_path (str): The path to the configuration file `config.txt`.
|
||||||
|
_config_txt_lines (list[str]): Contains all lines of the configuration
|
||||||
|
file as a list of strings, where each string represents a line.
|
||||||
|
"""
|
||||||
|
re_name_value = re.compile(r"^\s*(?!#)(?P<name>[^=\s].+?)\s*=\s*(?P<value>\S+)\s*$")
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._config_txt_path = ""
|
||||||
|
for path in CONFIG_TXT_LOCATIONS:
|
||||||
|
if exists(path):
|
||||||
|
self._config_txt_path = path
|
||||||
|
break
|
||||||
|
|
||||||
|
if not self._config_txt_path:
|
||||||
|
raise FileNotFoundError("no config.txt found")
|
||||||
|
|
||||||
|
self._config_txt_lines = []
|
||||||
|
|
||||||
|
def _clear_name_values(self, name: str, values: str or list) -> int:
|
||||||
|
"""
|
||||||
|
Removes all occurrences of specified name-value pairs from the configuration.
|
||||||
|
|
||||||
|
This method searches for all name-value pairs in the configuration and
|
||||||
|
removes those that match the given name and value(s). It returns the
|
||||||
|
number of occurrences removed.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
name: str
|
||||||
|
The name of the configuration variable to search for.
|
||||||
|
values: str or list
|
||||||
|
The value or list of values to match the configuration variable
|
||||||
|
against.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The number of name-value pairs removed from the configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
counter = 0
|
||||||
|
if type(values) is str:
|
||||||
|
values = [values]
|
||||||
|
|
||||||
|
for config_var in self._get_all_name_values():
|
||||||
|
if config_var.name == name and config_var.value in values:
|
||||||
|
self._config_txt_lines.pop(config_var.line_index)
|
||||||
|
counter += 1
|
||||||
|
|
||||||
|
return counter
|
||||||
|
|
||||||
|
def _get_all_name_values(self) -> List[ConfigVariable]:
|
||||||
|
"""
|
||||||
|
Retrieves all name-value pairs from the configuration text lines.
|
||||||
|
|
||||||
|
This method parses the configuration text lines to extract all name-value
|
||||||
|
pairs. If the configuration text lines are not loaded, it reloads the
|
||||||
|
configuration before processing. Each extracted name-value pair is added to a
|
||||||
|
list as a ConfigVariable object, which also holds the index of the match in
|
||||||
|
the text lines. The method returns the compiled list of these ConfigVariable
|
||||||
|
objects.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List[ConfigVariable]: A list of ConfigVariable objects representing the
|
||||||
|
name-value pairs found in the configuration text lines, along with their
|
||||||
|
corresponding indexes.
|
||||||
|
"""
|
||||||
|
if not self._config_txt_lines:
|
||||||
|
self.reload_config()
|
||||||
|
|
||||||
|
lst_return = []
|
||||||
|
|
||||||
|
for i in range(len(self._config_txt_lines)):
|
||||||
|
match = self.re_name_value.match(self._config_txt_lines[i])
|
||||||
|
if match:
|
||||||
|
lst_return.append(ConfigVariable(match.group("name"), match.group("value"), i))
|
||||||
|
|
||||||
|
return lst_return
|
||||||
|
|
||||||
|
def reload_config(self):
|
||||||
|
"""
|
||||||
|
Reloads the configuration file and updates the list of configuration lines.
|
||||||
|
|
||||||
|
This method reads the content of the configuration file specified by the
|
||||||
|
attribute `_config_txt_path` and updates `_config_txt_lines` with the file
|
||||||
|
contents as a list of strings, where each string represents a line.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
"""
|
||||||
|
with open(self._config_txt_path, "r") as f:
|
||||||
|
self._config_txt_lines = f.readlines()
|
||||||
|
|
||||||
|
def save_config(self):
|
||||||
|
"""
|
||||||
|
Saves the current configuration to a file. The method ensures atomicity by first writing
|
||||||
|
to a temporary file and then moving it to the desired path. After the configuration is
|
||||||
|
saved, the internal list of configuration lines is cleared.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
OSError: If there is an issue writing to or moving the file.
|
||||||
|
"""
|
||||||
|
if not self._config_txt_lines:
|
||||||
|
return
|
||||||
|
|
||||||
|
tmp_path = f"{self._config_txt_path}.tmp"
|
||||||
|
with open(tmp_path, "w") as f:
|
||||||
|
f.writelines(self._config_txt_lines)
|
||||||
|
shutil.move(tmp_path, self._config_txt_path)
|
||||||
|
|
||||||
|
self._config_txt_lines.clear()
|
||||||
|
|
||||||
|
def add_name_value(self, name: str, value: str):
|
||||||
|
"""
|
||||||
|
Adds a name-value pair to the configuration if it does not already exist.
|
||||||
|
|
||||||
|
This method checks if the given name-value pair is already present in
|
||||||
|
the configuration. If it is not present, the pair is appended to the
|
||||||
|
configuration text lines.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
name (str): The name to be added to the configuration.
|
||||||
|
value (str): The value corresponding to the name to be added.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
"""
|
||||||
|
# Check weather name and value already exists
|
||||||
|
for config_var in self._get_all_name_values():
|
||||||
|
if config_var.name == name and config_var.value == value:
|
||||||
|
return
|
||||||
|
|
||||||
|
self._config_txt_lines.append(f"{name}={value}\n")
|
||||||
|
|
||||||
|
def clear_dtoverlays(self, dtoverlays: str or list) -> int:
|
||||||
|
"""
|
||||||
|
Clears the specified device tree overlays. This method removes one or more
|
||||||
|
device tree overlays by clearing their corresponding name-value pairs.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
dtoverlays (str or list): A device tree overlay name as a string, or a
|
||||||
|
list of such overlay names to be cleared.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The number of device tree overlay name-value pairs successfully
|
||||||
|
cleared.
|
||||||
|
"""
|
||||||
|
return self._clear_name_values("dtoverlay", dtoverlays)
|
||||||
|
|
||||||
|
def clear_dtparams(self, dtparams: str or list) -> int:
|
||||||
|
"""
|
||||||
|
Clears the specified device tree parameters.
|
||||||
|
|
||||||
|
This method removes the given device tree parameters by utilizing
|
||||||
|
the underlying `_clear_name_values` function with a predefined
|
||||||
|
parameter type.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
dtparams: str or list
|
||||||
|
A string or list of strings specifying the device tree
|
||||||
|
parameters to remove.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int
|
||||||
|
The number of parameters cleared.
|
||||||
|
"""
|
||||||
|
return self._clear_name_values("dtparam", dtparams)
|
||||||
|
|
||||||
|
def get_values(self, var_name: str) -> list:
|
||||||
|
"""
|
||||||
|
Get all values associated with a given variable name.
|
||||||
|
|
||||||
|
This method retrieves a list of values corresponding to the specified
|
||||||
|
variable name by iterating through a collection of configuration
|
||||||
|
variables. Each configuration variable is checked for a matching name,
|
||||||
|
and its value is appended to the resulting list if a match is found.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
var_name (str): The name of the variable for which values are to
|
||||||
|
be retrieved.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list: A list of values associated with the specified variable name.
|
||||||
|
"""
|
||||||
|
var_values = []
|
||||||
|
|
||||||
|
for config_var in self._get_all_name_values():
|
||||||
|
if config_var.name == var_name:
|
||||||
|
var_values.append(config_var.value)
|
||||||
|
|
||||||
|
return var_values
|
||||||
|
|
||||||
|
@property
|
||||||
|
def config_txt_path(self) -> str:
|
||||||
|
"""
|
||||||
|
Get the file path for the configuration text file.
|
||||||
|
|
||||||
|
This property provides access to the private attribute `_config_txt_path` which
|
||||||
|
stores the file path to the configuration text file.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
str
|
||||||
|
The file path to the configuration text file.
|
||||||
|
"""
|
||||||
|
return self._config_txt_path
|
||||||
|
|
||||||
|
|
||||||
|
def configure_avahi_daemon(action: ConfigActions):
|
||||||
|
return_value = simple_systemd(action, "avahi-daemon.service")
|
||||||
|
|
||||||
|
# Post actions for avahi-daemon
|
||||||
|
if action in (ConfigActions.ENABLE, ConfigActions.DISABLE):
|
||||||
|
# Apply the enable/disable action to the avahi socket AFTER the service
|
||||||
|
# unit, because a connected socket could interrupt stop
|
||||||
|
simple_systemd(action, "avahi-daemon.socket")
|
||||||
|
|
||||||
|
return return_value
|
||||||
|
|
||||||
|
|
||||||
|
def configure_bluetooth(action: ConfigActions):
|
||||||
|
hci_device = join(LINUX_BT_CLASS_PATH, "hci0")
|
||||||
|
bt_rfkill_index = get_rfkill_index(hci_device)
|
||||||
|
|
||||||
|
# If the bluetooth device is not present, the device should have been
|
||||||
|
# brought up by revpi-bluetooth's udev rules or vendor magic (devices
|
||||||
|
# based on CM4 and newer). Nothing we can do here, so treat the interface
|
||||||
|
# as disabled.
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE:
|
||||||
|
if bt_rfkill_index is not None:
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{bt_rfkill_index}/soft", "w") as f:
|
||||||
|
f.write("0")
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE:
|
||||||
|
if bt_rfkill_index is not None:
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{bt_rfkill_index}/soft", "w") as f:
|
||||||
|
f.write("1")
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
if bt_rfkill_index is None:
|
||||||
|
return False
|
||||||
|
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{bt_rfkill_index}/soft", "r") as f:
|
||||||
|
buffer = f.read().strip()
|
||||||
|
return buffer == "0"
|
||||||
|
|
||||||
|
elif action is ConfigActions.AVAILABLE:
|
||||||
|
return bt_rfkill_index is not None
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def configure_con_can(action: ConfigActions):
|
||||||
|
revpi = RevPiConfig()
|
||||||
|
if action is ConfigActions.AVAILABLE:
|
||||||
|
return revpi.with_con_bridge
|
||||||
|
|
||||||
|
dt_overlay = "revpi-con-can"
|
||||||
|
config_txt = ConfigTxt()
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE and revpi.with_con_bridge:
|
||||||
|
config_txt.clear_dtoverlays([dt_overlay])
|
||||||
|
config_txt.add_name_value("dtoverlay", dt_overlay)
|
||||||
|
config_txt.save_config()
|
||||||
|
subprocess.call(["/usr/bin/dtoverlay", dt_overlay])
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE and revpi.with_con_bridge:
|
||||||
|
config_txt.clear_dtoverlays([dt_overlay])
|
||||||
|
config_txt.save_config()
|
||||||
|
subprocess.call(["/usr/bin/dtoverlay", "-r", dt_overlay])
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
return revpi.with_con_bridge and dt_overlay in config_txt.get_values("dtparam")
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def configure_dphys_swapfile(action: ConfigActions):
|
||||||
|
return_value = simple_systemd(action, "dphys-swapfile.service")
|
||||||
|
|
||||||
|
# Post actions for dphys-swapfile
|
||||||
|
if action is ConfigActions.DISABLE:
|
||||||
|
# Remove swapfile afer disabling the service unit
|
||||||
|
subprocess.call(
|
||||||
|
["/sbin/dphys-swapfile", "uninstall"],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
)
|
||||||
|
|
||||||
|
return return_value
|
||||||
|
|
||||||
|
|
||||||
|
def configure_external_antenna(action: ConfigActions):
|
||||||
|
revpi = RevPiConfig()
|
||||||
|
if action is ConfigActions.AVAILABLE:
|
||||||
|
return revpi.with_wlan
|
||||||
|
|
||||||
|
config_txt = ConfigTxt()
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE and revpi.with_wlan:
|
||||||
|
config_txt.clear_dtparams(["ant1", "ant2"])
|
||||||
|
config_txt.add_name_value("dtparam", "ant2")
|
||||||
|
config_txt.save_config()
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE and revpi.with_wlan:
|
||||||
|
config_txt.clear_dtparams(["ant1", "ant2"])
|
||||||
|
config_txt.save_config()
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
return revpi.with_wlan and "ant2" in config_txt.get_values("dtparam")
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def configure_gui(action: ConfigActions):
|
||||||
|
gui_available = access("/usr/bin/startx", X_OK)
|
||||||
|
|
||||||
|
if action is ConfigActions.AVAILABLE:
|
||||||
|
return gui_available
|
||||||
|
|
||||||
|
bus = SystemBus()
|
||||||
|
systemd = bus.get(
|
||||||
|
"org.freedesktop.systemd1",
|
||||||
|
"/org/freedesktop/systemd1",
|
||||||
|
)
|
||||||
|
systemd_manager = systemd["org.freedesktop.systemd1.Manager"]
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE:
|
||||||
|
systemd_manager.SetDefaultTarget("graphical.target", True)
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE:
|
||||||
|
systemd_manager.SetDefaultTarget("multi-user.target", True)
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
return systemd_manager.GetDefaultTarget() == "graphical.target"
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
|
||||||
|
def configure_wlan(action: ConfigActions):
|
||||||
|
revpi = RevPiConfig()
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE:
|
||||||
|
if revpi.with_wlan:
|
||||||
|
wlan_rfkill_index = get_rfkill_index(revpi.class_path_wlan)
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{wlan_rfkill_index}/soft", "w") as f:
|
||||||
|
f.write("0")
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE:
|
||||||
|
if revpi.with_wlan:
|
||||||
|
wlan_rfkill_index = get_rfkill_index(revpi.class_path_wlan)
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{wlan_rfkill_index}/soft", "w") as f:
|
||||||
|
f.write("1")
|
||||||
|
|
||||||
|
elif action is ConfigActions.AVAILABLE:
|
||||||
|
return revpi.with_wlan
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
if not revpi.with_wlan:
|
||||||
|
return False
|
||||||
|
|
||||||
|
wlan_rfkill_index = get_rfkill_index(revpi.class_path_wlan)
|
||||||
|
with open(f"/sys/class/rfkill/rfkill{wlan_rfkill_index}/soft", "r") as f:
|
||||||
|
buffer = f.read().strip()
|
||||||
|
return buffer == "0"
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def get_rfkill_index(device_class_path: str) -> Optional[int]:
|
||||||
|
"""
|
||||||
|
Get the rfkill index for a device under a specific device class path.
|
||||||
|
|
||||||
|
This function searches for and extracts the rfkill index associated with
|
||||||
|
devices located under the given device class path. It uses a regular
|
||||||
|
expression to identify and parse the rfkill index from the paths
|
||||||
|
of matching rfkill device files.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
device_class_path: str
|
||||||
|
The path to the device class directory where rfkill entries
|
||||||
|
are located.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Optional[int]:
|
||||||
|
The index of the rfkill device if found, otherwise None.
|
||||||
|
"""
|
||||||
|
re_rfkill_index = re.compile(r"^/.+/rfkill(?P<index>\d+)$")
|
||||||
|
for rfkill_path in glob(join(device_class_path, "rfkill*")):
|
||||||
|
match_index = re_rfkill_index.match(rfkill_path)
|
||||||
|
if match_index:
|
||||||
|
return int(match_index.group("index"))
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def simple_systemd(action: ConfigActions, unit: str):
|
||||||
|
"""
|
||||||
|
Performs specified actions on systemd units.
|
||||||
|
|
||||||
|
This function allows interaction with systemd units for various operations
|
||||||
|
such as enabling, disabling, checking the status, and verifying availability.
|
||||||
|
It communicates with the systemd manager via the SystemBus and handles units
|
||||||
|
based on the action specified.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
action (ConfigActions): Specifies the action to be performed on the
|
||||||
|
systemd unit. Supported actions include ENABLE,
|
||||||
|
DISABLE, STATUS, and AVAILABLE.
|
||||||
|
unit (str): The name of the systemd unit on which the action is to be
|
||||||
|
performed.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: For STATUS and AVAILABLE actions, returns True if the corresponding
|
||||||
|
criteria are met (e.g., enabled and active for STATUS, or not found
|
||||||
|
for AVAILABLE). Otherwise, returns False.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If the specified action is not supported.
|
||||||
|
"""
|
||||||
|
bus = SystemBus()
|
||||||
|
systemd = bus.get(
|
||||||
|
"org.freedesktop.systemd1",
|
||||||
|
"/org/freedesktop/systemd1",
|
||||||
|
)
|
||||||
|
systemd_manager = systemd["org.freedesktop.systemd1.Manager"]
|
||||||
|
|
||||||
|
if action is ConfigActions.ENABLE:
|
||||||
|
systemd_manager.UnmaskUnitFiles([unit], False)
|
||||||
|
systemd_manager.EnableUnitFiles([unit], False, False)
|
||||||
|
systemd_manager.StartUnit(unit, "replace")
|
||||||
|
|
||||||
|
elif action is ConfigActions.DISABLE:
|
||||||
|
systemd_manager.StopUnit(unit, "replace")
|
||||||
|
systemd_manager.DisableUnitFiles([unit], False)
|
||||||
|
|
||||||
|
elif action is ConfigActions.STATUS:
|
||||||
|
try:
|
||||||
|
unit_path = systemd_manager.LoadUnit(unit)
|
||||||
|
properties = bus.get("org.freedesktop.systemd1", unit_path)
|
||||||
|
except Exception:
|
||||||
|
log.warning(f"could not get systemd unit {unit}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
return properties.UnitFileState == "enabled" and properties.ActiveState == "active"
|
||||||
|
|
||||||
|
elif action is ConfigActions.AVAILABLE:
|
||||||
|
try:
|
||||||
|
unit_path = systemd_manager.LoadUnit(unit)
|
||||||
|
properties = bus.get("org.freedesktop.systemd1", unit_path)
|
||||||
|
except Exception:
|
||||||
|
log.warning(f"could not get systemd unit {unit}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
return properties.LoadState != "not-found"
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ValueError(f"action {action} not supported")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
rc = RevPiConfig()
|
||||||
|
print("Model:", rc.model)
|
||||||
|
print("Serial: ", rc.serial)
|
||||||
|
print("CM Type: ", rc.cm_type.name)
|
||||||
|
print("With WLAN: ", rc.with_wlan)
|
||||||
|
if rc.with_wlan:
|
||||||
|
print(" class path: ", rc.class_path_wlan)
|
||||||
|
print(" rfkill index: ", get_rfkill_index(rc.class_path_wlan))
|
||||||
|
print("With con-bridge:", rc.with_con_bridge)
|
||||||
|
|
||||||
|
config_txt = ConfigTxt()
|
||||||
|
print("Config file: ", config_txt.config_txt_path)
|
||||||
@@ -9,7 +9,7 @@ __version__ = "1.4.0"
|
|||||||
|
|
||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
from argparse import ArgumentParser, Namespace
|
from argparse import ArgumentParser, Namespace, SUPPRESS
|
||||||
from configparser import ConfigParser
|
from configparser import ConfigParser
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
from os import R_OK, W_OK, access, environ, getpid, remove
|
from os import R_OK, W_OK, access, environ, getpid, remove
|
||||||
@@ -262,6 +262,16 @@ parser = ArgumentParser(
|
|||||||
prog=programname,
|
prog=programname,
|
||||||
description="Program description",
|
description="Program description",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Use session bus of D-Bus for local testing and development proposes (hidden)
|
||||||
|
parser.add_argument(
|
||||||
|
"--use-session-bus",
|
||||||
|
dest="use_session_bus",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
help=SUPPRESS,
|
||||||
|
)
|
||||||
|
|
||||||
parser.add_argument("--version", action="version", version=f"%(prog)s {program_version}")
|
parser.add_argument("--version", action="version", version=f"%(prog)s {program_version}")
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-f",
|
"-f",
|
||||||
|
|||||||
3
tests/__init__.py
Normal file
3
tests/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
7
tests/dbus_middleware1/__init__.py
Normal file
7
tests/dbus_middleware1/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
from os import environ
|
||||||
|
|
||||||
|
# D-BUS needs a DISPLAY variable to work with the session bus
|
||||||
|
environ["DISPLAY"] = ":0"
|
||||||
36
tests/dbus_middleware1/bus_provider.py
Normal file
36
tests/dbus_middleware1/bus_provider.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
from time import sleep
|
||||||
|
|
||||||
|
from tests.dbus_middleware1.fake_devices import PiControlDeviceMockup
|
||||||
|
|
||||||
|
|
||||||
|
class TestBusProvider(PiControlDeviceMockup):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
|
||||||
|
# Do not import things on top of the module. Some classes or functions need to be mocked up first.
|
||||||
|
from revpi_middleware.dbus_middleware1 import BusProvider
|
||||||
|
|
||||||
|
# Prepare the bus provider and start it
|
||||||
|
self.bp = BusProvider(
|
||||||
|
self.picontrol.name,
|
||||||
|
use_system_bus=False,
|
||||||
|
)
|
||||||
|
self.bp.start()
|
||||||
|
|
||||||
|
# Wait 5 seconds until the bus provider has started the main loop
|
||||||
|
counter = 50
|
||||||
|
while not self.bp.running and counter > 0:
|
||||||
|
counter -= 1
|
||||||
|
sleep(0.1)
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.bp.stop()
|
||||||
|
self.bp.join(10.0)
|
||||||
|
if self.bp.is_alive():
|
||||||
|
raise RuntimeError("Bus provider thread is still running")
|
||||||
|
|
||||||
|
super().tearDown()
|
||||||
120
tests/dbus_middleware1/fake_devices.py
Normal file
120
tests/dbus_middleware1/fake_devices.py
Normal file
@@ -0,0 +1,120 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
from ctypes import c_int
|
||||||
|
from queue import Empty, Queue
|
||||||
|
from tempfile import NamedTemporaryFile
|
||||||
|
from threading import Event, Thread
|
||||||
|
from unittest import TestCase
|
||||||
|
|
||||||
|
IOCTL_QUEUE = Queue()
|
||||||
|
RESET_DRIVER_EVENT = Event()
|
||||||
|
|
||||||
|
|
||||||
|
class FakePiControlDevice:
|
||||||
|
IOCTL_RESET_DRIVER = 19212
|
||||||
|
|
||||||
|
def __init__(self, picontrol_device: str):
|
||||||
|
self._fh = NamedTemporaryFile("wb+", 0, prefix="fake_device_")
|
||||||
|
self.name = self._fh.name
|
||||||
|
|
||||||
|
def __del__(self):
|
||||||
|
self._fh.close()
|
||||||
|
|
||||||
|
def reset_process_image(self):
|
||||||
|
self._fh.write(b"\x00" * 4096)
|
||||||
|
self._fh.seek(0)
|
||||||
|
|
||||||
|
def ioctl(self, request, arg=0) -> int:
|
||||||
|
if type(arg) is c_int:
|
||||||
|
arg = arg.value
|
||||||
|
|
||||||
|
if request == self.IOCTL_RESET_DRIVER:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
raise NotImplementedError(f"Unknown IOCTL request: {request}")
|
||||||
|
|
||||||
|
IOCTL_QUEUE.put_nowait((request, arg))
|
||||||
|
return arg
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
self._fh.close()
|
||||||
|
|
||||||
|
def read(self, size):
|
||||||
|
return self._fh.read(size)
|
||||||
|
|
||||||
|
def seek(self, offset, whence):
|
||||||
|
self._fh.seek(offset, whence)
|
||||||
|
|
||||||
|
def write(self, buffer):
|
||||||
|
return self._fh.write(buffer)
|
||||||
|
|
||||||
|
|
||||||
|
class FakeResetDriverWatchdog(Thread):
|
||||||
|
|
||||||
|
def __init__(self, picontrol_device: str):
|
||||||
|
super().__init__()
|
||||||
|
self.daemon = True
|
||||||
|
self._calls = []
|
||||||
|
self._exit = False
|
||||||
|
self.not_implemented = True
|
||||||
|
self._triggered = False
|
||||||
|
self.start()
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
while not self._exit:
|
||||||
|
if RESET_DRIVER_EVENT.wait(0.1):
|
||||||
|
RESET_DRIVER_EVENT.clear()
|
||||||
|
self._triggered = True
|
||||||
|
for func in self._calls:
|
||||||
|
func()
|
||||||
|
|
||||||
|
def register_call(self, function):
|
||||||
|
"""Register a function, if watchdog triggers."""
|
||||||
|
if not callable(function):
|
||||||
|
raise ValueError("Function is not callable.")
|
||||||
|
if function not in self._calls:
|
||||||
|
self._calls.append(function)
|
||||||
|
|
||||||
|
def stop(self):
|
||||||
|
"""Stop watchdog for reset_driver."""
|
||||||
|
self._exit = True
|
||||||
|
|
||||||
|
def unregister_call(self, function=None):
|
||||||
|
"""Remove a function from the watchdog trigger."""
|
||||||
|
if function is None:
|
||||||
|
self._calls.clear()
|
||||||
|
elif function in self._calls:
|
||||||
|
self._calls.remove(function)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def triggered(self):
|
||||||
|
"""Will return True one time after watchdog was triggered."""
|
||||||
|
rc = self._triggered
|
||||||
|
self._triggered = False
|
||||||
|
return rc
|
||||||
|
|
||||||
|
|
||||||
|
class PiControlDeviceMockup(TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
|
||||||
|
# Empty the queue
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
IOCTL_QUEUE.get_nowait()
|
||||||
|
except Empty:
|
||||||
|
break
|
||||||
|
|
||||||
|
# Replace classes with mockup classes
|
||||||
|
import revpi_middleware.dbus_middleware1.process_image.interface_picontrol as test_helpers
|
||||||
|
test_helpers.PiControlIoctl = FakePiControlDevice
|
||||||
|
test_helpers.ResetDriverWatchdog = FakeResetDriverWatchdog
|
||||||
|
|
||||||
|
# Create a fake picontrol0 device
|
||||||
|
self.picontrol = FakePiControlDevice(picontrol_device="/dev/fake_device_0")
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.picontrol.close()
|
||||||
|
super().tearDown()
|
||||||
3
tests/dbus_middleware1/process_image/__init__.py
Normal file
3
tests/dbus_middleware1/process_image/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# SPDX-FileCopyrightText: 2025 KUNBUS GmbH
|
||||||
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
from threading import Thread
|
||||||
|
from time import sleep
|
||||||
|
|
||||||
|
from revpi_middleware.cli_commands.dbus_helper import BusType, await_signal, simple_call
|
||||||
|
from revpi_middleware.dbus_middleware1 import extend_interface
|
||||||
|
from tests.dbus_middleware1.bus_provider import TestBusProvider
|
||||||
|
from tests.dbus_middleware1.fake_devices import IOCTL_QUEUE, RESET_DRIVER_EVENT
|
||||||
|
|
||||||
|
|
||||||
|
class TestObjectPicontrol(TestBusProvider):
|
||||||
|
|
||||||
|
def test_is_active(self):
|
||||||
|
self.assertTrue(self.bp.running)
|
||||||
|
|
||||||
|
def test_reset_driver(self):
|
||||||
|
simple_call(
|
||||||
|
"ResetDriver",
|
||||||
|
interface=extend_interface("PiControl"),
|
||||||
|
bus_type=BusType.SESSION,
|
||||||
|
)
|
||||||
|
ioctl_call = IOCTL_QUEUE.get(timeout=2.0)
|
||||||
|
self.assertEqual((19212, 0), ioctl_call)
|
||||||
|
|
||||||
|
def test_notify_reset_driver(self):
|
||||||
|
timeout = 5
|
||||||
|
|
||||||
|
def target_call_reset_driver():
|
||||||
|
sleep(1.0)
|
||||||
|
RESET_DRIVER_EVENT.set()
|
||||||
|
|
||||||
|
th_wait_for_reset = Thread(target=target_call_reset_driver, daemon=True)
|
||||||
|
th_wait_for_reset.start()
|
||||||
|
|
||||||
|
result = await_signal(
|
||||||
|
"NotifyDriverReset",
|
||||||
|
timeout,
|
||||||
|
extend_interface("PiControl"),
|
||||||
|
bus_type=BusType.SESSION,
|
||||||
|
)
|
||||||
|
self.assertTrue(result)
|
||||||
|
|
||||||
|
th_wait_for_reset.join(timeout=timeout)
|
||||||
Reference in New Issue
Block a user