An SSH Remote button file is used to preconfigure buttons as part of the device file deployment. With this, you can quickly and easily define a set of buttons.

The format is similar to the device file: Each line in the file stands for one button and is formatted like this:

[Button name]<Tab>[Button command or script file]<Tab>[Button type]

Please note: except for the separator tabs, no tab character (‘\t’) may be included in the file.

  • [Button name] is the name that will appear on the Button. It should be sufficiently short.
    • Example: “Off”
  • [Button command or script file] is either the raw command that will be executed or the name of a script file. It is only interpreted as a script file if the button type is “Script” (see below). In commands or scripts, the preprocessor can be used.
    • Example: “Set-Light -Color Black”
  • [Button type] can be one of the following:
    • SingleCommand
      • A single command will be executed. After the command has been executed and the output collected, the connection will be severed.
    • ShellCommand
      • A single command will be executed in shell mode. After the command has been executed, the connection will not be severed until either 10 minutes of silence have passed or the user terminates the command manually.
    • Script
      • A script file will be loaded and the commands within will be executed on the target system. After the last command has been executed, the connection will be severed. In this case and this case only, the [Button command or script file] field will be interpreted as the name of the script file to load.
      • No subfolders or paths are allowed. This only references the name of a script fileĀ  downloaded via the device file.

An example file that uses a fictional “Set-Light” command on a rasberry PI responsible for mood lighting might look like this:

Off	Set-Light -Color Black	SingleCommand
Pink	Set-Light -Color Pink	ShellCommand
AllRed	Script