feat(v5): fully automatic generation

.clang-tidy

@@ -1,17 +1,24 @@
 ---
 Checks: '
-  ,readability-avoid-const-params-in-decls,
-  ,readability-inconsistent-declaration-parameter-name,
-  ,readability-non-const-parameter,
-  ,readability-redundant-string-cstr,
-  ,readability-redundant-string-init,
-  ,readability-simplify-boolean-expr,
-'
-WarningsAsErrors: '
-  ,readability-avoid-const-params-in-decls,
-  ,readability-inconsistent-declaration-parameter-name,
-  ,readability-non-const-parameter,
-  ,readability-redundant-string-cstr,
-  ,readability-redundant-string-init,
-  ,readability-simplify-boolean-expr,
+readability*,
+-readability-identifier-length,
+-readability-braces-around-statements,
+-readability-magic-numbers,
+-readability-named-parameter,
+-readability-function-cognitive-complexity,
+-readability-use-anyofallof,
+cppcoreguidelines*,
+-cppcoreguidelines-init-variables,
+-cppcoreguidelines-avoid-magic-numbers,
+-cppcoreguidelines-pro-type-vararg,
+-cppcoreguidelines-pro-type-const-cast,
+-cppcoreguidelines-pro-type-member-init,
+-cppcoreguidelines-avoid-const-or-ref-data-members,
+-cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+-cppcoreguidelines-avoid-c-arrays,
+-cppcoreguidelines-pro-bounds-pointer-arithmetic,
+-cppcoreguidelines-non-private-member-variables-in-classes,
+-cppcoreguidelines-avoid-non-const-global-variables,
+-cppcoreguidelines-avoid-do-while
 '
+WarningsAsErrors: '*'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,8 +7,8 @@ assignees: ''
 
 ---
 
-<!--- Please look at the wiki before open an issue -->
-<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/wiki -->
+<!--- Please look at the docs before open an issue -->
+<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/blob/master/docs/README.md -->
 
 **Describe the bug**
 <!--- explain here  -->

.github/ISSUE_TEMPLATE/configuration-has-failed.md

@@ -7,11 +7,10 @@ assignees: ''
 
 ---
 
-<!--- Please look at the wiki before open an issue -->
-<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/wiki -->
+<!--- Please look at the docs before open an issue -->
+<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/blob/master/docs/README.md -->
 
-**Ouput of `linux-enable-ir-emitter -v -d /dev/videoX configure`**
-<!-- replace /dev/videoX with your device (/dev/video2 for default)-->
+**Ouput of `linux-enable-ir-emitter -v configure`**
 <details><summary>configure command output</summary>
 
 ```
@@ -25,14 +24,19 @@ paste here
 ```
 
 **Ouput of `v4l2-ctl -d /dev/videoX --list-formats-ext`**
-<!-- replace /dev/videoX with your device (/dev/video2 for default)-->
+<!-- replace /dev/videoX for each device shown by the previous command-->
 <details><summary>v4l2 device output</summary>
 
 ```
 paste here
 ```
 </details>
 
+**Output of `ls -l /dev/v4l/by-path`**
+```
+paste here
+```
+
 **Give more information if you have**
 <!-- describe here if you have -->
 

.github/ISSUE_TEMPLATE/does-not-work-at-boot.md

@@ -7,8 +7,8 @@ assignees: ''
 
 ---
 
-<!--- Please look at the wiki before open an issue -->
-<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/wiki -->
+<!--- Please look at the docs before open an issue -->
+<!--- https://github.com/EmixamPP/linux-enable-ir-emitter/blob/master/docs/README.md -->
 
 **Output of `linux-enable-ir-emitter boot status`**
 ```

.github/workflows/arm.yml

@@ -5,7 +5,7 @@ on:
   workflow_call:
 
 env: 
-  OPENCV_TINY_VERSION: "4.7.0"
+  OPENCV_TINY_VERSION: "4.8.0"
 
 jobs:
   build:
@@ -35,21 +35,25 @@ jobs:
           --volume "${PWD}/artifacts:/artifacts"
           --volume "${PWD}/opencv-tiny:/opencv-tiny"
         install: |
-          apt-get update -q -y
-          apt-get install -q -y g++ meson pkg-config curl cmake
+          apt-get update -y
+          apt-get install -y python3 python3-pip python3-setuptools python3-wheel ninja-build g++ pkg-config curl cmake libgtk-3-dev
+          python3 -m pip install --upgrade pip
+          python3 -m pip install meson
+
         run: |
           [ "$(ls /opencv-tiny)" ] || curl https://raw.githubusercontent.com/EmixamPP/opencv-tiny/main/build.sh | bash -s ${OPENCV_TINY_VERSION} /opencv-tiny
 
           meson setup build --pkg-config-path=$(find opencv-tiny -name pkgconfig | tr '\n' ':')
-          meson configure build -Dlibdir=lib64 
+          meson configure build -Dlibdir=lib64
           meson compile -C build
 
           DESTDIR=install_dir meson install -C build
-          tar -czvf /artifacts/linux-enable-ir-emitter_aarch64.tar.gz -C build/install_dir .
+          chown -R root:root build/install_dir
+          tar -czvf /artifacts/linux-enable-ir-emitter.aarch64.tar.gz -C build/install_dir .
 
     - name: Upload tarball
       uses: actions/upload-artifact@v3
       with:
-        name: linux-enable-ir-emitter_aarch64.tar.gz
-        path: artifacts/linux-enable-ir-emitter_aarch64.tar.gz
+        name: linux-enable-ir-emitter.aarch64.tar.gz
+        path: artifacts/linux-enable-ir-emitter.aarch64.tar.gz
         if-no-files-found: error

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   workflow_call:
 
 env: 
-  OPENCV_TINY_VERSION: "4.7.0"
+  OPENCV_TINY_VERSION: "4.8.0"
 
 jobs:
   ci:
@@ -21,9 +21,9 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y g++ meson pkg-config curl clang-tidy
+          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ pkg-config clang-tidy libgtk-3-dev
           python -m pip install --upgrade pip
-          python -m pip install pyright
+          python -m pip install meson pyright
 
       - name: Cache OpenCV dependency
         id: cache-opencv
@@ -61,11 +61,12 @@ jobs:
       - name: Create tarball
         run: |
           DESTDIR=install_dir meson install -C build
-          tar -czvf build/linux-enable-ir-emitter_x86-64.tar.gz -C build/install_dir .
+          sudo chown -R root:root build/install_dir
+          tar -czvf build/linux-enable-ir-emitter.x86-64.tar.gz -C build/install_dir .
 
       - name: Upload tarball
         uses: actions/upload-artifact@v3
         with:
-          name: linux-enable-ir-emitter_x86-64.tar.gz
-          path: build/linux-enable-ir-emitter_x86-64.tar.gz
+          name: linux-enable-ir-emitter.x86-64.tar.gz
+          path: build/linux-enable-ir-emitter.x86-64.tar.gz
           if-no-files-found: error

.github/workflows/pr.yml

@@ -2,6 +2,9 @@ name: Pull Request
 
 on:
   pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
 
 jobs:         
   ci:

.gitignore

@@ -7,6 +7,7 @@ build
 
 # OpenCV
 opencv*
+!sources/camera/opencv.hpp
 zlib*
 
 # Others

CHANGELOG.md

@@ -1,3 +1,8 @@
+# ? Aug ? 2023 - 5.0.0
+- Automatic ir camera detection
+- Automatic ir emitter configuration
+- Exhaustive search
+- Video feedback
 # Fri Jun 23 2023 - 4.8.2
 - Fix systemd hanging in some cases
 - More appropriate installation paths
@@ -16,7 +21,6 @@
 - Support multiple emitters camera
 - Memorize broken instructions to skip them 
 - Usage of /dev/v4l/by-path for persistence
-- Drop distribution repositories support
 # Tue Sep 13 2022 - 4.1.5
 - Fix boot service for custom device 
 # Thu Aug 11 2022 - 4.1.4
@@ -49,4 +53,4 @@
 - New fix command, to resolve well know problems
 - Systemd service file modified to prevent /dev/video file descriptor error
 # Thu Aug 12 2021 - 2.0.1
-- Initial package
+- Initial release

README.md

@@ -4,14 +4,12 @@ Provides support for infrared cameras that are not directly enabled out-of-the b
 
 `linux-enable-ir-emitter` can automatically generate a lightweight driver (located in user space) for almost any (UVC) infrared emitter.
 
-This tool was created to use [Howdy](https://github.com/boltgolt/howdy), a Windows Hello for linux.
-
 ## Installation
 Directly refer to the manual buid [section](#manual-build) if your boot service manager is not Systemd but OpenRC. Stay here if you don't know. We support ARM architectures, just download the `aarch64` variant.
 
-Download the latest `linux-enable-ir-emitter-x.x.x_x86-64.tar.gz` [here](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest), then execute:
+Download the latest `linux-enable-ir-emitter-x.x.x.x86-64.tar.gz` [here](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest), then execute:
 ```
-sudo tar -C / --no-same-owner -h -xzf linux-enable-ir-emitter-*.tar.gz
+sudo tar -C / -h -xzf linux-enable-ir-emitter-*.tar.gz
 ```
 
 It can be uninstalled by executing (remove the last line to keep the emitter configuration):
@@ -26,22 +24,27 @@ sudo rm -rf /usr/lib64/linux-enable-ir-emitter \
 ```
 
 ## How to enable your infrared emitter?
-1. Ensure to not use the camera during the execution.
-2. Be patient, do not kill the process, and whatever the reason. (Unless the execution is stuck for more than 10 minutes.)
-3. Execute `sudo linux-enable-ir-emitter configure`.
-    * You can specify your infrared camera with the option `-d`, by default it is `-d /dev/video2`.
+1. Stand in front of 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`.
     * If you have many emitters on the camera, specify it using the option `-e`. E.g. `-e 2` if you have 2 emitters.
-4. Answer to the asked questions.
-5. Sometimes, it can request you to shut down, then boot and retry ($\neq$ reboot)
+5. Answer to the asked questions.
+6. Sometimes, it can request you to shut down, then boot and retry ($\neq$ reboot)
+
+If you like the project, do not hesitate to star the repository to support me, thank you!
 
-If you like the project, do not hesitate to star the repository to support me, thank you !
+Any criticims, ideas and contributions are welcome.
 
-*Please consult the [wiki](https://github.com/EmixamPP/linux-enable-ir-emitter/wiki) before opening an issue.*
+If the configuration failed:
+1. But you saw the ir emitter flashing, switch to manual mode by using the `-m` option.
+2. Also, try the exhaustive search by using the `-l -1` option (caution: this may take several hours; do not combine it `-m`).
+3. Otherwise, feel free to open an issue, *but please consult the [docs](docs/README.md) first*.
 
 The software supports the configuration of multiple devices, execute the configure command and specify each time which device to configure.
 
 ## Manual build
-See [wiki](https://github.com/EmixamPP/linux-enable-ir-emitter/wiki/Requirements) for specification concerning build requirements.
+See [docs](docs/requirements.md) for specification concerning build requirements.
 
 Clone the git:
 ```
@@ -51,7 +54,7 @@ cd linux-enable-ir-emitter
 
 Build my minimal version of OpenCV that will be statically linked. This is not required, you can use the shared opencv library of your distro. But it is recommanded in order to do not have issues after distro updates:
 ```
-curl https://raw.githubusercontent.com/EmixamPP/opencv-tiny/main/build.sh | bash -s 4.7.0 "${PWD}/opencv-tiny"
+curl https://raw.githubusercontent.com/EmixamPP/opencv-tiny/main/build.sh | bash -s 4.8.0 "${PWD}/opencv-tiny"
 ```
 
 Setup build (remove `--pkg-config-path=...` if you skipped the previous step):

docs/README.md

@@ -0,0 +1,53 @@
+### In this documentations you can find help for:
+* [Solve common problem and instruction for opening a new issue](issues.md)
+* [System, manual build and hardware requirements](requirements.md)
+* [Exit code meaning](exit-code.md)
+* [Command line usage](#linux-enable-ir-emitter-usage) 
+
+### linux-enable-ir-emitter usage 
+```
+usage: linux-enable-ir-emitter [-h] [-v] [-V] [-d device] {run,configure,boot,delete} ...
+
+Provides support for infrared cameras.
+
+positional arguments:
+  {run,configure,boot,delete}
+    run                 apply drivers
+    configure           generate ir emitter driver
+    boot                enable ir at boot
+    delete              delete drivers
+
+options:
+  -h, --help            show this help message and exit
+  -v, --verbose         print verbose information
+  -V, --version         show version information and exit
+  -d device, --device device
+                        specify the infrared camera, automatic detection by default
+```
+```
+usage: linux-enable-ir-emitter configure [-h] [-m] [-e <count>] [-l <count>]
+
+options:
+  -h, --help            show this help message and exit
+  -m, --manual          activate manual configuration
+  -e <count>, --emitters <count>
+                        the number of emitters on the device, by default is 1
+  -l <count>, --limit <count>
+                        the number of negative answer before the pattern is skipped, by default is 5. Use -1 for unlimited
+```
+```
+usage: linux-enable-ir-emitter boot [-h] {enable,disable,status}
+
+positional arguments:
+  {enable,disable,status}
+                        specify the boot action to perform
+
+optional arguments:
+  -h, --help            show this help message and exit
+```
+```
+usage: linux-enable-ir-emitter delete [-h]
+
+options:
+  -h, --help  show this help message and exit
+```

docs/exit-code.md

@@ -0,0 +1,8 @@
+## Exit code meaning
+
+| Code | Meaning | How to fix |
+|------|---------|------------|
+| 0 | SUCCESS | |
+| 1 | FAILURE | read the displayed logs output for more information |
+| 2 | ROOT_REQUIRED | execute with root privilege |
+| 126 | FILE_DESCRIPTOR_ERROR | check the -d option or your running processes which may use the camera| 

docs/issues.md

@@ -0,0 +1,23 @@
+### Please, first, ensure that you have the last version. Compare the [latest release](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest) with `linux-enable-ir-emitter -V`
+
+## The configuration has failed 
+If you had the message `INFO: Please shut down your computer, then boot and retry.`, please follow these instructions first:
+1. Shutdown your computer, (not just rebooting)
+2. Remove the AC adapter and if possible the battery
+3. Wait one minute
+4. Boot
+5. Retry
+
+Otherwise, open an issue using the "Configuration has failed" template.
+
+## The emitter does not work after successful configuration or after update.
+1. If you use Howdy, be sure it uses the infrared camera configured; the path is printed after the message `INFO: Configuring the camera:`.
+2. Execute `sudo linux-enable-ir-emitter boot enable`.
+3. If none of the previous fix your problem, open an issue using the "Emitter does not work after successful configuration" template.
+
+## Error with the systemd/openrc or udev boot service
+1. Ensure you have `systemd` or `openrc` (and the related version installed)
+2. Open an issue using the "Emitter does not work after successful configuration" template.
+
+## Other bugs
+Open an issue using the "Bug report" template.

docs/requirements.md

@@ -0,0 +1,16 @@
+## System requirements
+* if you used chicony-ir-toggle, please remove it
+* `python3 >= 3.10`
+* `video4linux` as video capture devices framework
+* `systemd` or `openrc` as service manager
+* `glibc`, `libstdc++`, `libgcc`, `gtk3`
+
+## Manual build requirements
+* `meson >= 1.0.0`, `ninja-build`, `pkg-config`, `gtk3 devel`
+* `cmake` only if you build OpenCV
+* `g++`, `libstdc++-devel` (for `C++17`)
+* `curl`
+
+## Hardware requirements
+* An infrared camera with at least one emitter.
+* A camera compatible with the UVC standard. Typically, it has to be a USB camera (laptop camera are mostly USB).