Skip to content

README.md

Latest commit

 

History

History
76 lines (44 loc) · 2.31 KB

README.md

File metadata and controls

76 lines (44 loc) · 2.31 KB
Raw

Build and Release Dynamic JSON Badge

Terminal User Interface (TUI) plugin for MADS

This is a Source plugin for MADS.

It provides an interactive Teminal User Interface to send commands and markers to the MADS network. It is an easier to compile replacement for the QT6 MADSMetadata app.

This plugin has been updated for MADS v2

Supported platforms

Currently, the supported platforms are:

  • Linux
  • MacOS
  • Windows (NOT TESTED!)

Package install

with MADS v2.1.1 or later, install with:

mads package --install tui.plugin

Install from binaries

Linux and MacOS:

cmake -Bbuild -DCMAKE_INSTALL_PREFIX="$(mads -p)"
cmake --build build -j4
sudo cmake --install build

Windows:

cmake -Bbuild -DCMAKE_INSTALL_PREFIX="$(mads -p)"
cmake --build build --config Release
cmake --install build --config Release

A note on the agent name/PUB topic

All plugins use their own name (without the .plugin extension) as the PUB topic. This means that the default PUB topic for tui.plugin is going to be tui. Since the logger agent is expecting to receive commands on the metadata topic, you need to change name of the tui plugin agent to metadata; you can do that in two ways:

  • by setting pub_topic = "metadata" in the [tui] section of the  mads.ini file, see the next section;
  • or on the command line, by using the -n metadata option.

The first is the recommended way, as it allows to keep the agent name in the mads.ini file and avoid having to remember to pass the -n option every time you run the plugin.

INI settings

The plugin supports the following settings in the INI file:

[tui]
pub_topic = "metadata" # NOTHE THIS!!!
silent = false # Avoids polluting the console with debug messages

All settings are optional; if omitted, the default values are used.

Executable demo

It allows to test TUI layout and functionality.