MinimServer

Home

Donate

Features

Downloads

Installing

Release notes

User guide

Support

Troubleshooting

Forum

MinimStreamer

License

UPnP AV

Technology

Contact

Latest news

Command scripting and Web API now available

Latest change

MinimServer update 96 has been released

Monitoring and control

Table of contents

Monitoring and control options
Running MinimWatch
Controlling MinimServer using the minim icon
Controlling MinimServer using console commands
Controlling MinimServer using command scripting
Controlling MinimServer using the Web API
Controlling MinimServer or MinimWatch using a named pipe [DEPRECATED]
MinimWatch logging

» User guide main contents

Monitoring and control options

If you're running MinimServer in a Windows, Mac OS X or Linux graphical desktop environment, you can monitor and control MinimServer using the minim icon that it displays. See the Controlling MinimServer using the minim icon section for information about using the MinimServer minim icon. Alternatively, if you're running MinimServer in a terminal window, you can monitor and control MinimServer using its console interface. See the Controlling MinimServer using console commands section for details of the available console commands.

You might not be able to monitor and control MinimServer by interacting with it directly. For example, you might be running MinimServer on a NAS with no user interface, or in a background Linux process with no interactive terminal input, or on a computer that isn't in a convenient location for you to access it directly. In all these situations, you can use MinimWatch to monitor and control MinimServer. The Running MinimWatch section gives details of how to install and run MinimWatch.

Running MinimWatch

MinimWatch provides a "remote control" capability for any instance of MinimServer running on your local metwork. MinimWatch provides a minim icon for use in a graphical desktop environment and a console interface for terminal interaction. With a few very minor differences, the MinimWatch icon and console interface work in exactly the same way as the MinimServer icon and console interface. See the Controlling MinimServer using the minim icon section for information about using the MinimWatch minim icon.

If you haven't already installed the MinimWatch distribution package on the computer that you want to use to run MinimWatch, see the Installing page for details of how to do this.

To start MinimWatch on Windows, select the Start Menu item for MinimWatch. Alternatively, you can double-click the MinimWatch desktop icon if you chose to create this during MinimServer installation.

To start MinimWatch on Mac OS X, open the MinimWatch application.

To start MinimWatch on Linux, please refer to the Starting and stopping MinimWatch on Linux section.

On Windows or Mac OS X, or if you're running Linux in a graphical desktop environment, MinimWatch will display a minim icon in the system tray or menu bar for each MinimServer instance running on another computer or NAS on your local network.

Note: Instances of MinimServer running on the same computer aren't displayed as MinimWatch icons. This would be confusing, because they're already displayed as MinimServer icons.

Alternatively, if you're running in a Linux "headless" environment with no graphical desktop, you'll get the MinimWatch console interface. This provides a command prompt for entering commands to control any MinimServer instance running on your local network, and it displays status messages from MinimServer instances. See the Controlling MinimServer using console commands section for details of the available console commands.

From version 0.8.4 onwards, you can also control MinimServer using command scripting or the Web API. For more information, see Controlling MinimServer using command scripting and Controlling MinimServer using the Web API

[DEPRECATED] On version 0.8.3 or earlier, the Linux versions of MinimServer and MinimWatch can run console commands sent via a local named pipe. This capability is now replaced by the new command scripting feature in version 0.8.4 and the named pipe facility will be removed completely in the next version of MinimServer and MinimWatch.

Controlling MinimServer using the minim icon

This section describes how to monitor and control MinimServer using the minim icon on a computer that's running either MinimServer or MinimWatch.

On Windows or Mac OS X, or if you're running Linux in a graphical desktop environment, you'll see a minim icon in the system tray or menu bar. You might see more than one minim icon if you've got more than one MinimServer instance running on your local network. The colour of the minim icon shows the status of the MinimServer instance:

The minim icon has a pop-up menu for controlling the MinimServer instance that the icon represents, and it displays hover text and status messages to show you the current status of this MinimServer instance. To display this pop-up menu on Windows or Linux, right-click the minim icon. To display the menu on Mac OS X, click the minim icon. The menu selections are as follows:

Rescan Rescans the library and restarts the stopped or running media server. If any of the media server's properties have been updated since the media server was last started, the updated property values will be used. The tray icon turns yellow while the media server is being stopped and restarted, then green (transparent on Mac OS X) when startup completes successfully.
Properties  Shows a dialog with current properties for the media server. You can use the entry fields and buttons to update property values. See the MinimServer properties page for details.
Show log Shows the log window. The log is updated continuously in real time.
About Shows a dialog with version and copyright information for the media server, together with information about the media server execution host.
Stop Stops the media server without exiting the MinimServer application. The tray icon turns white (pale blue on Mac OS X Yosemite or later) when the media server is stopped. You can use the Properties selection to update the media server's properties, then use the Restart selection to restart the media server with the updated property values.
Restart Restarts the stopped or running media server without rescanning the library. If any of the media server's properties have been updated since the media server was last started, the updated property values will be used. The tray icon turns yellow while the media server is being stopped and restarted, then green (transparent on Mac OS X) when startup completes successfully.
Close (MinimWatch only) Exits the remote MinimServer application. This removes the corresponding tray icon from MinimWatch.
Options (MinimWatch only) Shows a submenu with options for configuring and managing MinimWatch.
Refresh (MinimWatch only) Refreshes the status and tray icons of all remote media servers.
Exit If selected from the MinimServer minim icon, exits the local MinimServer application and removes its minim icon. If selected from the MinimWatch minim icon, exits the local MinimWatch application and removes all minim icons for remote instances of MinimServer.

Controlling MinimServer using console commands

This section describes how to monitor and control MinimServer using console commands on a computer that's running either MinimServer or MinimWatch.

If you're using the MinimServer or MinimWatch console interface, you can enter the commands listed below. The MinimServer console interface allows you to control the local instance of MinimServer that you started from this terminal window. The MinimWatch console interface allows you to control any local or remote MinimServer instance running on your local network. You can change the MinimServer instance selected for control by using the select command.

rescan Rescans the library and restarts the stopped or running media server. If any of the media server's properties have been updated since the media server was last started, the updated property values will be used.
props Shows the current properties for the media server. A multivalued property is displayed with {} enclosing each value. For example, a property multiProp with multiple values a, b and c would be displayed as multiProp={a}{b}{c}. See the Properties reference section for details of available properties.
prop n=v   Sets the media server's property n to value v. A multivalued property can be set by enclosing each value with {}. For example, you can set property multiProp to multiple values a, b and c with the command prop multiProp={a}{b}{c}. See the Properties reference section for details of available properties.
about Shows which media server is currently selected for control, and shows version and copyright information for this media server, together with information about its execution host and current status.
stop Stops the media server without exiting the MinimServer application. You can use the prop command to update the media server's properties, then use the restart command to restart the media server with the updated property values.
restart Restarts the stopped or running media server without rescanning the library. If any of the media server's properties have been updated since the media server was last started, the updated property values will be used.
close (MinimWatch only) Exits the remote MinimServer application.
select s (MinimWatch only) Selects media server s for control, where s is the display name of an active media server. You can see the display names of all active media servers by using the refresh command. To select MinimWatch instead of a media server, use the command select watch.
refresh (MinimWatch only) Shows the display names and status of all active media servers.
exit (or null line) If entered at the MinimServer command prompt, exits the local MinimServer application. If entered at the MinimWatch command prompt, exits the local MinimWatch application without exiting any remote instances of MinimServer.
packages   Shows installed packages (with status) and available packages.
install p Installs package p.
remove p Removes installed package p.
undo p Undoes a pending change to installed package p.
relaunch Relaunches the runtime and applies pending package changes.
modules Shows installed modules (with status).
updates Shows available updates for installed packages.
sleep t Delays execution for s seconds. This can be useful for scripting.
help (or ?) Shows the list of available commands.

Controlling MinimServer using command scripting

From version 0.8.4 onwards, you can send scripted commands to MinimServer using the mscript command. For details of how to do this, see the Command scripting section.

Controlling MinimServer using the Web API

From version 0.8.4 onwards, you can send commands to MinimServer using the Web API. For details of how to do this, see the Web API section.

Controlling MinimServer or MinimWatch using a named pipe [DEPRECATED]

[DEPRECATED] On version 0.8.3 or earlier, the Linux versions of MinimServer and MinimWatch can run console commands sent via a local named pipe. This capability is now replaced by the new command scripting feature in version 0.8.4 (see the Command scripting section) and the named pipe facility will be removed completely in the next version of MinimServer and MinimWatch.

MinimWatch logging

MinimWatch writes logging information to a log file. The MinimWatch log works in the same way as the MinimServer log (see MinimServer logging) except that you need to use the Options selection from the MinimWatch icon pop-up menu to view it.