nymea-plugins/commandlauncher
Simon Stürz f9a5bfa55e commandlauncher: Add Qt6 support 2025-08-11 17:37:19 +02:00
..
translations
README.md
commandlauncher.pro
commandlauncher.svg
integrationplugincommandlauncher.cpp
integrationplugincommandlauncher.h
integrationplugincommandlauncher.json
meta.json

README.md

Application and Bashscript Launcher

This plugin allows you to execute system commands and start bash scripts.

Usage

Application launcher

The application launcher allows you to call bash applications or commands with parameters from nymea. Once, the application started, the running state will change to true, if the application is finished, the running state will change to false.

Example

An example command could be espeak. (apt-get install espeak)

espeak -v en "Chuck Norris is using nymea"

Bash script launcher

The bashscript launcher allows you to start a bash script (with parameters) from nymea. Once, the script is running, the running state will change to true, if the application is finished, the running state will change to false.

Example

An example for a very useful script could be a backup scrip like following backup.sh script.

#!/bin/sh
# Directories to backup...
backup_files="/home /etc /root /opt /var/www /var/lib/jenkins"

# Destination of the backup...
dest="/mnt/backup"

# Create archive filename...
day=$(date +%Y%m%d)
hostname="nymea.io"
archive_file="$day-$hostname.tgz"

# Print start status message...
echo "Backing up $backup_files to $dest/$archive_file"
date
echo

# Backup the files using tar.
tar czf $dest/$archive_file $backup_files

echo
echo "Backup finished"
date
echo "==========================="
echo "  DONE, have a nice day!   "
echo "==========================="

To make the script executable use following command:

chmod +x backup.sh

Supported Things

  • Application launcher
    • Enter command during thing setup
    • Get running state
    • Trigger and kill the command
  • Bashscript launcher
    • Enter script during thing setup
    • Get running state
    • Trigger and kill the script

Requirements

  • The package “nymea-plugin-commandlauncher” must be installed.

More

https://ubuntu.com/tutorials/command-line-for-beginners