Feature/7975 update library to be compatible with new camera modules

.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines at the bottom of every file
+[*]
+charset = utf-8
+
+# Tab indentation
+indent_style = space
+indent_size = 4
+
+[*.{md,sh,yaml,yml}]
+indent_size = 2

.flake8

@@ -1,2 +1,7 @@
 [flake8]
-max-line-length = 88
+max-line-length=88
+docstring-convention=google
+extend-ignore=E203
+exclude=
+    venv
+    .venv

.github/workflows/linter.yml

@@ -1,32 +1,41 @@
----
-name: super-linter
-#
-# Documentation:
-# https://help.github.com/en/articles/workflow-syntax-for-github-actions
-#
-
-on: pull_request
-
-jobs:
-  build:
-    name: lint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-      - name: Lint Code Base
-        uses: docker://github/super-linter:v4
-        env:
-          VALIDATE_ALL_CODEBASE: false
-          DEFAULT_BRANCH: master
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          VALIDATE_PYTHON_PYLINT: false
-          VALIDATE_PYTHON_MYPY: false
-          VALIDATE_JSCPD: false
-          VALIDATE_PYTHON_BLACK: false
-          FILTER_REGEX_EXCLUDE: .webfiles/css/bootstrap.*
-
-          LINTER_RULES_PATH: /
-          PYTHON_FLAKE8_CONFIG_FILE: setup.cfg
-          PYTHON_ISORT_CONFIG_FILE: setup.cfg
-          YAML_CONFIG_FILE: .yamllint.yaml
+---
+name: super-linter
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+on: pull_request
+
+permissions: read-all
+
+jobs:
+  build:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          # super-linter needs the full git history to get the
+          # list of files that changed across commits
+          fetch-depth: 0
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v7
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_GO_RELEASER: false
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_PYTHON_PYLINT: false
+          VALIDATE_PYTHON_MYPY: false
+          VALIDATE_JSCPD: false
+          VALIDATE_PYTHON_BLACK: false
+          VALIDATE_PYTHON_PYINK: false
+          FILTER_REGEX_EXCLUDE: .webfiles/css/bootstrap.*
+
+          LINTER_RULES_PATH: .
+          PYTHON_FLAKE8_CONFIG_FILE: .flake8
+          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
+          YAML_CONFIG_FILE: .yamllint.yaml

.pre-commit-config.yaml

@@ -0,0 +1,83 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: check-json
+      - id: end-of-file-fixer
+        exclude_types:
+          - json
+      - id: trailing-whitespace
+      - id: no-commit-to-branch
+      - id: debug-statements
+      - id: requirements-txt-fixer
+      - id: check-executables-have-shebangs
+      - id: detect-private-key
+  - repo: local
+    hooks:
+      - id: update-type-stubs
+        name: Check for Type Stubs and Update Config
+        entry: ./update_precommit.py
+        language: system
+        files: ^requirements.*\.txt$
+        stages:
+          - pre-commit
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.2.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        args:
+          - --profile
+          - black
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        entry: mypy OTCamera tests --config-file=pyproject.toml
+        additional_dependencies:
+          - art==6.5
+          - black==25.1.0
+          - gpiozero==2.0.1
+          - hatch-requirements-txt==0.4.1
+          - isort==6.0.1
+          - mypy==1.15.0
+          - opencv-python==4.11.0.86
+          - picamerax==24.3.21
+          - pre-commit==4.2.0
+          - pytest-cov==6.1.1
+          - pytest==8.3.5
+          - types-PyYAML
+          - types-RPi.GPIO
+          - types-beautifulsoup4
+          - types-flake8
+          - types-psutil
+          - types-requests
+          - types-requests
+        always_run: true
+        pass_filenames: false
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        args:
+          - -c=./.yamllint.yaml
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.10.0
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/pecigonzalo/pre-commit-shfmt
+    rev: v2.2.0
+    hooks:
+      - id: shell-fmt-docker
+        args:
+          - -i
+          - "2"

.vscode/license.code-snippets

@@ -19,4 +19,4 @@
         ],
         "description": "Add GPLv3 license information in source code."
     }
-}
+}

OTCamera/__main__.py

@@ -8,9 +8,10 @@
 every interval (see config.py), captures a new preview image and stops recording
 after recording time ends.
 
-Stops everthing by keyboard interrupt (Ctrl+C).
+Stops everything by keyboard interrupt (Ctrl+C).
 
 """
+
 # Copyright (C) 2023 OpenTrafficCam Contributors
 # <https://github.com/OpenTrafficCam>
 # <team@opentrafficcam.org>
@@ -28,10 +29,10 @@
 
 
 # from record import record
-from OTCamera.record import record
+from OTCamera.record import main as record
 
 
-def main():
+def main() -> None:
     """Starts OTCamera."""
     record()
 

OTCamera/abstraction/singleton.py

@@ -0,0 +1,26 @@
+from typing import Any, Optional, Type, TypeVar
+
+T = TypeVar("T", bound="Singleton")
+
+
+class Singleton(object):
+    """Implements the Singleton design pattern.
+
+    Classes inheriting from `Singleton` become a singleton class.
+    Meaning only one instance is created.
+    Constructing another instance of the concrete class inheriting from `Singleton`
+    will return the first instance.
+    """
+
+    __it__: Optional["Singleton"] = None
+
+    def __new__(cls: Type[T], *args: Any, **kwargs: Any) -> T:
+        it = cls.__dict__.get("__it__")
+        if it is not None:
+            return it
+        cls.__it__ = it = object.__new__(cls)
+        it.init(*args, **kwargs)
+        return it
+
+    def init(self, *args: Any, **kwargs: Any) -> None:
+        pass

OTCamera/config.py

@@ -3,6 +3,7 @@
 All the configuration of OTCamera is done here.
 
 """
+
 # Copyright (C) 2023 OpenTrafficCam Contributors
 # <https://github.com/OpenTrafficCam>
 # <team@opentrafficcam.org>
@@ -22,16 +23,17 @@
 import socket
 import sys
 from pathlib import Path
+from typing import Literal
 
 try:
-    from yaml import CSafeLoader as SafeLoader
+    from yaml import CSafeLoader as SafeLoader  # type: ignore
 except ImportError:
-    from yaml import SafeLoader
+    from yaml import SafeLoader  # type: ignore
 
 import yaml
 
 
-def parse_user_config(config_file: str):
+def parse_user_config(config_file: str) -> None:
     """Parses the OTCamera user configuration YAML file.
 
     Args:
@@ -83,7 +85,6 @@ def parse_user_config(config_file: str):
         except KeyError:
             _print_key_err_msg("recording.end_hour")
         try:
-            global INTERVAL_LENGTH
             setattr(module, "INTERVAL_LENGTH", section["interval_length"])
         except KeyError:
             _print_key_err_msg("recording.interval_length")
@@ -101,6 +102,10 @@ def parse_user_config(config_file: str):
     except KeyError:
         _print_key_err_msg("camera")
     else:
+        try:
+            setattr(module, "CAMERA_TYPE", section["type"])
+        except KeyError:
+            _print_key_err_msg("camera.type")
         try:
             setattr(module, "FPS", section["fps"])
         except KeyError:
@@ -304,6 +309,8 @@ def read_text_file(text_file: Path) -> str:
 """free space in GB on sd card before old videos get deleted."""
 
 # camera config
+CAMERA_TYPE = "legacy"
+"""Camera type. `legacy` for the original camera module."""
 FPS = 20
 """Frames per Second. 10-20 should be enough."""
 RESOLUTION = (1640, 1232)
@@ -350,13 +357,13 @@ def read_text_file(text_file: Path) -> str:
 # video config
 VIDEO_DIR = "~/videos/"
 """path to safe videofiles."""
-VIDEO_FORMAT = "h264"
+VIDEO_FORMAT: Literal["h264"] = "h264"
 """Encoding format."""
 RESOLUTION_SAVED_VIDEO_FILE = (800, 600)
 """Resolution of the saved videofile, not the camera itself."""
-H264_PROFILE = "high"
+H264_PROFILE: Literal["high"] = "high"
 """Profile used in h264 encoder."""
-H264_LEVEL = "4"
+H264_LEVEL: Literal["4"] = "4"
 """Level used in h264 encoder."""
 H264_BITRATE = 600000
 """Bitrate used in h264 encoder."""