ETM-Schurig/powersync-libnm
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
Simon Stürz 2025-11-17 12:43:57 +01:00
parent f21fd05a69
commit 7219b0fac6
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# libnymea-networkmanager
libnymea-networkmanager is the Qt/C++ helper library that lets nymea-based
systems talk to the Linux NetworkManager service over DBus. It provides
wrappers for wired and wireless devices, exposes network states and settings,
and can optionally spin up a Bluetooth Low Energy provisioning server so
headless appliances can be configured remotely.
## Features
- High-level API for tracking NetworkManager state, devices, and connections.
- Helpers for managing wired and Wi-Fi profiles, IP configuration, and DHCP.
- Optional BLE server that exposes provisioning services for remote setup.
- Designed to integrate with nymea daemons and other Qt applications.
## Documentation
The `docs/` folder contains the QDoc setup used to generate the API reference.
To build it locally run `qdoc docs/config.qdocconf` inside the repository root.
## License
libnymea-networkmanager is licensed under the GNU LGPL-3.0-or-later.
See `LICENSE.LGPL3` for the full text. The copyright is held by
nymea GmbH (2013‑2024) and chargebyte austria GmbH (2024‑2025).