If you have any questions or comments, please post a note on the
<a href="https://garage.maemo.org/forum/?group_id=2286">Pierogi forum boards</a>
or send a message to
-<a href="mailto:jpietrzak8@gmail.com">jpietrzak8@gmail.com</a>.
-Thank you for your understanding.
+<a href="mailto:jpietrzak8@gmail.com">jpietrzak8@gmail.com</a>. Also, a thread
+has been set up on
+<a href="http://talk.maemo.org/showthread.php?t=82243">talk.maemo.org</a>,
+containing a great deal of information.
</p>
+<h3>A note on licensing and such</h3>
+<p>
+I have placed Pierogi under the GNU General Public License, version 2.0 or
+later. (Here is a
+<a href="http://www.gnu.org/licenses/gpl-2.0.html">link</a> to the terms of
+that license.) In short, this places certain restrictions on how you can use
+the source code for this program (which you can find
+<a href="https://garage.maemo.org/plugins/ggit/browse.php/?p=pierogi">here</a>;
+if that link is not working for you, please send me a note). The program
+itself is free for use, in whatever manner you wish to use it.
+</p>
+
+<p>
+However, some kind folks have asked about donations, and I've decided I will
+go ahead and set up a Paypal donation site. Any funds received will be put
+towards the purchase of a second N900 I can devote fully towards development
+work. Thank you for your support!
+</p>
+
+<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
+<input type="hidden" name="cmd" value="_s-xclick">
+<input type="hidden" name="hosted_button_id" value="K697WUWYDLNJA">
+<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
+<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
+</form>
+
<h1>Pierogi Documentation</h1>
<p>
"favorites" tab for quick access.
</p>
-<h3>Main Tab</h3>
+<h3>Main Window</h3>
+
+<h4>Main Tab</h4>
<img src="MainTab.png">
-<p>The Main tab contains just the power, volume, and channel buttons. It is
-intended to be a quick way to get to the most important, commonly used
+<p>The Main tab contains just the power, volume, mute, and channel buttons.
+It is intended to be a quick way to get to the most important, commonly used
controls. The name of the current keyset is also provided in this tab.</p>
-<h3>Utility Tab</h3>
+<h4>Utility Tab</h4>
<img src="UtilityTab.png">
<p>The Utility tab contains a selection of commonly useful controls, such as
-"Mute", "Sleep", "Input", "Closed Captions / Subtitles", and the color buttons.
-The exact selection of buttons on this tab will probably change to reflect
-which commands turn out to be the most popular.</p>
+"Sleep", "Input", "Closed Captions / Subtitles", and the color buttons.
+This tab is intended to be a quick way to reach the most frequently used
+buttons; as such, the selection may be updated in future versions of Pierogi.
+</p>
-<h3>Keypad Tab</h3>
+<h4>Keypad Tab</h4>
<img src="KeypadTab.png">
channels to be represented by just a single digit; pressing this should
allow you to enter a second digit.</p>
-<h3>Menu Tab</h3>
+<h4>Menu Tab</h4>
<img src="MenuTab.png">
<p>This tab contains buttons used to enter and exit a menu, navigate within
a menu, and select menu entries. The "Menu" button is meant to enter the
-main system menu of a given device; the "Info" and "Guide" buttons are
-targeted towards entering other useful menus when available.</p>
+main system menu of a given device; "Guide" is a content-related menu available
+on many modern devices; and "Disc Menu" is used to access the menu interface
+provided with DVD and Blu-Ray media.</p>
-<h3>Media Tab</h3>
+<h4>Media Tab</h4>
<img src="MediaTab.png">
<p>Many of the most important playback commands are represented on this tab.
-Play, pause, and stop are the most common ones, along with "Reverse" (often
-called "Rewind") and Fast Forward. A variety of other less common navigation
-controls are included, along with the "eject" command.</p>
+"Play", "Pause", and "Stop" are the most common ones, along with "Reverse"
+(often called rewind) and "Fast Forward". A variety of other less common
+navigation controls are included, along with the "Eject" command.</p>
-<h3>Misc Tab</h3>
+<h4>Favorite Tab</h4>
-<img src="MiscTab.png">
+<img src="FavoriteTab.png">
-<p>This tab contains a selection of buttons that did not fit into any of the
-previous tabs. The content of this tab is subject to change.</p>
-
-<h3>Favorites Tab</h3>
-
-<img src="FavoritesTab.png">
-
-<p>As there are numerous keysets available in Pierogi, a "favorites" tab has
+<p>As there are numerous keysets available in Pierogi, a "Favorite" tab has
been implemented. To add a favorite keyset to the tab, first select that
-keyset from the "Select Keyset" window. Then, navigate to the Favorites tab
+keyset from the "Select Keyset" window. Then, navigate to the Favorite tab
and press "Add Current Keyset".</p>
<p>Once you have added some keysets to the favorites list, you can tell
<p>A keyset can be removed from the list by selecting it and pressing
"Remove Selected Keyset".</p>
+<p>
+Also note that the volume control keys on the top left side of the N900 can
+also be used to step through the list of favorite keysets, no matter what tab
+you are currently on.
+</p>
+
<h3>Select Keyset Window</h3>
<img src="SelectKeysetWindow.png">
<p>The Select Keyset window presents a list of all the keysets currently
-available in Pierogi. As this list is fairly long, a button has been added
-at the top of the window that allows you to choose the make (or brand) of
-the device you are trying to control; once a make has been selected, all
-keysets not associated with that make will be hidden. To use a keyset,
+available in Pierogi. As this list is fairly long, buttons have been added
+at the top of the window to choose the make and/or type of device for
+the product you are trying to control; all keysets not associated with
+the chosen values will be hidden. To use a keyset,
simply select it from the list, and close the window (by pressing the
return arrow at the top right of the screen).</p>
+<h3>Secondary Buttons Window</h3>
+
+<h4>TV Tab</h4>
+
+<img src="TVTab.png">
+
+<p>This page contains several more TV-oriented buttons, including controls for
+picture-in-picture, teletext, and some graphics and audio controls. The
+content of this page is subject to change.</p>
+
+<h4>Media2 Tab</h4>
+
+<img src="Media2Tab.png">
+
+<p>This is another page of media buttons, containing a mix of commands useful
+for DVD players, VCRs, audio devices, and possibly other devices. The content
+of this page may change in the future.</p>
+
+<h4>Input Tab</h4>
+
+<img src="InputTab.png">
+
+<p>
+Many devices have multiple sources for their data, whether it be television
+signals piped in over the air or through a cable, or audio from a variety of
+stereo components. It is unlikely that Pierogi will ever be able to list all
+of the various possible input buttons, but this tab contains a few of them.
+</p>
+
+<h4>Adjust Tab</h4>
+
+<img src="AdjustTab.png">
+
+<p>
+A handful of the various audio and video adjustment buttons are placed on
+this tab. Actual volume controls will likely remain on the main window,
+however.
+</p>
+
<h2>Design Rationale</h2>
<p>Here I collect my thoughts on the how and why of creating Pierogi.</p>
an object-oriented manner along the way.</p>
<p>
-Here's one way in which I disagree with the authors of LIRC: they've managed
-to cram support for practically every protocol used by every remote control
-ever made into a single codepath. So, there's a single "transmit" function,
-sorting through a massive pile of flags, conditional statements, and some
-really funky delayed-action buffering to make everything work. The simple act
-of splitting the code into one routine for the RC5 (biphase) protocol and
-another for the NEC (space-encoded) protocol makes it much easier to read, at
-least to my eyes. (I haven't yet implemented the RC6 or other protocols.)
+As I have progressed in adding support for additional IR protocols, I'm
+beginning to see why the authors of the LIRC made the attempt to compress
+every possible IR protocol into a straightforward count of individual IR
+pulses. The total number of IR protocols in use is amazing, and many of them
+(through oversight or due to the longevity of their use) are mind-numbingly
+complicated to deal with. Still, I believe that separating the major protocols
+into their own code paths results in code that is easier to understand and
+maintain; I'm slowly moving away from the LIRC's system to my own as time
+goes on.
</p>
<p>
<li>Some <a href="http://www2.renesas.com/faq/en/mi_com/f_com_remo.html">More info on the NEC protocol</a>
+<li>An introduction to the <a href="http://www.sbprojects.com/knowledge/ir/sirc.php">Sony SIRC protocol</a>
+
+<li>An excellent collection of <a href="http://www.hifi-remote.com/sony/">Sony command codes</a>
+
<li>Link to (what appears to be) source code for the N900's
<a href="http://svn.jacekowski.org/host_mode/trunk/drivers/input/lirc/lirc_rx51.c">/dev/lirc0 device driver</a>.
+
<ul>
</body>
projects / pierogi / blobdiff