Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helium/ebus-connman
An erlang connman client using ebus
https://github.com/helium/ebus-connman
connman erlang erlang-library networking
Last synced: 5 days ago
JSON representation
An erlang connman client using ebus
- Host: GitHub
- URL: https://github.com/helium/ebus-connman
- Owner: helium
- License: apache-2.0
- Created: 2018-10-29T13:26:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-23T12:31:16.000Z (over 3 years ago)
- Last Synced: 2024-04-14T17:00:27.718Z (7 months ago)
- Topics: connman, erlang, erlang-library, networking
- Language: Erlang
- Size: 698 KB
- Stars: 5
- Watchers: 30
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Travis][travis badge]][travis]
[![Hex.pm Version][hex version badge]][hex]
[![Hex.pm License][license badge]][license]
[![Erlang Versions][erlang version badge]][erlang]
[![Build Tool][build tool]][rebar]
# ebus-connman
The `connman` application provides an Erlang binding for the [connman]
connection manager.
* [Features](#features)
* [Install](#install)
* [Examples](#examples)
* [Building](#building)
## Features
* Get current available services
* Connect to an SSID by name instead of Service ID
* Notifications on connectivity state changes.
## Install
Add `ebus-connman` to your `deps` section in `rebar.config`:
``` shell
{deps, [connman]}.
```
To ensure that connman is tarted when your application starts also add
it to the `applications` section in your application's `.app.src`
file. For example:
``` erlang
{application, my_app,
[{description, "An application using connman"},
{vsn, "git"},
{registered, []},
{applications,
[kernel,
stdlib,
connman
]},
{env,[]}
]}.
```
## Examples
### Get Services
Here's an example of talking to [connman] to get the current list of
connectivity related technologies:
```erlang
Eshell V10.1 (abort with ^G)E
1> {ok, C} = connman:connman()
{ok,<0.221.0>}
2> connman:services(C).
{ok,[{"/net/connman/service/wifi_a0c589a1baee_425452205570706572204150_managed_psk",
#{"AutoConnect" => true,
"Domains" => ["Home"],
"Domains.Configuration" => [],
"Ethernet" =>
#{"Address" => "A0:C5:89:A1:BA:EE","Interface" => "wlp2s0",
"MTU" => 1500,"Method" => "auto"},
"Favorite" => true,
"IPv4" =>
#{"Address" => "192.168.2.60","Gateway" => "192.168.2.1",
"Method" => "dhcp","Netmask" => "255.255.255.0"},
"IPv4.Configuration" => #{"Method" => "dhcp"},
"IPv6" => #{},
"IPv6.Configuration" =>
#{"Method" => "auto","Privacy" => "disabled"},
"Immutable" => false,"Name" => "BTR Upper AP",
"Nameservers" => ["192.168.2.1"],
"Nameservers.Configuration" => [],"Provider" => #{},
"Proxy" => #{"Method" => "direct"},
"Proxy.Configuration" => #{},
"Security" => ["psk"],
"State" => "online","Strength" => 58,
"Timeservers" => ["192.168.2.1"],
"Timeservers.Configuration" => [],"Type" => "wifi",
"mDNS" => false,"mDNS.Configuration" => false}}]}
```
### State Change Notifications
To get notified when connectivity of the system changes, call
`register_state_notify`. As an example:
```erlang
Eshell V10.1 (abort with ^G)E
1> {ok, C} = connman:connman()
{ok,<0.221.0>}
2> connman:register_state_notify(self()).
ok
```
Now when the state of the network changes, the given handler pid will
receive a message:
``` erlang
10> flush().
{state_changed, online}
```
The values for state are the atom versions of the connman connectivity
names: `offline`, `idle`, `ready`, `online`. Refer to the connman
documentation for the latestdocumentation on the meaning of the state
names.
### Connect to an SSID
As an extension of normal connman behavior the API allows connecting
to an SSID by name and given a password will block until the
connection is established or fails. `connman` will try to find the
given SSID and will attempt to connect to it.
``` erlang
Eshell V10.1 (abort with ^G)E
1> {ok, C} = connman:connman().
{ok,<0.257.0>}
2> connman:connect(C, wifi, "My Access Point", "My AP Password").
ok
```
## Building
Fork the repo and simply use `make` to build the library.
[travis]: https://travis-ci.com/helium/ebus-connman
[travis badge]: https://img.shields.io/travis/com/helium/ebus-connman/master.svg?style=flat-square
[hex]: https://hex.pm/packages/connman
[hex version badge]: https://img.shields.io/hexpm/v/connman.svg?style=flat-square
[license]: https://github.com/helium/ebus-connman/blob/master/LICENSE
[license badge]: https://img.shields.io/github/license/helium/ebus-connman.svg
[erlang version badge]: https://img.shields.io/badge/erlang-21.1-blue.svg?style=flat-square
[build tool]: https://img.shields.io/badge/build%20tool-rebar3-orange.svg?style=flat-square
[connman]: https://01.org/connman
[rebar]: http://rebar3.org
[erlang]: http://erlang.org