Update changelog for 0.0.3-1+deb12+1 release

This command is used in the `revpi_config.py` file to load overlays.

debian/changelog

@@ -0,0 +1,77 @@
+revpi-middleware (0.0.3-1+deb12+1) bookworm; urgency=medium
+
+  * refactor: Update interface name from 'picontrol' to 'PiControl'
+  * feat(dbus): Add `grep` function to search for patterns in a file
+  * fix(cli): Change absolute imports to relative imports
+  * feat(dbus): Add D-Bus interface for system configuration in middleware
+  * feat(dbus): Add GUI configuration handling to interface_config.py
+  * feat(revpiconfig): Add RevPiConfig class for device information handling
+  * refactor(dbus): Move system configuration methods to revpi_config.py
+  * feat(dbus): Remove 'var-log.mount' feature
+  * feat(dbus): Add avahi-daemon configuration to system services
+  * feat(dbus): Add dphys-swapfile configuration functionality
+  * feat(revpiconfig): Add ConfigTxt class for managing config.txt file
+  * feat(dbus): Add support for configuring the external antenna
+  * feat(dbus): Add support for configuring 'revpi-con-can' feature
+  * feat(revpiconfig): Enhance Wi-Fi detection and add rfkill index support
+  * feat(dbus): Add Wi-Fi configuration support to the system config
+  * refactor(revpiconfig: Change Wi-Fi detection and rfkill index logic
+  * feat(dbus): Add Bluetooth configuration functionality
+  * feat(dbus): Add InterfaceRevpiConfig to DBus interfaces list
+  * feat(cli): Add `get_properties` helper function for DBus interactions
+  * feat(cli): Add CLI command for configuring Revpi features
+  * feat(cli): Add CLI support for RevPi configuration object (revpi-config)
+  * feat(revpiconfig): Replace rfkill subprocess calls with sysfs writes
+  * refactor: Rename WiFi to WLAN for consistent terminology
+  * feat(deb): Add dependencies for `dtoverlay` command
+
+ -- Sven Sager <s.sager@kunbus.com>  Mon, 21 Apr 2025 13:44:18 +0200
+
+revpi-middleware (0.0.2-1+deb12+1) bookworm; urgency=medium
+
+  * refactor(dbus): Move D-Bus helper functions to a dedicated file
+  * refactor(dbus): Move ResetDriverWatchdog to process_image_helper.py
+  * refactor(dbus): Parameterize `picontrol_device` and `config_rsc`
+  * feat: Add session bus option for local testing and development
+  * feat(dbus): Add import for BusProvider in dbus_middleware1 module
+  * feat(dbus): Add `running` property to `BusProvider`
+  * refactor(cli): D-Bus helpers support session and system bus types
+  * fix(dbus): Add error handling for DBus publishing and main loop
+  * refactor(dbus): piControl driver reset with PiControlIoctl class
+  * test(dbus): Add unit test framework for dbus_middleware1 module
+  * test(dbus): Add unit tests for PiControl D-Bus interface
+  * refactor(dbus): Fix typo and remove unused thread instance
+  * refactor(dbus): D-Bus interface management with cleanup support.
+  * test(dbus): Add support for testing driver reset notification
+  * feat(deb): Add dbus for testing to build dependencies
+  * fix(deb): Skip tests because of missing SystemBus in build container
+
+ -- Sven Sager <s.sager@kunbus.com>  Sat, 19 Apr 2025 16:34:20 +0200
+
+revpi-middleware (0.0.1-1+deb12+1) bookworm; urgency=medium
+
+  * docs: Start git project with python git-ignore and Readme
+  * docs: Use 'reuse' for SPDX Headers and Licenses
+  * feat: Add python base project files
+  * feat: Add proginit application basic module
+  * feat: Add the data directory for additional data files for the project
+  * test: Add tests directory with a dummy test
+  * build: Add all necessary files for the build system
+  * feat: Add dummy main application script
+  * feat: Add systemd file and data to integrate the app as a daemon
+  * chore: Update proginit to 1.4.0
+  * feat(dbus): Add ResetDriverWatchdog helper as global dbus helper
+  * feat(process_image): Add D-Bus interface for piControl driver
+  * feat(dbus): Add initial D-Bus middleware implementation
+  * feat(dbus): Add `extend_interface` function for dynamic interface naming
+  * feat(dbus): Add DBus policy configuration for revpi-middleware
+  * feat: Add MiddlewareDaemon implementation to revpi-middleware
+  * feat: Add daemon mode and signal handling to main application
+  * feat(cli): Add D-Bus helper functions for CLI commands.
+  * feat(cli): Add await_signal function to handle D-Bus signals
+  * feat(cli): Add `await-reset` to wait for piControl reset signal
+  * chore(build): Update requirements for this project
+  * feat(cli): Add new CLI tool entry point for `revpictl`
+  * feat(deb): Start packaging branch
+
+ -- Sven Sager <s.sager@kunbus.com>  Fri, 18 Apr 2025 19:02:20 +0200

debian/control

@@ -0,0 +1,39 @@
+Source: revpi-middleware
+Section: python
+Priority: optional
+Maintainer: KUNBUS GmbH <support@kunbus.com>
+Rules-Requires-Root: no
+Homepage: https://revolutionpi.com/
+Vcs-Browser: https://gitlab.com/revolutionpi/revpi-middleware
+Vcs-Git: https://gitlab.com/revolutionpi/revpi-middleware.git -b debian/bookworm
+Build-Depends:
+  dbus,
+  dbus-x11,
+  debhelper-compat (= 13),
+  dh-python,
+  python3-all,
+  python3-gi (>= 3.42.2),
+  python3-pydbus (>= 0.6.0),
+  python3-setuptools,
+Standards-Version: 4.6.2
+
+Package: revpi-middleware
+Architecture: all
+Pre-Depends: ${misc:Pre-Depends}
+Depends:
+  raspi-utils-dt | libraspberrypi-bin,
+  ${python3:Depends},
+  ${misc:Depends}
+Description: Revolution Pi middleware with D-Bus interface
+ The Revolution Pi middleware provides a robust communication interface for
+ Revolution Pi industrial computers. It enables seamless integration between
+ hardware components and applications through a D-Bus interface. The middleware
+ serves as a bridge for data exchange, device configuration, and system
+ monitoring.
+ .
+ Key features:
+  * Hardware abstraction layer for Revolution Pi I/O modules
+  * Real-time data processing and event handling
+  * Simplified API for accessing Revolution Pi hardware features
+  * Extensive configuration options for industrial automation tasks
+  * Built-in monitoring and diagnostic capabilities

debian/copyright

@@ -0,0 +1,27 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: https://gitlab.com/revolutionpi/opcua-revpi-server
+
+Files: *
+Copyright: 2025 KUNBUS GmbH
+License: GPL-2+
+
+Files: debian/*
+Copyright: 2025 KUNBUS GmbH
+License: GPL-2+
+
+License: GPL-2+
+ This package 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 2 of the License, or
+ (at your option) any later version.
+ .
+ This package 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/>
+ .
+ On Debian systems, the complete text of the GNU General
+ Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".

debian/gbp.conf

@@ -0,0 +1,7 @@
+[DEFAULT]
+upstream-branch = main
+upstream-tag = v%(version)s
+debian-branch=debian/bookworm
+debian-tag = debian/%(version)s
+debian-tag-msg = %(pkg)s Debian release %(version)s
+pristine-tar = True

debian/revpi-middleware.install

@@ -0,0 +1,4 @@
+data/dbus-policy/com.revolutionpi.middleware1.conf      /usr/share/dbus-1/system.d
+data/etc/default/revpi-middleware                       /etc/default/
+data/etc/revpi-middleware/revpi-middleware.conf         /etc/revpi-middleware/
+data/systemd/before_253/revpi-middleware.service        /lib/systemd/system/

debian/revpi-middleware.links

@@ -0,0 +1,2 @@
+/usr/share/revpi-middleware/revpi-middleware	/usr/sbin/revpi-middleware
+/usr/share/revpi-middleware/revpicli	/usr/bin/revpicli

debian/rules

@@ -0,0 +1,12 @@
+#!/usr/bin/make -f
+
+export PYBUILD_NAME=revpi-middleware
+export PYBUILD_INSTALL_ARGS=--install-lib=/usr/share/$(PYBUILD_NAME)/ --install-scripts=/usr/share/$(PYBUILD_NAME)/
+
+%:
+	dh $@ --with python3 --buildsystem=pybuild
+
+override_dh_auto_test:
+	# Currently, the tests have to be skipped, because no SystemBus is
+	# available in the Docker container.
+	@echo "Skipped tests"

debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

src/revpi_middleware/cli_commands/cli_base.py

@@ -29,6 +29,11 @@ def setup_command_line_arguments():
         help="RevPi PiControl object",
     )
     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:
@@ -39,6 +44,9 @@ def main() -> int:
     if obj == "picontrol":
         rc = cli_picontrol.main()
 
+    elif obj == "config":
+        rc = cli_config.main()
+
     else:
         log.error(f"Unknown object: {obj}")
         rc = 1

src/revpi_middleware/cli_commands/cli_config.py

@@ -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

src/revpi_middleware/cli_commands/dbus_helper.py

@@ -17,6 +17,18 @@ class BusType(Enum):
     SYSTEM = "system"
 
 
+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,

src/revpi_middleware/dbus_middleware1/bus_provider.py

@@ -10,6 +10,7 @@ from pydbus import SessionBus, SystemBus
 
 from . import REVPI_DBUS_NAME
 from .process_image import InterfacePiControl
+from .system_config import InterfaceRevpiConfig
 
 log = getLogger(__name__)
 
@@ -41,6 +42,7 @@ class BusProvider(Thread):
         #   ("Subdir2/Whatever", Example())
         lst_interfaces = [
             InterfacePiControl(self.picontrol_device, self.config_rsc),
+            InterfaceRevpiConfig(),
         ]
 
         try:

src/revpi_middleware/dbus_middleware1/system_config/interface_config.py

@@ -13,7 +13,7 @@ from .revpi_config import (
     configure_dphys_swapfile,
     configure_external_antenna,
     configure_gui,
-    configure_wifi,
+    configure_wlan,
     simple_systemd,
 )
 from ..dbus_helper import DbusInterface
@@ -94,7 +94,7 @@ AVAILABLE_FEATURES = {
     ),
     "revpipyload": FeatureFunction(simple_systemd, ["revpipyload.service"]),
     "bluetooth": FeatureFunction(configure_bluetooth, []),
-    "ieee80211": FeatureFunction(configure_wifi, []),
+    "wlan": FeatureFunction(configure_wlan, []),
     "avahi": FeatureFunction(configure_avahi_daemon, []),
     "external-antenna": FeatureFunction(configure_external_antenna, []),
 }

src/revpi_middleware/dbus_middleware1/system_config/revpi_config.py

@@ -21,7 +21,7 @@ log = getLogger(__name__)
 ConfigVariable = namedtuple("ConfigVariable", ["name", "value", "line_index"])
 
 LINUX_BT_CLASS_PATH = "/sys/class/bluetooth"
-LINUX_WIFI_CLASS_PATH = "/sys/class/ieee80211"
+LINUX_WLAN_CLASS_PATH = "/sys/class/ieee80211"
 CONFIG_TXT_LOCATIONS = ("/boot/firmware/config.txt", "/boot/config.txt")
 
 
@@ -81,19 +81,19 @@ class RevPiConfig:
             except ValueError:
                 pass
 
-        # Detect WiFi on CM module
-        could_have_wifi = self._cm_type in (ComputeModuleTypes.CM4, ComputeModuleTypes.CM5)
-        if could_have_wifi:
-            wifi_interface = join(LINUX_WIFI_CLASS_PATH, "phy0")
-            if grep("DRIVER=brcmfmac", join(wifi_interface, "device", "uevent")):
-                self._wlan_class_path = wifi_interface
+        # 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 Wi-Fi on the CM, detect third party Wi-Fi on RevPi Flat
+        # 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_wifi_interfaces = glob("/sys/class/ieee80211/*")
-            for wifi_interface in lst_wifi_interfaces:
-                if grep("DRIVER=mwifiex_sdio", join(wifi_interface, "device", "uevent")):
-                    self._wlan_class_path = wifi_interface
+            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)
@@ -102,7 +102,7 @@ class RevPiConfig:
             self._revpi_with_con_bridge = len(lst_grep) > 0
 
     @property
-    def class_path_wifi(self) -> str:
+    def class_path_wlan(self) -> str:
         return self._wlan_class_path
 
     @property
@@ -114,7 +114,7 @@ class RevPiConfig:
         return self._revpi_with_con_bridge
 
     @property
-    def with_wifi(self) -> bool:
+    def with_wlan(self) -> bool:
         return bool(self._wlan_class_path)
 
 
@@ -224,11 +224,13 @@ def configure_bluetooth(action: ConfigActions):
 
     if action is ConfigActions.ENABLE:
         if bt_rfkill_index is not None:
-            subprocess.call(["rfkill", "unblock", str(bt_rfkill_index)])
+            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:
-            subprocess.call(["rfkill", "block", str(bt_rfkill_index)])
+            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:
@@ -293,21 +295,21 @@ def configure_dphys_swapfile(action: ConfigActions):
 def configure_external_antenna(action: ConfigActions):
     revpi = RevPiConfig()
     if action is ConfigActions.AVAILABLE:
-        return revpi.with_wifi
+        return revpi.with_wlan
 
     config_txt = ConfigTxt()
 
-    if action is ConfigActions.ENABLE and revpi.with_wifi:
+    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_wifi:
+    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_wifi and "ant2" in config_txt.get_values("dtparam")
+        return revpi.with_wlan and "ant2" in config_txt.get_values("dtparam")
 
     else:
         raise ValueError(f"action {action} not supported")
@@ -337,28 +339,30 @@ def configure_gui(action: ConfigActions):
         raise ValueError(f"action {action} not supported")
 
 
-def configure_wifi(action: ConfigActions):
+def configure_wlan(action: ConfigActions):
     revpi = RevPiConfig()
 
     if action is ConfigActions.ENABLE:
-        if revpi.with_wifi:
-            wifi_rfkill_index = get_rfkill_index(revpi.class_path_wifi)
-            subprocess.call(["rfkill", "unblock", str(wifi_rfkill_index)])
+        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_wifi:
-            wifi_rfkill_index = get_rfkill_index(revpi.class_path_wifi)
-            subprocess.call(["rfkill", "block", str(wifi_rfkill_index)])
+        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_wifi
+        return revpi.with_wlan
 
     elif action is ConfigActions.STATUS:
-        if not revpi.with_wifi:
+        if not revpi.with_wlan:
             return False
 
-        wifi_rfkill_index = get_rfkill_index(revpi.class_path_wifi)
-        with open(f"/sys/class/rfkill/rfkill{wifi_rfkill_index}/soft", "r") as f:
+        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"
 
@@ -420,10 +424,10 @@ if __name__ == "__main__":
     print("Model:", rc.model)
     print("Serial:         ", rc.serial)
     print("CM Type:        ", rc.cm_type.name)
-    print("With wifi:      ", rc.with_wifi)
-    if rc.with_wifi:
-        print("    class path: ", rc.class_path_wifi)
-        print("  rfkill index: ", get_rfkill_index(rc.class_path_wifi))
+    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()