Macros in Pierogi

In Pierogi, a "Macro" is not really a user-defined button; it is more like a "user-defined user". When you run a macro, you are subcontracting the work of controlling the Pierogi app to an automated script. While it runs, you will not have access to the Pierogi user interface. A dialog box will be displayed as the macro runs; you will be able to abort the macro by pressing the "abort" button in that dialog.

XML Syntax

As of Pierogi 1.1.32, the syntax of a Macro XML file is extremely limited. (Please be prepared for significant changes, as well as an actual DTD, in future updates.)

Macropack

The root element of the Pierogi XML file format is the "macropack"; it currently has a single attribute, "name", which allows you to give the pack a name. A macropack can contain an unlimited number of macro elements.

Macro

The "macro" element encapsulates an individual macro. It has three attributes: "name", "button", and "shortcut". The name attribute is required, and contains a string defining the macro's name. This name should be unique -- it is used internally by Pierogi as the macro's identifier. If two macros are given the same name, the results are undefined.

The "button" attribute is optional. The value for "button" is an integer, and corresponds to the user-defined buttons on the "Macros" panel; assigning the button's id number to the macro will cause that button to be associated with the macro. (Currently, values from 1 to 6 are supported.)

The "shortcut" attribute is also optional. The value for "shortcut" is a single character, and corresponds to the characters on the keyboard. Currently, values from A-Z are supported. Pressing the macro's associated key will execute the macro.

Examples

Here is a simple example that sends the "Power Button" key using the currently defined keyset:

<?xml version="1.0"?>

<macropack name="Power Button Example">

 <macro name="Power Button" button="1" shortcut="P">
  <send key="Power"/>
 </macro>

</macropack>

Here is a slightly more complex example. My low-end Sanyo HDTV does not support direct entry of digital subchannel numbers; therefore, to reach a particular channel, one must first type in the major channel number, then navigate to the minor channel using the up/down buttons. So, the following macros provide more direct access to interesting channels; channel 7-2 is weather, and 16-4 is a government access channel. I've defined my TV's specific keyset for these macros, so that I can use them even if Pierogi is currently set up for a different device.

<?xml version="1.0"?>

<macropack name="Local Channels on Bedroom TV">

 <macro name="Power Button" button="1" shortcut="P">
  <keyset make="Sanyo" name="TV Keyset 1"/>
  <send key="Power"/>
 </macro>

 <macro name="PBS" button="2">
  <keyset make="Sanyo" name="TV Keyset 1"/>
  <send key="1"/>
  <send key="6"/>
 </macro>

 <macro name="Local Weather" button="3">
  <keyset make="Sanyo" name="TV Keyset 1"/>
  <send key="0"/>
  <send key="7"/>
  <send key="Channel Up"/>
 </macro>

 <macro name="Ohio Government" button="4">
  <keyset make="Sanyo" name="TV Keyset 1"/>
  <send key="1"/>
  <send key="6"/>
  <send key="Channel Up"/>
  <send key="Channel Up"/>
  <send key="Channel Up"/>
 </macro>

</macropack>

Available Keys

As of Pierogi version 1.1.32, the following are the keys available for use in a "send" comamnd. Please note that Pierogi's parser currently requires the spelling of these commands to be exact, including capitalization.

Power Controls

Power: Toggle the target device on or off. (This command is referred to as "Standby" on some remotes.)
Power On: Turn the target device on. (Sending this command will not turn the device off if it is already on.)
Power Off: Turn the target device off. (Sending this command will not turn the device on if it is already off.)

Menu Controls

Menu: Bring up the menu on the target device.
Up: Move up in the menu. (Note that on some devices, this can also control the volume or channel selection.)
Down: Move down in the menu. (Note that on some devices, this can also control the volume or channnel selection.)
Left: Move left in the menu. (Note that on some devices, this can also control volume or channel selection.)
Right: Move right in the menu. (Note that on some devices, this can also control volume or channel selection.)
Select: Activate the current chosen element of the menu. (On some devices, this key may be labeled "OK" or "Enter".)
Exit: Leave the menu without activating any elements.
Page Up: Scroll up through a long list of elements a screenful at a time.
Page Down: Scroll down through a long list of elements a screenful at a time.
Guide: Bring up the Guide on the target device.

Keypad Controls

0: Send a "0" to the target device.
1: Send a "1" to the target device.
2: Send a "2" to the target device.
3: Send a "3" to the target device.
4: Send a "4" to the target device.
5: Send a "5" to the target device.
6: Send a "6" to the target device.
7: Send a "7" to the target device.
8: Send a "8" to the target device.
9: Send a "9" to the target device.
Enter: Tell the target device that no more numbers will be coming. (Note that this is not the same command as "Select". Very few remote controls have a keypad with this key; far more use an "enter" key to select a menu element.)
Clear: Tell the target device to disregard the previous sequence of numbers.
+100: Used on some (old) TVs to construct a three-digit channel identifier.
-/--: Used on some (very old) TVs to construct a two-digit channel identifier.
-: Used to identify the subchannel of a digital broadcast channel. For example, to go to the second subchannel of channel 16, one would press "1", then "6", then "-", then "2". (On some TVs, this divider is represented as a dot rather than a dash.)

Channel Controls

Channel Up: Tell the device to switch to the preceding channel in the list. ("Channel" is referred to as "Programme" on some remotes.)
Channel Down: Tell the device to switch to the next channel in the list.
Previous Channel: Tell the device to return to the channel that was being watched most recently (if any).

Volume Controls

Volume Up: Increase the audio volume coming from the target device. This command will often increase the volume continuously for as long as it is sent.
Volume Down: Decrease the audio volume coming from the target device. This command will often decrease the volume continuously for as long as it is sent.
Mute: Turn off the volume from the target device. Normally, this is a toggle command, and will return the volume to the previous level if sent to a device that has been muted.
Surround Sound: This will normally be a toggle command, switching the device between "stereo" and "surround-sound" usage.
Rear Volume Up: Increase the volume from the rear speakers.
Rear Volume Down: Decrease the volume from the rear speakers.
Center Volume Up: Increase the volume from the center speakers.
Center Volume Down: Decrease the volume from the center speakers.
Woofer Up: Increase the volume from the woofer.
Woofer Down: Decrease the volume from the woofer.

Media Controls

Play: Begin playback of the selected media. (On many devices, this is a toggle button; if pressed when playing, it serves as a "Pause" command.)
Pause: Pause playback of the selected media. (On many devices, this is a toggle button; if pressed while paused, it will continue playback of the current media.)
Stop: Stop playback of the selected media.
Fast Forward: Move forward through the selected media at a rapid pace. This will normally continue for as long as the command is being sent.
Rewind: Move backwards through the selected media at a rapid pace. This will normally continue for as long as the command is being sent.
Play X2: Begin playback of the selected media at a slightly faster-than-normal pace. (Note that, unlike Fast Forward, this mode will often continue after the command has been sent.)
Next: Move to the next media item in the list.
Previous: Move to the previous media item in the list.
Step Forward: Move to the next frame of information in the current media. (Normally used to step through a video.)
Step Back: Move to the previous frame of information in the current media.
Advance: Move forward through the current media by a fixed amount. (For example, this may bypass 30 seconds of media on a particular device.)
Replay: Move backwards through the current media by a fixed amount. (For example, this may go back to where the media was 30 seconds ago on a particular device.)
Eject: Physically remove the current data storage medium from the device. For example, this could be a CD, DVD, or cassette tape.
Random: Switch to a random track of the currently selected media.
Repeat: Repeat the currently selected media.
RepeatAB: Repeat a selected portion of the media.
Slow: Play back the current media at a slower pace than normal. The effect of this command can vary from device to device.
Slow +: Speed up the playback of the media while in "slow" mode. (Very few devices support this command.)
Slow -: Slow down the playback of the media while in "slow" mode. (Very few devices support this command.)
Timer: Activate control of timers on the device.
Record: Begin recording the currently selected media. The details of how this occurs will vary from device to device.
Record Pause: Pause the current recording. This will normally be a toggle command, and will resume recording when sent to a device that has been paused. (This is a fairly rare command.)
Record Stop: Tell the device to stop recording.
Record Mute: Used in some very old devices to insert a blank space on a tape; also rarely found in some other high-end devices. Check your device manual for the exact results of sending this command.
Record Timed: Unlike the normal "record" command, this command will allow you to specify a particular duration that the device should continue recording.
Record PDC: Used in some VCRs to simplify recording a particular broadcast (using Teletext). Probably obsolete today.

Color Buttons

Originally created for use with Teletext, these buttons are now used for a wide array of purposes on most modern television sets.

Red: Send the Red command.
Green: Send the Green command.
Yellow: Send the Yellow command.
Blue: Send the Blue command.

Teletext Commands

To my understanding, Teletext existed mostly in Europe and some regions of Asia, and is currently being phased out even there. So, many of these commands will today be of little value...

Teletext: Begin teletext on the device. (This might be a toggle command.)
Teletext Reveal: Send the teletext "reveal" command.
Teletext Hold: Send the teletext "hold" command.
Teletext Size: Send the teletext "size" command.
Teletext Select: Send the teletext "select" command.
Teletext Time: Send the teletext "time" command.
Teletext Mix: Combine display of TV and teletext on screen.
Teletext Down: Send the teletext "down" command.
Teletext Up: Send the teletext "up" command.
Teletext Background TV: Display TV broadcast in backround of teletext.
Teletext Store: Send the teletext "store" command.
Teletext Index: Send the teletext "index" command.
Teletext Off: Turn off teletext.

Picture in Picture Commands

Some televisions support display of multiple sources of media at the same time, by overlaying the main screen with one or more miniature screens.

PIP: Turn on the picture-in-picture feature. (Normally, this is a toggle.)
PIP Swap: Exchange the media source between the main screen and the currently selected miniature screen.
PIP Move: Move the miniature screen to a different location on the main screen.
PIP Source: Choose the source of media for the miniature screen.
PIP Channel Up: Switch the miniature screen to the previous channel in the list.
PIP Channel Down: Switch the miniature screen to the next channel in the list.
PIP Pause: Pause the media displayed on the miniature screen.
PIP Size: Change the size of the miniature screen.

Disc Commands

These are commands generally found only on CD/DVD/Blu-ray devices.

Disc Title: Tell the device to display the media's Title screen. (Used only with DVDs and Blu-rays.)
Disc Menu: Tell the device to display the media's Menu screen. (Used only with DVDs and Blu-rays.)
Angle: Tell the device to switch to a different camera angle. (A very obscure command only used with certain DVDs and Blu-rays.)
Next Disc: Tell a multi-disc device to switch to the next disc in the collection.
Previous Disc: Tell a multi-disc device to switch to the previous disc in the collection.
Disc One: Tell a multi-disc device to switch to the first disc.
Disc Two: Tell a multi-disc device to switch to the second disc.
Disc Three: Tell a multi-disc device to switch to the third disc.

VHS (and Beta) Cassette Tape Commands

VHS Speed: Tell the device to switch between the available recording speeds. These are normally SP (standard play), LP (long play), EP (extended play), and SLP (super long play). Not all devices support all speeds.
Tracking +: Manually adjust the "tracking" of the tape upwards.
Tracking -: Manually adjust the "tracking" of the tape downwards.
Auto Tracking: Have the device automatically adjust the tracking of the tape.
Index Search: Have the device search for an index on the tape. (Also known as VISS.)
Index Mark: Have the device place an index mark on the tape.
Index Erase: Have the device remove an index mark on the tape.

Audio/Video Adjustment Controls

These are controls for direct adjustment of audio and video playback. (Most modern TVs have moved the majority of these controls into the menu system.)

Picture Mode: This will toggle between a TV's available picture modes.
Sound Mode: This will toggle between a TV's available sound modes.
Noise Reduction: Toggle noise reduction in the target device. (Called "Dolby" on many devices.)
Enhanced Bass: Toggles the enhanced or "super" bass mode of the device.
Bass Up: Increase the bass level of the device.
Bass Down: Decrease the bass level of the device.
Treble Up: Increase the treble level of the device.
Treble Down: Decrease the treble level of the device.
Brightness Up: Increase the screen's brightness.
Brightness Down: Decrease the screen's brightness.
Color Up: Increase the screen's color.
Color Down: Decrease the screen's color.
Contrast Up: Increase the screen's contrast.
Contrast Down: Decrease the screen's contrast.
Balance Right: Shift the stereo balance to the right.
Balance Left: Shift the stereo balance to the left.
Keystone: Shift the "keystone" adjustment made by the projector.
Picture Mute: "Mute" the picture displayed by the projector.
Focus: Adjust the focus of the projector.

Input Commands

These commands select the source of media to be played on the target device. In modern audio/video equipment, the possible list of media sources has grown absolutely enormous; as such, the following set of controls are not sufficiently comprehensive to support all the possible input commands on every device.

Input: Toggle between the entire list of available input sources.
CD Input: Switch to the Compact Disc media.
Phono Input: Switch to the Phonograph record media.
Tuner Input: Switch to the (AM/FM Radio) tuner.
Line Input: Switch to the "line input".
Tape Input
: Switch to the tape deck. (Specifically, the first tape deck, if there are more than one.)
Antenna Input: Switch to the antenna input. (Specifically, the first one, if more than one are present.)
Antenna Input 2: Switch to the second antenna input.
PC Input: Switch to the PC input port. (This is normally a VGA port on most devices.)
Composite Input: Switch to the Composite input port. (The first one, if there are more than one.)
Composite Input 2: Switch to the second Composite input port.
SVideo Input: Switch to the S-Video port. (The first one, if there are more than one.)
SVideo Input 2: Switch to the second S-Video port.
Component Input: Switch to the Component Input port. (The first one, if there are more than one.)
Component Input 2: Switch to the second Component input port.
HDMI Input: Switch to the HDMI port. (The first one, if there are more than one.)
HDMI Input 2: Switch to the second HDMI port.
HDMI Input 3: Switch to the third HDMI port.
SCART Input: Switch to the SCART port.
Aux Input: Switch to the Aux input port.
MD Input: Switch to the MiniDisc.
LD Input: Switch to the LaserDisc.
DVD Input: Switch to the DVD.
VCR Input: Switch to the VCR.
HDD Input: Switch to the hard drive.
Cable Input: Switch to Cable input.
Satellite Input: Switch to Satellite input.
DVR Input: Switch to the DVR.
Optical Input: Switch to the Optical (audio) input.
Digital Coax Input: Switch to the digital coax input.
USB Input: Switch to the USB input.
A/D Tuner Swap: Toggle between the Analog and Digital TV tuners. (Probably obsolete now in most regions.)

Program Controls

These controls are used to store and retrieve information within the device, such as a list of favorite channels.

Program: Sends the "program" command to the device. Effects vary.
Memory: Sends the "memory" command to the device.
Call: Sends the "call" command to the device.
Next Preset: Switch to the next preset channel in the list.
Previous Preset: Switch to the previous preset channel in the list.

Receiver Controls

Toggle Band: Toggle between the available receiver bands (normally AM and FM).
FM: Switch directly to the FM band.
AM: Switch directly to the AM band. (Also called "MW" on some receivers.)
LW: Switch directly to the LW band. (Not found on many receivers.)
FM Mode: Switch between "mono" and "stereo" FM modes.
RDS: Access the RDS information being broadcast by the current channel.

Air Conditioner Controls

Please note that the following commands are specific to air-conditioners that have stateless remote controls. Stateful controls will need to use a completely different macro mechanism.

Temperature Up: Raise the target temperature.
Temperature Down: Lower the target temperature.
Fan: Put the AC into fan-only mode.
Cool: Put the AC into cooling mode.
Heat: Put the AC into heating mode.
Oscillate: Toggle the fan oscillation mode.
Fan Faster: Increase the fan's speed.
Fan Slower: Reduce the fan's speed.
Energy Save Mode
: Toggle the Energy Saving mode on the AC.

iRobot (Roomba) Controls

Robot Forward: Send the robot forward.
Robot Clockwise: Turn the robot clockwise.
Robot Counterclockwise: Turn the robot counter-clockwise.
Robot Spot: Send the "spot cleaning" command to the robot.
Robot Max: Send the "max power" command to the robot.
Robot Clean: Send the "clean" command to the robot.

Playstation Controls

PS Select: Send the "select" command.
PS Start: Send the "start" command.
PS Left 1: Send the "L1" command.
PS Left 2: Send the "L2" command.
PS Left 3: Send the "L3" command.
PS Right 1: Send the "R1" command.
PS Right 2: Send the "R2" command.
PS Right 3: Send the "R3" command.
PS Up: Send the "up" command.
PS Down: Send the "down" command.
PS Left: Send the "left" command.
PS Right: Send the "right" command.
PS Triangle: Send the triangle key's command.
PS Circle: Send the circle key's command.
PS Cross: Send the cross key's command.
PS Square: Send the square key's command.

Camera Controls

Open Shutter: Cause the target device to take a picture.
Open Shutter After Delay: Cause the target device to take a picture after a fixed delay period. (Probably only available on Canon cameras, where the delay is 2 seconds.)