Get network information with Connman and DBus
This module provides a simple API to query Connman using DBus.
Requirements
In addition to the requirements specified in the rockspec file, you need Connman (version 1.33 or higher) and DBus. Note that you may need permissions to access the Connman DBus interface.
Installation
Luarocks
This module can be installed with Luarocks by running
luarocks install connman_dbus
Use the --local option in luarocks if you don't want or can't install it
system-wide.
NixOS (flakes)
If you are on NixOS, you can install this package using nix flakes.
Example
Below is a small example of how to use the module:
connman = require("connman_dbus") print(connman.OfflineMode) -- e.g. true active_service = connman:GetServices()[1] print(active_service[1]) -- e.g. "/net/connman/service/wifi_12341234_abcdabcd_managed_psk" active_service_properties = active_service[2] print(active_service_service.Type) -- e.g. "wifi" print(active_service_service.State) -- e.g. "online" active_service = connman.services[1] print(active_service.object_path) -- e.g. "/net/connman/service/wifi_12341234_abcdabcd_managed_psk" assert(connman.services[active_service.object_path] == connman.services[1]) -- true (assuming that the service priority has not changed) active_service:Disconnect() tech = connman:GetTechnologies()[1] print(tech[1]) -- e.g. "/net/connman/technology/ethernet" tech_props = tech[2] tech_props.Name -- e.g. "wired" tech_props.Type -- e.g. "ethernet" tech_props.Powered -- e.g. true
Documentation
The documentation of this module is built using LDoc.
A copy of the documentation is already provided in the doc folder,
but you can build it from source by running ldoc . in the root of the repository.
Limitations
This module exposes the Connman Manager API and the Connman Service API. This is enough to get information about services and technologies, but does not allow one to implement a fully functional client.
Contributing
Feel free to contribute with pull requests and issue reports, but be advised that this project is developed in the author's own spare time.