feat: init implementation of test command

Author: EmixamPP

camera/autocamera.cpp

@@ -65,15 +65,32 @@ long long unsigned AutoCamera::intensityVariationSum()
     long long unsigned sum = 0;
     for (unsigned i = 0; i < diffs.size() - 1; ++i)
         sum += static_cast<long long unsigned>(abs(diffs[i] - diffs[i + 1]));
-   
+
     closeCap();
     return sum;
 }
 
+
+/**
+ * @brief Check if the emitter is working,
+ * without asking for manual confirmation
+ *
+ * @return true if yes, false if not
+ */
+bool AutoCamera::isEmitterWorkingNoConfirm()
+{
+    return intensityVariationSum() > refIntesityVarSum * MAGIC_REF_INTENSITY_VAR_COEF;
+}
+
+/**
+ * @brief Check if the emitter is working,
+ * if so, ask for manual confirmation
+ *
+ * @return true if yes, false if not
+ */
 bool AutoCamera::isEmitterWorking()
 {
-    bool isWorking = intensityVariationSum() > refIntesityVarSum * MAGIC_REF_INTENSITY_VAR_COEF;
-    return isWorking && Camera::isEmitterWorking();
+    return isEmitterWorkingNoConfirm() && Camera::isEmitterWorking();
 }
 
 AutoCamera::AutoCamera(const string &device, unsigned captureTimeMs) : Camera(device), captureTimeMs(captureTimeMs), refIntesityVarSum(intensityVariationSum()) {}

camera/autocamera.hpp

@@ -25,6 +25,8 @@ class AutoCamera : public Camera
 
     bool isEmitterWorking() override;
 
+    bool isEmitterWorkingNoConfirm();
+
     AutoCamera &operator=(const AutoCamera &) = delete;
 
     AutoCamera(const AutoCamera &) = delete;

camera/camera.cpp

@@ -127,6 +127,28 @@ Camera::~Camera()
     closeCap();
 }
 
+/**
+ * @brief Show a video feedback until the user exit
+ */
+void Camera::play()
+{
+    openCap();
+    cv::Mat frame;
+    int key = -1;
+
+    cout << "Press any key in the window to close" << endl;
+
+    while (key == -1)
+    {
+        cap->read(frame);
+        cv::imshow("linux-enable-ir-emitter", frame);
+        key = cv::waitKey(5);
+    }
+
+    closeCap();
+    cv::destroyAllWindows();
+}
+
 /**
  * @brief Apply an instruction on the camera
  *
@@ -166,6 +188,8 @@ unique_ptr<cv::Mat> Camera::read1()
 
 /**
  * @brief Check if the emitter is working
+ * by showing a video feedback and
+ * asking confirmation to the user
  *
  * @throw CameraException if unable to open the camera device
  *
@@ -190,7 +214,7 @@ bool Camera::isEmitterWorking()
 
     closeCap();
     cv::destroyAllWindows();
-    
+
     return key == OK_KEY;
 }
 

camera/camera.hpp

@@ -53,6 +53,8 @@ class Camera
 
     Camera(Camera &&other) = delete;
 
+    void play();
+
     bool apply(const CameraInstruction &instruction);
 
     virtual bool isEmitterWorking();

camera/is-emitter-working.cpp

@@ -0,0 +1,31 @@
+#include <memory>
+using namespace std;
+
+#include "autocamera.hpp"
+#include "opencv.hpp"
+
+constexpr unsigned EXIT_FD_ERROR = 126;
+
+/**
+ * Check if a ir emitter is working using the automatic detection algorithm
+ *
+ * usage: is-emitter-camera [device]
+ *        device           path to the camera
+ *
+ * Exit code: 0 Success
+ *            1 Error
+ *            126 Unable to open the camera device
+ */
+int main(int, const char **argv)
+{
+    AutoCamera camera(argv[1]);
+    try
+    {
+        return static_cast<int>(camera.isEmitterWorkingNoConfirm());
+    }
+    catch (CameraException &e)
+    {
+        cerr << e.what() << endl;
+        return EXIT_FD_ERROR;
+    }
+}

camera/video-feedback.cpp

@@ -0,0 +1,31 @@
+#include <memory>
+using namespace std;
+
+#include "autocamera.hpp"
+#include "opencv.hpp"
+
+constexpr unsigned EXIT_FD_ERROR = 126;
+
+/**
+ * Check if a ir emitter is working using the automatic detection algorithm
+ *
+ * usage: is-emitter-camera [device]
+ *        device           path to the camera
+ *
+ * Exit code: 0 Success
+ *            126 Unable to open the camera device
+ */
+int main(int, const char **argv)
+{
+    Camera camera(argv[1]);
+    try
+    {
+        camera.play();
+        return EXIT_SUCCESS;
+    }
+    catch (CameraException &e)
+    {
+        cerr << e.what() << endl;
+        return EXIT_FD_ERROR;
+    }
+}

command/__init__.py

@@ -2,3 +2,4 @@
 from command.configure import configure
 from command.delete import delete
 from command.run import run
+from command.test import test

command/configure.py

@@ -7,7 +7,7 @@
 from globals import (
     BIN_GENERATE_DRIVER_PATH,
     SAVE_DRIVER_FOLDER_PATH,
-    BIN_IS_GREY_CAMERA_PATH,
+    find_grayscale_camera,
     ExitCode,
 )
 
@@ -23,36 +23,15 @@ def configure(
         emitters (int): number of emitters on the device
         neg_answer_limit (int): number of negative answer before the pattern is skiped. Use -1 for unlimited
     """
-    logging.info("Stand in front of and close to the camera and make sure the room is well lit.")
+    logging.info(
+        "Stand in front of and close to the camera and make sure the room is well lit."
+    )
     logging.info("Ensure to not use the camera during the execution.")
     logging.info("Warning to do not kill the process !")
 
     if device is None:
-        dev_devices = (
-            subprocess.run(
-                f"ls /dev/v4l/by-path/*",
-                shell=True,
-                capture_output=True,
-                text=True,
-            )
-            .stdout.strip()
-            .split()
-        )
+        device = find_grayscale_camera()
 
-        for dev in dev_devices:
-            exit_code = subprocess.call(
-                [BIN_IS_GREY_CAMERA_PATH, dev],
-                stdout=subprocess.DEVNULL,
-                stderr=subprocess.DEVNULL,
-            )
-            if exit_code == ExitCode.SUCCESS:
-                device = dev
-                break
-
-    if device is None:
-        logging.critical("Impossible to find your infrared camera.")
-        logging.info("Please specify your infrared camera path using the -d option.")
-        exit(ExitCode.FAILURE)
     logging.info(f"Configuring the camera: {device}.")
     log_level = int(logging.getLogger().level == logging.DEBUG)
     exit_code = subprocess.call(

command/test.py

@@ -0,0 +1,61 @@
+from typing import NoReturn
+
+import subprocess
+import logging
+
+from globals import (
+    BIN_IS_GRAY_CAMERA_PATH,
+    BIN_IS_EMITTER_WORKING_PATH,
+    BIN_VIDEO_FEEDBACK_PATH,
+    find_grayscale_camera,
+    ExitCode,
+)
+
+
+def test(device: str | None) -> NoReturn:
+    """Test if the camera is in grayscale and if the emitter is working.
+    Also display a video feedback, then exit.
+
+    Args:
+        device (str | None): path to the camera, None for automatic detection
+    """
+    if device is None:
+        device = find_grayscale_camera()
+
+    exit_code = subprocess.call(
+        [BIN_IS_GRAY_CAMERA_PATH, device],
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+    if exit_code == ExitCode.FILE_DESCRIPTOR_ERROR:
+        exit(exit_code)
+    elif exit_code == ExitCode.SUCCESS:
+        logging.info(
+            "The camera is in gray scale. This is probably your infrared camera."
+        )
+    else:
+        logging.error(
+            "The camera is not in gray scale. This is probably your regular camera."
+        )
+
+    exit_code = subprocess.call(
+        [BIN_IS_EMITTER_WORKING_PATH, device],
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+    if exit_code == ExitCode.FILE_DESCRIPTOR_ERROR:
+        exit(exit_code)
+    elif exit_code == ExitCode.SUCCESS:
+        logging.info("The infrared emitter is working.")
+    else:
+        logging.error("The infrared emitter is not working.")
+
+    exit_code = subprocess.call(
+        [BIN_VIDEO_FEEDBACK_PATH, device],
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+    if exit_code == ExitCode.FILE_DESCRIPTOR_ERROR:
+        exit(exit_code)
+
+    exit(ExitCode.SUCCESS)

globals.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import TYPE_CHECKING, Type
+from typing import TYPE_CHECKING, Type, NoReturn
 
 if TYPE_CHECKING:
     from boot_service.systemd import Systemd
@@ -18,7 +18,9 @@
 
 BIN_EXECUTE_DRIVER_PATH = "@BIN_EXECUTE_DRIVER_PATH@"
 BIN_GENERATE_DRIVER_PATH = "@BIN_GENERATE_DRIVER_PATH@"
-BIN_IS_GREY_CAMERA_PATH = "@BIN_IS_CAMERA_PATH@"
+BIN_IS_GRAY_CAMERA_PATH = "@BIN_IS_GRAY_CAMERA_PATH@"
+BIN_IS_EMITTER_WORKING_PATH = "@BIN_IS_EMITTER_WORKING_PATH@"
+BIN_VIDEO_FEEDBACK_PATH = "@BIN_VIDEO_FEEDBACK_PATH@"
 BIN_GENERATE_DRIVER_PATH = "@BIN_GENERATE_DRIVER_PATH@"
 
 UDEV_RULE_PATH = "@UDEV_RULE_PATH@"
@@ -112,3 +114,35 @@ def get_kernels(device: str) -> str:
         shell=True,
         text=True,
     ).strip()
+
+
+def find_grayscale_camera() -> str | NoReturn:
+    """Automatically determine the grayscale camera.
+    Exit if no gray camera is found.
+
+    Returns:
+        str: path to the grayscale camera
+    """
+    devices = (
+        subprocess.run(
+            f"ls /dev/v4l/by-path/*",
+            shell=True,
+            capture_output=True,
+            text=True,
+        )
+        .stdout.strip()
+        .split()
+    )
+
+    for device in devices:
+        exit_code = subprocess.call(
+            [BIN_IS_GRAY_CAMERA_PATH, device],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        if exit_code == ExitCode.SUCCESS:
+            return device
+
+    logging.critical("Impossible to find your infrared camera.")
+    logging.info("Please specify your infrared camera path using the -d option.")
+    exit(ExitCode.FAILURE)

linux-enable-ir-emitter.py

@@ -4,7 +4,7 @@
 import logging
 import subprocess
 
-from command import boot, configure, delete, run
+from command import boot, configure, delete, run, test
 from globals import ExitCode, check_root
 
 if __name__ == "__main__":
@@ -28,7 +28,7 @@
         "-V",
         "--version",
         action="version",
-        version="%(prog)s 5.0.2\nDevelopped by Maxime Dirksen - EmixamPP\nMIT License",
+        version="%(prog)s @version@\nDevelopped by Maxime Dirksen - EmixamPP\nMIT License",
         help="show version information and exit",
     )
     parser.add_argument(
@@ -69,6 +69,10 @@
         default=40,
         type=int,
     )
+    command_test = command_subparser.add_parser(
+        "test",
+        help="test a camera",
+    )
     command_boot = command_subparser.add_parser(
         "boot",
         help="enable ir at boot",
@@ -114,6 +118,9 @@
         check_root()
         configure(device, args.manual, args.emitters, args.limit)
 
+    elif args.command == "test":
+        test(device)
+
     elif args.command == "boot":
         check_root()
         boot(args.boot_status)