Skip to content

dabamos/dmpack

Repository files navigation

Deformation Monitoring Package (DMPACK)

Build License Version

DMPACK is a free and open-source software package for IoT-based automatic deformation monitoring and distributed control measurements in engineering geodesy and geotechnics. The project is the successor of OpenADMS, and in active development.

The library and the accompanying programs are written in Fortran 2018, with some smaller parts in Lua. At the moment, DMPACK runs on 64-bit Linux and FreeBSD only.

Breaking API changes have to be expected until version 1.0.0.

Description

DMPACK is a scientific monitoring system developed for automated control measurements of buildings, infrastructure, terrain, geodetic nets, and other objects. The software runs on sensor nodes, usually IoT gateways, industrial embedded systems, or single-board computers, and obtains observation data from arbitrary sensors, like robotic total stations, digital levels, inclinometers, weather stations, or GNSS receivers. The raw sensor data is then processed, stored, and optionally transmitted to a server. The software package may be used to monitor objects like:

  • bridges, tunnels, dams
  • motorways, railways
  • construction sites, mining areas
  • landslides, cliffs, glaciers
  • churches, monasteries, and other heritage buildings

DMPACK is built around the relational SQLite database for time series and log storage on client and server. The server component is optional. It is possible to run DMPACK on clients only, without data distribution. The client-side inter-process communication is based on POSIX message queues and POSIX semaphores.

System Architecture

Schema

Features

DMPACK includes modules for:

  • sensor control (RS-232/422/485, 1-Wire, file system, sub-process)
  • SQLite database access
  • message passing via POSIX message queues
  • inter-process communication via POSIX semaphores
  • data serialisation (ASCII, CSV, JSON, JSON Lines, HDF5, Fortran 95 Namelist)
  • server-side web applications (CGI, FastCGI)
  • HTTP-RPC API for remote procedure calls
  • concurrent data synchronisation between client and server
  • client status messages (heartbeats)
  • distributed logging
  • Leica GeoCOM API for Fortran
  • time series plotting
  • Lua scripting
  • MQTT connectivity
  • HTML5 reports
  • Atom XML web feeds
  • e-mail via SMTP
  • compression (deflate, zstd)
  • regular expression matching
  • configuration file evaluation
  • command-line argument parsing

Requirements

DMPACK has the following requirements:

  • Linux or FreeBSD operating system
  • 64-bit platform (x86-64, AArch64)
  • Fortran 2018 and ANSI C compiler (GCC, Intel oneAPI)

Third-party dependencies have to be present to build and run the software of this package:

  • FastCGI
  • Gnuplot
  • HDF5
  • LAPACK
  • libcurl
  • Lua 5.4
  • PCRE2
  • SQLite 3
  • zlib
  • zstd

On Linux, additional development headers are required for the build step. To generate the man pages, the user guide, and the source code documentation, you will need furthermore:

Program Overview

The following programs are based on the DMPACK library.

Name Description
dmapi FastCGI-based HTTP-RPC API service.
dmbackup Creates online backups of DMPACK databases.
dmbeat Sends status messages (heartbeats) periodically to RPC service.
dmdb Stores observations received from message queue in database.
dmdbctl Command-line interface to observation databases.
dmexport Exports database records to file.
dmfeed Creates Atom feeds in XML format from log messages.
dmfs Reads sensor values from file system (file, named pipe, OWFS).
dmgrc Generates log messages from GeoCOM return codes.
dmimport Imports CSV file into database.
dminfo Prints system and database information as key–value pairs.
dminit Creates and initialises DMPACK databases.
dmlog Sends log messages to logger via message queue.
dmlogger Stores log messages received from message queue in database.
dmlua Runs Lua script to handle observations received from message queue.
dmpipe Reads sensor values from sub-process.
dmplot Generates plots from observations in database.
dmrecv Receives logs and observations from message queue.
dmreport Creates HTML reports of plots and/or log messages.
dmsend Sends observations and logs to message queue.
dmserial Reads sensor values from serial port.
dmsync Synchronises local databases with RPC API (from client to server).
dmuuid Generates UUID4s.
dmweb CGI-based web user interface for database access (client, server).

Installation

The DMPACK library and programs have to be built from source by either executing the provided Makefile, or by using the Fortran Package Manager. See the User Guide for complete installation instructions.

FreeBSD

First, install the build and run-time dependencies:

$ doas pkg install archivers/zstd databases/sqlite3 devel/git devel/pcre2 devel/pkgconf \
  ftp/curl lang/gcc lang/lua54 math/gnuplot math/lapack science/hdf5 www/fcgi

Instead of math/gnuplot, you may want to install math/gnuplot-lite which does not depend on X11 (but lacks raster graphic terminals).

Optionally, install Pygments and AsciiDoctor to generate the man pages and the User Guide from source:

$ doas pkg install devel/rubygem-pygments.rb textproc/rubygem-asciidoctor

The Git repository has to be cloned recursively. Otherwise, you will need to download the sub-modules manually by executing fetchvendor.sh. Then, run the Makefile:

$ git clone --depth 1 --recursive https://github.com/dabamos/dmpack
$ cd dmpack/
$ make freebsd

You can change the installation prefix with argument PREFIX (by default, /usr/local). To install the library and all programs system-wide, run:

$ doas make install PREFIX=/opt

Linux

On Debian, install GCC, GNU Fortran, and the build environment:

$ sudo apt install gcc gfortran git make pkg-config

The third-party dependencies have to be installed with development headers:

$ sudo apt install --no-install-recommends libblas-dev liblapack-dev \
  curl libcurl4 libcurl4-openssl-dev libfcgi-bin libfcgi-dev gnuplot \
  libhdf5-dev lua5.4 liblua5.4 liblua5.4-dev libpcre2-8-0 libpcre2-dev \
  sqlite3 libsqlite3-dev zlib1g zlib1g-dev libzstd1 libzstd-dev

Instead of package gnuplot, you can install the no-X11 flavour gnuplot-nox alternatively, if raster image formats are not desired (SVG output only).

Clone the DMPACK repository recursively, or download the master branch and run fetchvendor.sh, then execute the Makefile:

$ git clone --depth 1 --recursive https://github.com/dabamos/dmpack
$ cd dmpack/
$ make linux

Install the library and all programs system-wide to /usr/local:

$ sudo make install

To install to a custom directory, run:

$ sudo make install PREFIX=/opt

Updates

Update the cloned source code repository and its submodules with Git:

$ git pull
$ git submodule update --remote
$ make purge
$ make [freebsd|linux]

Library

Name Description
libdmpack.a DMPACK static library.
libdmpack.so DMPACK shared library.

Either link your programs against static library libdmpack.a, or -ldmpack if libdmpack.so is in your library search path, for example:

$ gfortran -I/usr/local/include/dmpack -o example example.f90 /usr/local/lib/libdmpack.a

Depending on which parts of the DMPACK library are used by third-party applications, additional shared libraries have to be linked. The directory containing the DMPACK module files is passed through argument -I.

Module Libraries Linker Libraries
dm_config Lua 5.4 pkg-config --libs lua-5.4
dm_db SQLite 3 pkg-config --libs sqlite3
dm_fcgi FastCGI -lfcgi
dm_hdf5 HDF5 pkg-config --libs hdf5_fortran
dm_la LAPACK, BLAS pkg-config --libs lapack blas
dm_lua Lua 5.4 pkg-config --libs lua-5.4
dm_lua_api Lua 5.4 pkg-config --libs lua-5.4
dm_lua_geocom Lua 5.4 pkg-config --libs lua-5.4
dm_mail libcurl pkg-config --libs libcurl
dm_mqtt libcurl pkg-config --libs libcurl
dm_mqueue POSIX -lrt
dm_mutex POSIX -lpthread
dm_regex PCRE2 pkg-config --libs libpcre2-8
dm_rpc libcurl, zlib, zstd pkg-config --libs libcurl zlib libzstd
dm_sem POSIX -lpthread
dm_thread POSIX -lpthread
dm_transform LAPACK, BLAS pkg-config --libs lapack blas
dm_z zlib, zstd pkg-config --libs zlib libzstd
dm_zlib zlib pkg-config --libs zlib
dm_zstd zstd pkg-config --libs libzstd

Source Code Structure

Path Description
adoc/ AsciiDoc source files of man pages.
app/ Source of programs based on DMPACK.
config/ Example configuration files.
dist/ DMPACK libraries and executables.
doc/ Source code documentation generated by FORD.
guide/ User Guide source and output files.
include/ Fortran module files (required for linking).
lib/ Fortran interface libraries (required for linking).
man/ Generated man pages (includes HTML and PDF exports).
share/ Example files, style sheets, scripts, and so on.
src/ Source of DMPACK library modules.
test/ Test programs for DMPACK modules.
vendor/ Third-party dependencies.

Manual Pages

To create all DMPACK man pages from source, run:

$ make man

The output files are written to man/.

User Guide

To convert the User Guide from AsciiDoc to HTML, run:

$ make guide

The result is written to guide/guide.html.

Source Code Documentation

The source code documentation of the DMPACK library has to be created with FORD. Install the Python package with:

$ python3 -m pip install -U ford

In the DMPACK repository, run:

$ make doc

The HTML files will be written to directory doc/. Open index.html in a web browser.

Licence

ISC