Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefano-m/lua-connman_dbus
Get network information with Connman and DBus
https://github.com/stefano-m/lua-connman_dbus
connman dbus lua
Last synced: 2 months ago
JSON representation
Get network information with Connman and DBus
- Host: GitHub
- URL: https://github.com/stefano-m/lua-connman_dbus
- Owner: stefano-m
- License: apache-2.0
- Created: 2016-10-04T21:12:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-15T13:53:17.000Z (about 2 years ago)
- Last Synced: 2024-10-01T16:00:18.893Z (3 months ago)
- Topics: connman, dbus, lua
- Language: Lua
- Homepage: https://stefano-m.github.io/lua-connman_dbus/
- Size: 43.9 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Get network information with Connman and DBus
This module provides a simple API to query
[Connman](https://01.org/connman/)
using [DBus](http://dbus.freedesktop.org/).
# 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](http://luarocks.org/) 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:
```lua
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](https://stevedonovan.github.io/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](https://git.kernel.org/pub/scm/network/connman/connman.git/tree/doc/manager-api.txt)
and the [Connman Service
API](https://git.kernel.org/pub/scm/network/connman/connman.git/tree/doc/service-api.txt). 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.