DMPACK User Guide

Creates an online backup of a database by either using the SQLite backup API or VACUUM INTO.

Stores observations received from POSIX message queue in a SQLite database.

A command-line interface to the DMPACK observation database, to read, add, update, or delete nodes, sensors, and targets.

Exports beats, nodes, sensors, targets, observations, and logs from database to file, either in CSV, JSON, or JSON Lines format.

Imports nodes, sensors, targets, observations, and logs from CSV file into database.

Creates and initialises observation, log, and beat databases.

A utility program to send log messages from command-line or shell script to the POSIX message queue of a dmlogger process, to be stored in the log database.

Stores logs received from POSIX message queue in a SQLite database.

Receives logs or observations from POSIX message queue and writes them to stdout, file, or named pipe.

Sends observations or logs from file to a DMPACK application via POSIX message queue.

Inspects received observations and creates log messages from GeoCOM return codes.

Runs a custom Lua script to process observations and forward them to the next specified receiver.

Creates line plots of time series read from database, with output to file, terminal, or X11 window. Uses gnuplot(1) internally as plotting back-end.

Creates HTML reports containing plots and optionally log messages.

A FastCGI-based HTTP-RPC service that provides an API for node, sensor, target, observation, and log synchronisation, as well as heartbeat transmission. Clients may either send records to be stored in the server database, or request data of a given time range. Depending on the HTTP Accept header, the server returns data in CSV, JSON, JSON Lines or Namelist format. Requires a FastCGI-compatible web server, such as lighttpd(1).

Sends short status messages (heartbeats) periodically to a remote dmapi instance.

Accepts commands sent via XMPP/Jabber to monitor the status of sensor nodes.

Synchronises nodes, sensors, targets, observations, and log messages between client and dmapi server. Only uni-directional synchronisation from client to server is supported.

Reads sensor data from virtual file system, file, or named pipe. The program be used to read values from sensors connected via 1-Wire (OWFS). Observations are forwarded via POSIX message queue and/or written to file.

Sensor control program for Modbus RTU/TCP. Loads the observations to perform from a configuration file and either reads from or writes to Modbus registers.

A command-line utility to read a value from or write a value to a register of a Modbus RTU/TCP device.

Executes a program as a sub-process connected through an anonymous pipe and forwards the output via POSIX message queue. Optionally, observations are written to file or stdout.

Connects to a TTY/PTY serial port for sensor communication. The program sends requests to a connected sensor to receive responses. The program pre-processes the response data using regular expressions and forwards observations via POSIX message queue.

Reads status information of a connected Victron Energy MPPT solar charge controller or SmartShunt battery monitor, using the VE.Direct protocol.

Prints system and database information as key–value pairs to standard output.

A command-line tool to generate unique UUID identifiers (by default in hexadecimal format without hyphens).

Creates an Atom syndication feed in XML format (RFC 4287) from logs of given sensor node and log level. If the feed is served by a web server, clients can subscribe to it by using a feed reader or news aggregator. The program may be executed periodically as a cron job.

A CGI-based web user interface for DMPACK database access on client and server. Requires a web server and gnuplot(1).