This is desktop application controlling Linak office desks. Application functionality is similar to application provided by Linak. One of the goals of this project is to allow the desk control under Linux operating systems, because official application does not support Linux OS.
Application was tested on DPG1C desk panel containing built-in Bluetooth module.
Communication protocol between DPG1C module and official application was reverse engineered mostly by mocking DPG1C Bluetooth service.
- scanning for nearby devices
- moving up/down
- moving to favourite position
- setting reminder, desk offset and favoritie positions
- system tray icon
- auto reconnecting to recent device
- persisting application settings
- drawing position chart over time
- position statistics
Installation of package for use can be done by:
- to install package from downloaded ZIP file execute:
pip3 install --user -I file:LinakDeskApp-master.zip - to install package directly from GitHub execute:
pip3 install --user -I git+https://github.com/anetczuk/LinakDeskApp.git - installation from local repository root directory:
pip3 install --user .
To uninstall run: pip3 uninstall linakdeskapp
To install project under virtual environment use tools/installvenv.sh (also see Working with venv section).
Development installation is covered in Development section.
Before first run there are few things to configure.
Python dependencies are managed through pyproject.toml, but the application still needs native Linux packages for
building bluepy and loading the Qt platform plugins at runtime.
Required system packages:
- Python 3.12
git,gcc,make,pkg-config- GLib and D-Bus development/runtime libraries
- OpenGL libraries
- Font and FreeType libraries
- X11/XCB libraries used by the Qt
xcbplatform plugin - Wayland client libraries
zlib
On Debian or Ubuntu the package list is roughly:
python3.12 python3.12-venv git build-essential pkg-config libglib2.0-dev libdbus-1-dev libgl1 libfontconfig1 libfreetype6 libx11-6 libx11-xcb1 libxext6 libxrender1 libxcb1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render0 libxcb-render-util0 libxcb-shape0 libxcb-shm0 libxcb-sync1 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxcb-util1 libxcb-ewmh2 libxkbcommon0 libxkbcommon-x11-0 libwayland-client0 zlib1g
Package names vary by distribution, so use the list above as the dependency checklist rather than assuming exact names.
Bluepy package requires special privileges when scanning for nearby devices. It is recomended to solve it by adding capabilities to the package:
cd <PYTHON_PATH>/site-packages/bluepy
sudo setcap 'cap_net_raw,cap_net_admin+eip' bluepy-helper
Go to directory where bluepy is installed (local user or system) and execute setcap as stated above.
This setting can be also done by executing script ./src/configure_bluepy.sh.
This solution might not work for virtual environment. See Working with venv section for workarounds.
To run application try one of:
- execute
linakdeskapporpython3 -m linakdeskappwhen installed - run
./src/linakdeskctlfrom local directory orlinakdeskctlwhen installed - execute
cd src && python3 -m linakdeskappfrom local directory
Application accepts following arguments:
usage: linakdeskapp [-h] [--connect CONNECT] [--desc] [--scan] [--minimized]
Linak desk application
options:
-h, --help show this help message and exit
--connect CONNECT BT address to connect to (default: None)
--desc Print description of connected BT and exit (default:
False)
--scan Scan nearby BT devices (default: False)
--minimized Start minimized (default: False)
Desk position can be operated through http GET requests. Before sending a requests
the web server have to be started. It can be done by activating chekcbox from WebServer.
Then http://localhost:8000 will be accessible from web browser. Visit the web page for possible commands.
Project contains several tools and features that facilitate development and maintenance of the project.
In case of pull requests please run process-all.sh --release before the request to check installation, run tests and
validate source code.
Installation for development without venv:
src/install-app.sh --devto install dependencies, the package in editable mode and install development tooling.
Installation for development (in virtual environment):
tools/installvenv.sh --devto install dependencies, the package in editable mode and install development tooling.
Virtual environmnt can be also configured manually by:
python3 -m venv .venvsource .venv/bin/activatepython -m pip install --upgrade pipsrc/install-app.sh --devto install dependencies, the package in editable mode and install development tooling orpython -m pip install -e '.[dev]'to install project by hand.
There is also possibility to work on the project without installation. In this case project will run from local repository
directory. This configuration requires installation of dependencies: ./src/install-deps.sh --dev.
For unknown reason fixing bluepy permissions inside virtual environment can be ineffective leading to problems with scanning for nearby bluetooth devices.
This problem can solved by one of two workarounds:
- executing application with
sudo(not recomended) - passing device's (desk) address by command-line argument
./src/linakdeskctl --connect {device_mac_address}
To run tests execute src/testlinakdeskapp/runtests.py. It can be run with code profiling and code coverage options.
In addition there is demo application not requiring Bluetooth connection. It can be run by testlinakdeskapp/gui/main_window_example.py.
In tools directory there can be found following helper scripts:
- codecheck.sh -- static code check using pycodestyle and flake8 against defined set of rules
- doccheck.sh -- run pydocstyle with defined configuration
- checkall.sh -- execute codecheck.sh and doccheck.sh at once
- profiler.sh -- profile Python scripts, e.g. ./tools/profiler.sh --cprofile ./src/linakdeskapp/main.py
- coverage.sh -- measure code coverate, e.g. ./tools/coverage.sh ./src/testlinakdeskapp/runtests.py
- notrailingwhitespaces.sh -- as name states removes trailing whitespaces from .py files
- rmpyc.sh -- remove all *.pyc files
Those scripts can be run also from within virtual environment.
To some extent there is possibility to test the application without physical device. linakdeskmock package was made
for this purpose.
To run mock simply execute ./src/linakdeskmock/main.py file.
Directory test/gatttool contains several scripts providing information about near devices such as:
- near LE devices,
- services, characteristics and descriptors of desired device,
- basic characteristics of desired device (name, manufacturer, version etc),
- listening to desk notifications
Some of dynamic properties of communication protocol of the desk was discovered by dedicated tool: BluetoothGattMitm.
The tool allows to intercept all BLE messages passed between the device and it's original Android application.
- use of EnumMeta class (linak_service.py)
- defining method decorators (synchronied.py)
- use of threading: Thread, Event, Timer
- use of QThreadPool and Worker concepts
- properly killing (Ctrl+C) PyQt (sigint.py)
- loading of UI files and inheriting from it
- embedding matplotlib graph with navigation toolbar into PyQt widget
- code profiling (cProfile)
- code coverage (coverage)
- handle cm/inch unit switch
- add fav buttons inside popup of system tray icon
- handle away from keyboard
- disabling light guidance does not seem to work. It seems to be problem on device side, because even in Linak app it does not work.
If You like the project or if it is valuable to You then feel free to support my work.
