Refactor/recording

.github/workflows/backend.yml

@@ -19,10 +19,6 @@ jobs:
   build:
     runs-on: ubuntu-22.04
 
-    defaults:
-      run:
-        working-directory: ./backend_py
-
     steps:
       - uses: actions/checkout@v4
 
@@ -31,21 +27,37 @@ jobs:
         with:
           python-version: "3.11"
 
+      - name: Restore cached virtualenv
+        id: cache-venv-restore
+        uses: actions/cache/restore@v5
+        with:
+          key: venv-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ hashFiles('requirements.txt') }}
+          path: .venv
+
       - name: Install dependencies
+        if: steps.cache-venv-restore.outputs.cache-hit != 'true'
         run: | # TODO: switch to using proper dev dependencies
           sudo apt-get install build-essential libdbus-glib-1-dev libdbus-1-dev libpython3-dev -y # For dbus-python
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install ruff bandit ty # dev dependencies
+          ./create_venv.sh
+          source .venv/bin/activate
+          echo "$VIRTUAL_ENV/bin" >> $GITHUB_PATH
+          echo "VIRTUAL_ENV=$VIRTUAL_ENV" >> $GITHUB_ENV
+          pip install ruff bandit ty
+
+      - name: Saved cached virtualenv
+        uses: actions/cache/save@v4
+        with:
+          key: ${{ steps.cache-primes-restore.outputs.cache-primary-key }}
+          path: .venv
 
       - name: Ruff linting
-        run: ruff check --output-format=github .
+        run: ruff check --output-format=github backend_py
 
       - name: Ruff formatting
-        run: ruff format --check .
+        run: ruff format --check backend_py
 
       - name: Bandit security check (high severity)
-        run: bandit -r . -lll
+        run: bandit -r backend_py -lll
 
       - name: Type checking (ty)
-        run: ty check
+        run: ty check backend_py

.gitignore

@@ -333,6 +333,6 @@ release.tar.gz
 **/server_preferences.json
 .env
 pi-gen
-videos
+/recordings/
 
 !frontend/src/lib/

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.12
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [--fix]
+        files: ^backend_py/
+      # Run the formatter.
+      - id: ruff-format
+        files: ^backend_py/
+  # ty
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check backend_py
+        entry: ty check backend_py
+        language: system
+        types: [python]
+        files: ^backend_py/
+        pass_filenames: false

backend_py/requirements.txt

@@ -12,3 +12,4 @@ sdbus==0.14.0
 sdbus-networkmanager==2.0.0
 rtp==0.0.4
 pyserial
+colorlog==6.10.1

backend_py/run.py

@@ -4,16 +4,17 @@
 # two is hosted as a uvicorn server, which handles traffic
 
 import asyncio
+import contextlib
 import logging
+import signal
 from contextlib import asynccontextmanager
 
 import socketio
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
-from src import FeatureSupport, Server
+from backend_py.src import FeatureSupport, Server
 
-# TODO: narrow
 ORIGINS = ["*"]
 
 # Use AsyncServer
@@ -27,11 +28,8 @@
 async def lifespan(app: FastAPI):  # noqa: ANN201
     await server.serve()
     yield
-    print("Shutting down server...")
-    try:
-        server.shutdown()
-    except Exception as e:
-        print(f"Error during shutdown: {e}")
+
+    # Shutdown should go here, but it isn't always reached
 
 
 # FastAPI application
@@ -54,6 +52,7 @@ async def lifespan(app: FastAPI):  # noqa: ANN201
     FeatureSupport(ttyd=True, wifi=True, serial=True),
     sio,
     app,
+    data_dir=".",
     settings_path=".",
     log_level=logging.DEBUG,
     is_dev_mode=True,
@@ -68,7 +67,13 @@ async def lifespan(app: FastAPI):  # noqa: ANN201
 
     async def main() -> None:
         config = uvicorn.Config(app, host="0.0.0.0", port=5000, log_level="warning")
-        server = uvicorn.Server(config)
-        await server.serve()
+        uvicorn_server = uvicorn.Server(config)
+        signal.signal(signal.SIGINT, signal.SIG_IGN)
+        try:
+            await uvicorn_server.serve()
+        finally:
+            signal.signal(signal.SIGINT, signal.SIG_IGN)
+            server.shutdown()
 
-    asyncio.run(main())
+    with contextlib.suppress(KeyboardInterrupt, asyncio.CancelledError):
+        asyncio.run(main())

backend_py/src/models/__init__.py

@@ -0,0 +1,86 @@
+from .cameras import (
+    AddFollowerPayload,
+    CameraModel,
+    ControlFlagsModel,
+    ControlModel,
+    ControlTypeEnum,
+    DeviceDescriptorModel,
+    DeviceInfoModel,
+    DeviceLeaderModel,
+    DeviceModel,
+    DeviceNicknameModel,
+    DeviceOptionsModel,
+    DeviceType,
+    FormatSizeModel,
+    FrameDropStats,
+    H264Mode,
+    IntervalModel,
+    MenuItemModel,
+    StreamEncodeTypeEnum,
+    StreamEndpointModel,
+    StreamFormatModel,
+    StreamInfoModel,
+    StreamModel,
+    StreamTypeEnum,
+    UVCControlModel,
+    V4LControlTypeEnum,
+)
+from .network import (
+    ConnectionProfileModel,
+    IPV4Address,
+    IPV4Configuration,
+    IPV4Method,
+    WiredDeviceModel,
+)
+from .preferences import SavedPreferencesModel
+from .recordings import RecordingInfo
+from .saved_cameras import (
+    SavedControlModel,
+    SavedDeviceModel,
+    SavedLeaderFollowerPairModel,
+    SavedStreamModel,
+)
+
+__all__ = [
+    # Network
+    "ConnectionProfileModel",
+    "IPV4Address",
+    "IPV4Configuration",
+    "IPV4Method",
+    "WiredDeviceModel",
+    # Cameras
+    "AddFollowerPayload",
+    "CameraModel",
+    "ControlFlagsModel",
+    "ControlModel",
+    "ControlTypeEnum",
+    "DeviceDescriptorModel",
+    "DeviceInfoModel",
+    "DeviceLeaderModel",
+    "DeviceModel",
+    "DeviceNicknameModel",
+    "DeviceOptionsModel",
+    "DeviceType",
+    "FormatSizeModel",
+    "FrameDropStats",
+    "H264Mode",
+    "IntervalModel",
+    "MenuItemModel",
+    "StreamEncodeTypeEnum",
+    "StreamEndpointModel",
+    "StreamFormatModel",
+    "StreamInfoModel",
+    "StreamModel",
+    "StreamTypeEnum",
+    "UVCControlModel",
+    "V4LControlTypeEnum",
+    # Preferences
+    "SavedPreferencesModel",
+    # Saved Cameras
+    "SavedControlModel",
+    "SavedDeviceModel",
+    "SavedLeaderFollowerPairModel",
+    "SavedStreamModel",
+    # Recordings
+    "RecordingInfo",
+]

backend_py/src/services/cameras/pydantic_schemas.py → backend_py/src/models/cameras.py

@@ -1,5 +1,5 @@
 """
-pydantic_schemas.py
+cameras.py
 
 Defines Pydantic models and Enums for camera and device configs
 Includes schemas for streams, controls, device info, and API request/response strutures
@@ -102,10 +102,11 @@ class Config:
 
 
 class ControlFlagsModel(BaseModel):
+    # TODO: allow booleans, strings, etc.
     default_value: float | int
-    max_value: float | int
-    min_value: float | int
-    step: float | int
+    max_value: float | int = 0
+    min_value: float | int = 0
+    step: float | int = 0
     control_type: ControlTypeEnum = Field(...)
     menu: list[MenuItemModel] = Field(default_factory=list)
 
@@ -117,7 +118,7 @@ class ControlModel(BaseModel):
     flags: ControlFlagsModel
     control_id: int
     name: str
-    value: float | int
+    value: float | int | bool
 
     class Config:
         from_attributes = True
@@ -230,7 +231,7 @@ class Config:
 class UVCControlModel(BaseModel):
     bus_info: str
     control_id: int
-    value: float | int
+    value: float | int | bool
 
     class Config:
         from_attributes = True

backend_py/src/models/network.py

@@ -0,0 +1,40 @@
+from enum import Enum
+
+from pydantic import BaseModel
+from sdbus_async.networkmanager import (
+    DeviceState,
+)
+
+
+class IPV4Method(Enum):
+    manual = "manual"
+    auto = "auto"
+    unknown = "unknown"
+
+
+class IPV4Address(BaseModel):
+    address: str
+    prefix: int
+
+
+class IPV4Configuration(BaseModel):
+    ip_addresses: list[IPV4Address] | None = None
+    gateway: str | None = None
+    method: IPV4Method = IPV4Method.unknown
+    dns: list[str] | None = None
+    never_default: bool | None = None
+
+
+class WiredDeviceModel(BaseModel):
+    interface: str
+    state: DeviceState
+    is_active: bool
+    active_profile_id: str | None = None
+    active_ip_configuration: IPV4Configuration | None = None
+    available_profiles: list[str]
+
+
+class ConnectionProfileModel(BaseModel):
+    id: str
+    path: str
+    ipv4_settings: IPV4Configuration

backend_py/src/services/preferences/pydantic_schemas.py → backend_py/src/models/preferences.py

@@ -1,13 +1,13 @@
 """
-pydantic_schemas.py
+preferences.py
 
 Defines Pydantic models for persistent server settings
 Includes schemas for saved preferences, like default stream endpoints
 """
 
 from pydantic import BaseModel
 
-from ..cameras.pydantic_schemas import StreamEndpointModel
+from .cameras import StreamEndpointModel
 
 
 class SavedPreferencesModel(BaseModel):

backend_py/src/models/recordings.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+
+class RecordingInfo(BaseModel):
+    path: str
+    name: str
+    format: str
+    duration: str
+    size: str
+    created: str

backend_py/src/services/cameras/saved_pydantic_schemas.py → backend_py/src/models/saved_cameras.py

@@ -1,5 +1,5 @@
 """
-saved_pydantic_schemas.py
+saved_cameras.py
 
 Defines Pydantic models and Enums for persisting device settings and configs
 Includes schemas for serializing device states (streams, controls, nicknames) to JSON,
@@ -8,7 +8,7 @@
 
 from pydantic import BaseModel
 
-from .pydantic_schemas import (
+from .cameras import (
     DeviceType,
     IntervalModel,
     StreamEncodeTypeEnum,
@@ -20,7 +20,8 @@
 class SavedControlModel(BaseModel):
     control_id: int
     name: str
-    value: int | float
+    # TODO: This is not enough to allow booleans and might actually cause issues
+    value: int | float | bool
 
     class Config:
         from_attributes = True

backend_py/src/routes/__init__.py

@@ -1,5 +1,4 @@
 from .cameras import camera_router
-from .lights import lights_router
 from .logs import logs_router
 from .network import network_router
 from .preferences import preferences_router
@@ -9,7 +8,6 @@
 
 __all__ = [
     "camera_router",
-    "lights_router",
     "logs_router",
     "preferences_router",
     "system_router",