Merge pull request #141 from EmixamPP/test_command

Test command

Author: EmixamPP

README.md

@@ -25,7 +25,7 @@ sudo rm -rf /usr/lib64/linux-enable-ir-emitter \
 ```
 
 ## How to enable your infrared emitter?
-1. Stand in front of the camera and make sure the room is well lit.
+1. Stand in front of and close to the camera and make sure the room is well lit.
 2. Ensure to not use the camera during the execution.
 3. Be patient, do not kill the process.
 4. Execute `sudo linux-enable-ir-emitter configure`.

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/is-gray-camera.cpp

@@ -0,0 +1,44 @@
+#include <memory>
+using namespace std;
+
+#include "camera.hpp"
+#include "opencv.hpp"
+
+constexpr unsigned EXIT_FD_ERROR = 126;
+
+/**
+ * Check if a camera is in gray scale
+ *
+ * usage: is-gray-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)
+{
+    Camera camera(argv[1]);
+    try
+    {
+        unique_ptr<cv::Mat> frame = camera.read1();
+
+        if (frame->channels() != 3)
+            return EXIT_FAILURE;
+
+        for (int r = 0; r < frame->rows; ++r)
+            for (int c = 0; c < frame->cols; ++c)
+            {
+                const cv::Vec3b &pixel = frame->at<cv::Vec3b>(r, c);
+                if (pixel[0] != pixel[1] || pixel[0] != pixel[2])
+                    return EXIT_FAILURE;
+            }
+
+        return EXIT_SUCCESS;
+    }
+    catch (CameraException &e)
+    {
+        cerr << e.what() << endl;
+        return EXIT_FD_ERROR;
+    }
+}

camera/is-ir-camera.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;
+    }
+}

camera/video-feedback.cpp

@@ -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/__init__.py

@@ -4,11 +4,17 @@
 import subprocess
 
 from command import boot
-from globals import (BIN_GENERATE_DRIVER_PATH, SAVE_DRIVER_FOLDER_PATH,
-                     BIN_IS_CAMERA_PATH, ExitCode)
+from globals import (
+    BIN_GENERATE_DRIVER_PATH,
+    SAVE_DRIVER_FOLDER_PATH,
+    find_grayscale_camera,
+    ExitCode,
+)
 
 
-def configure(device: str | None, manual: bool, emitters: int, neg_answer_limit: int) -> NoReturn:
+def configure(
+    device: str | None, manual: bool, emitters: int, neg_answer_limit: int
+) -> NoReturn:
     """Find a driver for the infrared camera and exit.
 
     Args:
@@ -17,33 +23,15 @@ def configure(device: str | None, manual: bool, emitters: int, neg_answer_limit:
         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("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()
-
-        for dev in dev_devices:
-            exit_code = subprocess.call(
-                [BIN_IS_CAMERA_PATH, dev],
-                stdout=subprocess.DEVNULL,
-                stderr=subprocess.DEVNULL
-            )
-            if exit_code == ExitCode.SUCCESS:
-                device = dev
-                break
+        device = find_grayscale_camera()
 
-    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(
@@ -62,7 +50,9 @@ def configure(device: str | None, manual: bool, emitters: int, neg_answer_limit:
         logging.error("The configuration has failed.")
         logging.error("Please retry in manual mode by adding the '-m' option.")
         logging.info("Do not hesitate to visit the GitHub !")
-        logging.info("https://github.com/EmixamPP/linux-enable-ir-emitter/blob/master/docs/README.md")
+        logging.info(
+            "https://github.com/EmixamPP/linux-enable-ir-emitter/blob/master/docs/README.md"
+        )
     else:
         logging.info("The driver has been successfully generated.")
         boot("enable")

command/configure.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)