Merge pull request #4 from alexmohr/dev

Dev

Author: alexmohr

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.12)
 project(thinkpad_keyboard_backlight)
-set(CMAKE_INSTALL_PREFIX /usr/local/bin)
+set(CMAKE_INSTALL_PREFIX /usr/bin)
 
 
 set(CMAKE_CXX_STANDARD 17)
@@ -30,6 +30,8 @@ set(CMAKE_CXX_FLAGS "${OPTIMIZATION_LEVEL} \
     -Wpedantic \
     -Wextra")
 
+set(SERVICE_TARGET_PATH  /etc/systemd/system/keyboard_backlight.service)
+set(APP_TARGET_PATH ${CMAKE_INSTALL_PREFIX}/keyboard_backlight)
 
 find_package (Threads)
 
@@ -40,10 +42,12 @@ target_link_libraries (keyboard_backlight ${CMAKE_THREAD_LIBS_INIT})
 
 install(TARGETS keyboard_backlight DESTINATION ${CMAKE_INSTALL_PREFIX})
 
-
-# Add custom features to build hex, bin or lst files.
 add_custom_target(service
         DEPENDS keyboard_backlight
         COMMAND sudo cp ${CMAKE_CURRENT_SOURCE_DIR}/keyboard_backlight.service /etc/systemd/system &&
         sudo systemctl enable --now keyboard_backlight.service
-        )
+)
+
+add_custom_target(uninstall
+        COMMAND sudo rm -f ${SERVICE_TARGET_PATH}  ${APP_TARGET_PATH}
+)

PKGBUILD

@@ -0,0 +1,33 @@
+# Maintainer: Alexander Mohr keyboard_backlight at mohr dot io
+
+pkgname=tp-kb-backlight-git
+pkgver=1.0
+pkgrel=1
+pkgdesc='Automated keyboard backlight'
+arch=('x86_64')
+url='https://github.com/alexmohr/keyboard-backlight'
+license=('MIT')
+depends=('libinput')
+makedepends=('git' 'cmake' 'gcc')
+
+source=("git+https://github.com/alexmohr/keyboard-backlight")
+sha512sums=('SKIP')
+
+
+build() {
+    cd "keyboard-backlight"
+    mkdir build -p
+    cd build
+    cmake ..
+    make
+}
+
+package() {
+    appname='keyboard_backlight'
+    install -Dm 755 "keyboard-backlight/build/${appname}" "${pkgdir}/usr/bin/${appname}"
+    install -Dm 644 "keyboard-backlight/keyboard_backlight.service" "${pkgdir}/etc/systemd/system/keyboard_backlight.service"
+
+    echo "Please enable the systemd service via 'sudo systemctl enable --now keyboard_backlight.service"
+    echo "The service file can be used for configuration."
+    echo "See 'keyboard_backlight -h' for options".
+}

README.md

@@ -6,6 +6,11 @@ backlight of a keyboard. It's only tested for thinkpads but may work on
 other devices as well
 
 ## Installation
+
+### Arch Linux
+The package is in the AUR and called  ``tp-kb-backlight-git``
+
+### Install from source
 To build the binary run
 ````
 mkdir build
@@ -19,6 +24,32 @@ to install the service and enable the systemd service.
 
 Make sure to run ``make install`` BEFORE ``make service`` 
 
+### Binary (not recommended)
+Download the latest package from github. Extract it an run the following commands.
+
+````
+sudo cp keyboard_backlight /usr/bin
+sudo cp keyboard_backlight.service /etc/systemd/sytem
+sudo systemctl enable --now keyboard_backlight.service
+```` 
+
+
+# Uninstall
+For automated removal run the command below in the cmake folder
+````
+make uninstall
+````
+
+To manually delete the files 
+````
+sudo systemctl disable --now keyboard_backlight.service
+sudo rm /etc/systemd/system/keyboard_backlight.service
+sudo rm /usr/bin/keyboard_backlight
+````
+
+
+
+
 ## Configuration
 ````
 tp_kbd_backlight help

kbd_backlight.cpp

@@ -331,7 +331,8 @@ int main(int argc, char **argv) {
   if (!file_read_uint64(brightnessPath, &originalBrightness_)
 	  || !file_write_uint64(brightnessPath, originalBrightness_)
 	  ) {
-	std::cout << "failed to get/set brightness " << std::endl;
+	std::cout << "Write access to brightness device descriptor failed.\n"
+        "Please run with root privileges" << std::endl;
 	exit(EXIT_FAILURE);
   }
   currentBrightness_ = originalBrightness_;

keyboard_backlight.service

@@ -4,7 +4,7 @@ Description=Controls the backlight of the keyboard
 [Service]
 Type=forking
 # Options can be passed via command line
-ExecStart=/usr/local/bin/keyboard_backlight -t 5
+ExecStart=/usr/bin/keyboard_backlight -t 5
 
 [Install]
 WantedBy=default.target