Plugins/System

From EventGhost
Jump to: navigation, search
Plugin Information
Name System
Authors Bitmonster
Current Version1 1.0.0
Official Website N/A
Forum Page N/A
Source Code [1]
Type Core
Source Bundled
Minimum EventGhost Version N/A

1 This is the current version as of this page's last update. Newer versions may be available.

This wiki page may be out of date. Always consult the above website and forum links for possibly updated information.

This plugin controls different aspects of your system, like sound card, graphics card, power management, et cetera.

Configuration

This plugin has no configuration options.

Events

Event Payload? Enduring? Description
Event.pngSystem.Application.Terminated.application name[.suffix] N N May be triggered by Action.pngRun Application, if configured to do so.
Event.pngSystem.RunCommand[.suffix] N N May be triggered by Action.pngRun Command, if configured to do so.
Event.pngSystem.PlaySound.Completion.filename N N May be triggered by Action.pngPlay Sound, if configured to do so.

See also Built-In Events.

Actions: General

Run Application

Setting Default {·} Description
File or folder to open (no default) Y* Full path to the program you want to launch, or the folder you want to open.
Disable parsing of string False N If checked, disables Python variable parsing of the above option.
Command line options (no default) Y* Options to pass to the command line of the application you wish to run.
Disable parsing of string False N If checked, disables Python variable parsing of the above option.
Working directory (no default) Y? Change to this directory before running the application.
Wait until application is terminated before proceeding False N If checked, the macro containing this action will pause until the application has exited. If unchecked, the next step in the macro will be run immediately.
Trigger event when application is terminated False N If checked, EventGhost will trigger a Event.pngSystem.Application.Terminated.application name event when the application is closed.
Additional suffix (no default) Y* The event triggered will have this string appended to it (so, Event.pngSystem.Application.Terminated.application name.suffix.
Disable parsing of string False N If checked, disables Python variable parsing of the above option.
Disable WOW64 filesystem redirection for this application False N If checked, prevents WOW64 filesystem redirection.
Run as Administrator False N If checked, this application will be run with Administrator access. You will be prompted to confirm this action if you have <acronym title="User Account Control">UAC</acronym> enabled on your system.

Launches the specified application with the parameters you specify. If you specify a directory, this directory will be opened in Windows Explorer.


Run Command

Setting Default {·} Description
Command line (no default) Y* The command you wish to run, as you would enter it in the Windows Run dialog.
Disable parsing of string True N If checked, disables Python variable parsing of the above option.
Wait until command is terminated before proceeding False N If checked, the macro containing this action will pause until the command has completed. If unchecked, the next step in the macro will be run immediately.
Trigger event when command is terminated False N If checked, EventGhost will trigger a Event.pngSystem.WindowsCommand event when the is completed.
Additional suffix (no default) Y* The event triggered will have this string appended to it (so, Event.pngSystem.WindowsCommand.suffix.
Disable parsing of string True N If checked, disables Python variable parsing of the above option.
Disable WOW64 filesystem redirection for this application False N If checked, prevents WOW64 filesystem redirection.
Run as Administrator False N If checked, this application will be run with Administrator access. You will be prompted to confirm this action if you have <acronym title="User Account Control">UAC</acronym> enabled on your system.

Runs the specified command.


Copy to Clipboard

Copy a string you specify (which may contain Python variable expansion) to the Windows clipboard.

Get Boot Timestamp

Returns (in eg.result) the time at which your computer most recently booted. If you leave "Return result as an UNIX timestamp" checked (the default), the result is a floating-point number of seconds since January 1, 1970. If you clear this checkbox, the result is a string representing the date and time of last boot.

Get Uptime

Returns (in eg.result) a value representing how long your computer has been running since the last boot. If you leave "Return result as the number of seconds (ticks)" checked (the default), the result is the floating-point number of seconds that have passed since your computer was last booted. If you clear this checkbox, the result is a string in the format "1 day, 20:08:47" -- that is, the number of days, hours, minutes and seconds since your computer was booted.

Open/Close Drive Tray

Lets you open, close, or toggle the open/closed state of the specified optical (CD/DVD/BD) drive.

Refresh Environment

When a program launches, it inherits the current environment from the program that launched it, and EventGhost is no different. By default, if you modify an environment variable, EventGhost won't pass your changes along to the programs it launches because it doesn't know those changes took place. If you update your %PATH%, for example, then open a Command Prompt from EventGhost, you'll find you're unable to run commands from the new folders you've added.

In the past, the only solution to this problem was to restart EventGhost. Now, with the aid of this action (or "Refresh environment before executing Run actions" in Options), EventGhost can read the latest environment variables from the registry, apply them to its own environment, and thereby pass them along to anything it launches going forward.

Reset Idle Time

Resets your system idle timer to 0, acting as if a user has started using the computer again (such as by pressing a key or moving the mouse).

You may find it useful to add this action to macros which process events from unusual input devices, such as remote controls, so that using the device is equivalent to using a keyboard or mouse -- for example, in preventing or deactivating the screensaver.

Set Idle Time

Makes Windows act as if the system has been idle, optionally after waiting a number of seconds that you specify.

You may find it useful to add this action to macros which simulate keyboard or mouse input, if you find these macros are preventing your screensaver from activating as early as it should.

Wake on LAN

Sends a special network packet over your LAN which attempts to "wake up" the device with the specified MAC address.

To find the MAC address of your chosen device, see if it has a network settings configuration menu you can enter. You may also find it printed on a sticker on the bottom or back of the networked device.

Not all networked devices support this ability by default. For example, Windows itself must be configured to enable it. Other devices do not support it at all.

Actions: Audio

Change Master Volume

Setting Default {·} Description
Device your current audio output device N Which audio device to adjust the volume of.
Change master volume by N percent 0.00 N Amount by which to adjust the volume.

Adjusts the master volume level by the given amount of its current level. Negative values lower the volume, while positive values raise it.

The volume cannot be raised above 100 or below 0.


Get Mute Status

Setting Default {·} Description
Device your current audio output device N Which audio device to query the mute status of.

Queries the selected device to see whether or not it is muted. eg.result is populated with the number 1 if the device is muted, or 0 if it is not.


Play Sound

Setting Default {·} Description
Path to sound file (no default) Y Full path to the sound file you wish to play. Only supports files in the WAV format.
Wait for completion False N If checked, your macro will pause until the sound has finished playing.
Trigger event after completion False N If checked, a Event.pngSystem.PlaySound.Completion.filename event will be triggered once the sound has finished playing.

Plays the .WAV file you specify over the current default sound device.


Set Master Volume

Setting Default {·} Description
Device your current audio output device N Which audio device to set the volume of.
Set master volume to N percent 0.00 N Absolute volume to which to set the volume.

Sets the master volume level to the given amount. The lowest volume is 0.00, which is inaudible; the highest (loudest) volume is 100.00.


Toggle Mute

Setting Default {·} Description
Device your current audio output device N Which audio device to toggle the mute status of.

If the specified audio device is unmuted, mute it; otherwise, unmute it.


Turn Mute On

Setting Default {·} Description
Device your current audio output device N Which audio device to mute.

Mute the specified audio device.


Turn Mute Off

Setting Default {·} Description
Device your current audio output device N Which audio device to unmute.

Unmute the specified audio device.


Actions: Display

Change Display Settings

Setting Default {·} Description
Display System-dependent N The display to reconfigure.
Resolution, Frequency, Colour Depth System-dependent N Specify new display settings.
Include modes this monitor might not support False N When checked, additional modes are available in the above settings. This does not affect the action's execution.
Store mode in the registry False N When checked, the new display mode is stored as Windows' new default.

Reconfigures the specified display with your new settings.


Change Wallpaper

Changes your desktop wallpaper image. You may specify the path to the new image file (including Python variable expansion if desired), and whether you want the image to be stretched, centered, or tiled (the default).

Display Image

Setting Default {·} Description
Window disappears after N seconds 10 N How long the image should be shown, in seconds. If set to 0, the image is displayed indefinitely, and may only be removed by Action.pngHide Image.
Path to image or base64 string (no default) Y? The full path to the new wallpaper image, or a base64 string encoding of the new image.
Name of image (no default) Y? A name for the image, which can be used with Action.pngHide Image.

This action displays an image on the screen, over top of everything else. There are many more options than those at left for customizing how the image should appear.

It is possible to choose a combination of options which prevents the user from dismissing the image on their own. Use caution when doing this, and ensure that it's always possible for a matching Action.pngHide Image action to be called which can remove the image.


Hide Image

Hides an image that has been displayed using Action.pngDisplay Image. The one argument is the name you gave the image when displaying it. This argument probably supports Python variable expansion.

Set Display Preset

Changes the settings of the specified display to match the desired preset.

To configure this action:

  1. Configure your display settings in Windows to what you wish this action to recreate.
  2. Open this action's configuration dialog.
  3. Click Query current display settings.
  4. Click on the row which represents the display and settings you wish to configure.
  5. Click OK to save the settings.

Show Picture

Displays an image on the specified monitor, scaling it to fit in the monitor. You will specify the full path to the picture (using python variable expansion if desired).

Once displayed, the only way to make the image disappear is to run another Action.pngShow Picture action, with its path to the picture left blank. There is no other way for the user to dismiss the image. Use caution when using this action, and ensure that it's always possible for another Action.pngShow Picture action to be called which can remove the image.

Show QR Code

Currently seems to be broken.

Start Screensaver

Starts the user's default screensaver.

Turn On Monitor

Turns on any attached monitors that have are in low-power or power-off mode. Also disables any running screensaver.

Not all monitors support being turned on in this manner.

Turn Off Monitor

Sets the state of all attached monitors to power-off mode. This will be the most power-saving mode the display supports.

Turn Off Monitor (Standby)

Sets the state of all attached monitors to low-power mode.

Actions: Power

Hibernate

Suspends the system by shutting down and entering a hibernation (S4) state.

You may optionally configure this action to attempt to force-close all open applications before entering this state.

Lock Workstation

Locks your workstation against unauthorized access. Equivalent to pressing Win+L, or pressing Ctrl+Alt+Del and selecting Lock Workstation.

The currently logged-in user will need to enter their password in order to unlock the workstation.

Reboot

Shuts down Windows and reboots the system.

You may optionally configure this action to attempt to force-close all open applications before rebooting.

Set System Idle Timer

Enables or disables the system idle timer. Disabling this timer prevents your system from automatically entering a low-power state when it has not received user input (specifically from keyboard or mouse events) after a certain amount of time.

Shut Down

Shuts down Windows and powers off the system.

You may optionally configure this action to attempt to force-close all open applications before powering off.

Sign Out

Signs out the currently logged-in user. You will need to log in to Windows again in order to continue using it.

Sleep

Suspends the system by shutting down and entering a suspend (sleep) state.

You may optionally configure this action to attempt to force-close all open applications before entering this state.

Actions: Registry

Change Registry Value

Setting Default {·} Description
Key (no default) N Registry key to change.
Action Create or change N Whether to create a new key, only change the key if it exists, or delete it if it exists.
New value (no default) Y* The new value to set for this registry key.
Disable parsing of string False N If checked, disables Python variable expansion for the prior setting.
Type Auto N Registry key type, when creating a new key.

Allows you to do one of the following operations on the Windows Registry:

  • Set a new value for a registry key, creating it if it exists.
  • Set a new value for a registry key if it exists, doing nothing otherwise.
  • Remove a registry key.


Query Registry

Setting Default {·} Description
Key and Value name (no default) N Registry key to query.
Action Check if exists N See right.

This action lets you query for a specific key in the Windows Registry. There are three ways in which you can query a key:

  1. Test if the key exists. The result (True if it exists or False if not) is placed in eg.result.
  2. Return the key's value if it exists. This is returned in eg.result.
  3. Test whether the key's value is equal to the value you specify. The result is True if the values are identical, and False otherwise, and is placed in eg.result.

See Also