An SSH Remote device file is used to predefine the look and feel of a target device configured  in the app. It is also the place to specify additional resources or a color scheme for your device. During the device configuration, you download an image file for a logo or script files from an online source.

Please note that everything defined in the device file is only downloaded once during creation and optionally on every device configuration change. There are no automatic updates and thus, changes in the device file might never reach your app, if you do not apply it manually.

The file is a text file with a simple format: every line is interpreted as a single item and the format of a line is as follows:

[Resource type]<Tab>[Resource path]

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

  • [Resource type] is the type of resource specified. It may only be one of the following values
    • logo
      • [Resource path] specifies a logo file that will be displayed everytime this device is selected in the app. This item may only be specified once.
    • init
      • [Resource path] specifies a script file with commands that will be executed once during device creation. This is useful for setting up firewall rules on the device or similiar configuration tasks. Of special interest is accepting SSH Remotes public key, if the key authentification method is used. In this case, this script file is the place to register the key on the target device. You may use the “$PUBLIC_KEY$” placeholder in the script file, which will be expanded to the unique public key used to connect to this specific device by the preprocessor. This item may only be specified once.
    • buttons
      • [Resource path] specifies a button file which defines the starting set of buttons. Of course these buttons can later be added to or removed from using the normal operations of the app. Please see the link for a definition of the button file format. This item may only be specified once.
    • script
      • [Resource path] specifies a script file to be downloaded to the app in order to be used as a script button. Please note that at this time, specifying a script file here is the only way to make it available to the app. This item may be specified multiple times.
    • color1
      • [Resource path] is a color code in the format “#RRGGBB” which is used as the apps primary color when this device is selected. If you do not specify this or use a wrong format, the fallback Firesource color theme will be used.
    • color2
      • [Resource path] is a color code in the format “#RRGGBB” which is used as the apps secondary color when this device is selected. If you do not specify this or use a wrong format, the fallback Firesource color theme will be used.
    • color2
      • [Resource path] is a color code in the format “#RRGGBB” which is used as the apps accent color when this device is selected. If you do not specify this or use a wrong format, the fallback Firesource color theme will be used.
  • [Resource path] is the path to the resource file defined by [Resource type]. Please note, that this is a relative path from the current location and sub-paths are not allowed.
    An example for a valid enty is

    logo	firesource.png

    If the device file is located at www.example.com/sshremote/mydevice.dev, then the logo file will be searched here:  www.example.com/sshremote/firesource.png

    An example for an invalid entry is

    logo	logos/firesource.png

 

An example file  might look like this:

logo	firesource.png
init	initfile.sh
script	myScript.sh
buttons	yayButtons.but