Giter Club home page Giter Club logo

ezcellular's Introduction

EzCellular

Library to easily handle, control and monitor cellular modems, using the ModemManager D-Bus API.

Dependencies

# compiler and libraries
sudo apt install build-essential libsdbus-c++-dev libsystemd-dev meson modemmanager-dev pkg-config

# for documentation
sudo apt install devhelp doxygen graphviz gtk-doc-tools \
        modemmanager-doc libmm-glib-doc network-manager-dev libsdbus-c++-doc

Build and Install Library

[RECOMMENDED] Build Debian Package (for Ubuntu, Debian, Raspbian, ...)

# dependencies for debian packaging
sudo apt install debhelper devscripts
# build .deb packages (will be placed into parent directory)
debuild --no-sign -b
# install built packages (and missing dependencies)
sudo debi --with-depends

Example code with be installed into /usr/share/libezcellular/examples/

[Alternative] Manually Build and Install into /usr/local

  • See meson_options.txt for options
# build everything
meson setup build --libdir=lib -Ddocs=true -Dexamples=true
# install (replace "install" with "uninstall" to remove everything)
sudo ninja -C build install

Usage

How to use and link against this library

Options (from most to least recommended):

An example Meson project definition meson.build.example is part of the example files. Just rename it to meson.build and adjust contents as needed.

Documentation

The code documentation is automatically built using doxygen, if enabled in the build configuration (-Ddocs=true). If you have installed the Debian package, you will find it here: file:///usr/share/doc/ezcellular/html/index.html.

Development Notes

Running clang-tidy

clang-tidy ezcellular/* -- -x c++ -I/usr/include/ModemManager -std=c++17

Project Background and License

This library was created as part of Oliver Kästner's master's thesis in the Laboratory for High Frequency Technology and Mobile Communication at the Osnabrück University of Applied Sciences, under the supervision of Prof. Ralf Tönjes and Julian Dreyer. Prof. Ralf Tönjes agreed to release this software as open source.

This library is therefore released under the GNU Lesser General Public License (LGPL) v3.0 or later (see COPYING).

ezcellular's People

Contributors

okaestne avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

juliand267

ezcellular's Issues

Missing Dependencies

On a fresh Ubuntu 22.04 LTS install, the following libraries need to be installed as well. Otherwise, debuild will fail:

sudo apt install doxygen debhelper-compat libsystemd-dev

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.