Skip to content

Commit

Permalink
Merge pull request #382 from krkeegan/fix_issue_339
Browse files Browse the repository at this point in the history 
Cleanup Documentation Issues in Preparation for New Release
  • Loading branch information
@hollie
hollie committed Mar 15, 2014
2 parents 910af83 + 51d07c6 commit 005a06e
Show file tree
Hide file tree
Showing 12 changed files with 148 additions and 9,916 deletions.
22 changes: 22 additions & 0 deletions docs/authors.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<html>
<head>
<title>Authors</title>
<link rel="STYLESHEET" href="default.css" type="text/css">
</head>
<body>
<h3>Authors</h3>

<p>Many many people have contributed to MisterHouse in various ways over
the years. Unfortunately, it is impossible to identify everyone and
their contributions. However we greatly appreciate any contribution in
any form. The following link identifies those who contributed code to
either the old SVN repository or the new GIT repository under their own
name.
</p>
<ul><li><a href="https://www.ohloh.net/p/misterhouse/contributors" target="_blank">
OhLoh.net - List of Contributors to MisterHouse
</a></li></ul>

</body>

</html>
32 changes: 26 additions & 6 deletions docs/download.pod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ B<Version 3.0> - released on 06/20/2013

=over

=item * For Linux, Windows and MacOS: L<https://api.github.com/repos/hollie/misterhouse/zipball/v3.0>
=item Linux, Windows and MacOS

=item * The Windows only compiled version of Misterhouse is sadly no longer supported.
L<https://api.github.com/repos/hollie/misterhouse/zipball/v3.0>

=item * Between formal releases, you can pick up the latest updates from: L<https://github.com/hollie/misterhouse> (not recommended for beginners!)
The Windows only compiled version of Misterhouse is sadly no longer supported.

=item * A large (30MB) zip of optional files (mainly sound files) is here: L<http://misterhouse.sf.net/misterhouse_misc.zip>
Between formal releases, you can pick up the latest updates from: L<https://github.com/hollie/misterhouse> (not recommended for beginners!)

A large (30MB) zip of optional files (mainly sound files) is here: L<http://misterhouse.sf.net/misterhouse_misc.zip>

=back

Expand All @@ -29,15 +31,33 @@ B<Version 2.200> - released on 03/02/2012

=over

=item * L<https://api.github.com/repos/hollie/misterhouse/zipball/v2.200>
=item *

=begin HTML

<strong>
<a href='https://api.github.com/repos/hollie/misterhouse/zipball/v2.200' target='_blank'>https://api.github.com/repos/hollie/misterhouse/zipball/v2.200</a>
</strong>

=end HTML

=back

=head1 Older Versions

=over

=item * You can get older versions from Sourceforge (not recommended): L<http://sourceforge.net/project/showfiles.php?group_id=1365&package_id=1347>
=item * You can get older versions from Sourceforge (not recommended):

=begin HTML

<strong>
<a href='http://sourceforge.net/project/showfiles.php?group_id=1365&package_id=1347' target='_blank'>
http://sourceforge.net/project/showfiles.php?group_id=1365&package_id=1347
</a>
</strong>

=end HTML

=back

Expand Down
19 changes: 4 additions & 15 deletions docs/examples.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,15 @@ <h3>Coding examples</h3>
<li>Here is <a href=examples.txt>some examples events</a>

<li>Here is the
<a href="https://misterhouse.svn.sourceforge.net/svnroot/misterhouse/trunk/code/examples">mh example code directory</a> ,
<a target="_blank" href="https://github.com/hollie/misterhouse/tree/stable/code/examples">mh example code directory</a> ,

<li>Here is the
<a href="https://misterhouse.svn.sourceforge.net/svnroot/misterhouse/trunk/code/common">most commonly used code files</a> ,
<a target="_blank" href="https://github.com/hollie/misterhouse/tree/stable/code/common">most commonly used code files</a> ,

<li> Here is
<a href="https://misterhouse.svn.sourceforge.net/svnroot/misterhouse/trunk/code/public/README.txt">an index</a>
and <a href="https://misterhouse.svn.sourceforge.net/svnroot/misterhouse/trunk/code/public/">directory listing</a> of other less supported users written code files


</ul>

<!----
<h3>Online examples</h3>
<ul>
<li><a href="http://mh.misterhouse.net">Bruce's House</a>
<li><a href="http://kliernetwork.net">Brian Klier's House</a>
<a target="_blank" href="https://github.com/hollie/misterhouse/blob/stable/code/public/README.txt">an index</a>
and <a target="_blank" href="https://github.com/hollie/misterhouse/tree/stable/code/public">directory listing</a> of other less supported user written code files
</ul>
--->

<hr>
<P><SCRIPT>
Expand Down
71 changes: 11 additions & 60 deletions docs/faq.pod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@

=head2 1.1: What OSes can it run on?

It has been tested on Windows 95, 98, NT 4.0, 2K, XP, Vista (!) and 7.
It has been tested on Windows >= XP.
On Unix, it has been run on Linux (Ubuntu, Debian, Fedora and others), AIX, and Sun.

In theory, any OS that runs perl should be able to run mh. In practice, some platforms will likely have strange Serial Interfaces, so the Serial I/O related function would take some work.

=head2 1.2: How can I make it run faster and use less memory?

On my Celron 400 Mhz computer running Windows 98, using 60 code files with 6000 lines of code, mh takes 10% the cpu, running at 9 passes per second and using about 30 MB of memory.

If you are happy with the Web interface and don't need the Tk interface, turn it off by editing the Tk mh.ini parm or run:

mh -tk 0
Expand Down Expand Up @@ -187,40 +185,7 @@ Then run mh using these parameters:

Note, you can run this test mh quickly without stopping your normal mh.

=head2 1.13: What are the advantages/disadvantages to running the compiled versions of mh?

Advantages:

=over

=item *

You don't need the latest version of perl installed

=item *

You don't have to install additional perl modules

=back

Disadvantages:

=over

=item *

For some reason, starting mh with the compiled versions is slower. On my windows box, it is 10 seconds -vs- 20 seconds.

=item *

You can apply quick patches to mh, -vs- downloading a larger, less frequently updated mh.exe file.

=back

The memory and cpu used, once mh is started, is the same.


=head2 1.14: How does mh read and use the user code in code_dir
=head2 1.13: How does mh read and use the user code in code_dir

Each time mh is started or a Reload is done, mh will re-read all the .pl code members
in the code_dir directory (this is a mh.ini parm)
Expand All @@ -237,7 +202,7 @@ evals the &loop_code code (it does an eval, rather then execute it directly, so
not kill mh), sleeps for a bit, then repeats.


=head2 1.15 How can I control mh from a non-mh web server like Apache?
=head2 1.14 How can I control mh from a non-mh web server like Apache?

You can think of the built in mh web server as 2 parts:

Expand All @@ -257,7 +222,7 @@ You can also use something like mh/code/common/mhsend_server.pl
and then read/write to sockets directly from non-mh web server cgi scripts.
Or have the web server script simply call mh/bin/mhsend to run mh commands.

=head2 1.16 Is there a front-end tool for defining/editing mh items/events?
=head2 1.15 Is there a front-end tool for defining/editing mh items/events?

Not yet, but you can now define items/events in a table-like format.
This should allow us to enable a gui or web based front end tools for editing.
Expand All @@ -272,7 +237,7 @@ at the top of the table. Then mh will process (on starup and reload) each recor
Examples are in mh/code/bruce/*.mht and mh/code/test/*.mht.
If you want to create another table format, all you need to do is create a mh/lib/read_table_xyz.pl member, then set Format=xyz.

=head2 1.17: How can I use Family Radios with MisterHouse?
=head2 1.16: How can I use Family Radios with MisterHouse?

=begin html
There is seperate FAQ on the FRS topic in
Expand All @@ -281,7 +246,7 @@ There is seperate FAQ on the FRS topic in
=end html


=head2 1.18: Is there a way to tell if MH is shutdown correctly or not?
=head2 1.17: Is there a way to tell if MH is shutdown correctly or not?

On windows, mh/bin/mh.bat checks errorlevel and on linux, mh/bin/mhl finds the return code via $?.
Both of these shells will restart mh unless they detect a normal exit (rc=1).
Expand All @@ -300,7 +265,7 @@ code in mh/code/common/mh_control.pl will set $Power_Supply, so you can do somet
}


=head2 1.19: How can I use an Internet Appliance with MisterHouse?
=head2 1.18: How can I use an Internet Appliance with MisterHouse?

=begin html
There is seperate FAQ on varous Internet Appliances in
Expand All @@ -309,7 +274,7 @@ There is seperate FAQ on varous Internet Appliances in
=end html


=head2 1.20: Where is perl program code located?
=head2 1.19: Where is perl program code located?

From Harald Koch on 2/2002.

Expand Down Expand Up @@ -493,7 +458,7 @@ Here are a few:

=head2 2.8: Can I use mh to control other windows

On Windows (95,98, NT), you can use the SendKeys to send keystrokes to other windows. See mh.html for details.
On Windows you can use the SendKeys to send keystrokes to other windows. See mh.html for details.

If anyone knows of an equivalent function for linux, let me know. Linux is usually clever enough to have
command line options, so there is less of a need here.
Expand Down Expand Up @@ -1244,21 +1209,7 @@ or asynchronous modes are as easy as (audio_mode sync) or (audio_mode async)

=head1 4: Windows specific questions

=head2 4.1: mh seems to cause some windows to hang

If you are experiencing problems with windows not popping up when they should (e.g. control panel or install shield), you will want to install DCOM 1.3, available from here:

http://www.microsoft.com/com/dcom/dcom98/dcom1_3.asp

Note, I had run all the 'Windows updates', including the Service Pack 2, but
I still had the problem until I installed the above.

For Windows 95, the update is at:

http://www.microsoft.com/com/dcom/dcom95/dcom1_3.asp


=head2 4.2: How do I set setup networking between Windows boxes
=head2 4.1: How do I set setup networking between Windows boxes

You need to have the TCP/IP protocol enabled for your Networking Interface Card (NIC).
If you use a modem to reach the internet, you already have TCP/IP enable for the dial up adaptor,
Expand All @@ -1269,7 +1220,7 @@ You can find instuctions on how to do this at: http://win98central.acauth.com/in
IP addresses that start with 10. (e.g. 10.0.0.1) are reserved for internal lans, so you can use
10.0.0.1, 10.0.0.2, etc.

=head2 4.3 How do I run MH when not logged in to Win2K or XP?
=head2 4.2 How do I run MH when not logged in Windows?

You can run any program as a service, using a program called srvany.exe,
available in the Resource Kit, or from here:
Expand Down
62 changes: 20 additions & 42 deletions docs/features.html
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
<html>
<head>
<!-- Last emacs update Time-stamp: <2005-07-03 20:45:41 winter> -->
<link rel="STYLESHEET" href="default.css" type="text/css">
<title>MisterHouse - Features</title>
</head>
<body>

<h3>Some MisterHouse features</h3>
<p>Check <a href='faq.html#6_8_what_sort_of_hardware_do_you_have_in_your_house'>here</a> for a list of hardware in Bruce's house.

In the broadest sense, MiserHouse can control anything capable of being remotely
controlled or monitor anything that can be queried by a computer. If you can
code it, it can be done.

It is difficult to provide an accurate and complete list of MisterHouse's features
due to the ease in which we can all contribute new modules or code to MisterHouse.
However, the following is at least a general overview of some features:

<ul>

<li>Executes actions based on voice input, time of day, file data, serial port data, and socket data.
Expand All @@ -28,16 +35,14 @@ <h3>Some MisterHouse features</h3>
<li>Reads/writes any data from any serial attached device.

<li>Speaks the speed, course, and position of vehicles, by interfacing to a ham radio modem (TNC).
Brian Klier wrote
<a href="http://www.faribault.k12.mn.us/brian/aprs/"> has a nice article about it</a>.
You can see our <a href="http://mh.misterhouse.net/aprs"> car position logs here</a>

<li>Sends/receives X10 data from the X10 CM11 (ActiveHome) interface.

<li>Sends wireless X10 data using the X10 CM17 (Firecracker) interface.

<li>Sends/receives X10 data from the
<a href="http://www.x10.com/automation/x10_ck11a_d.htm">X10 CM11 (ActiveHome) interface</a>
<li>Supports all Insteon products, including i1 and i2cs devices

<li>Sends wireless X10 data using the
<a href="http://www.x10.com/automation/firecracker_d.htm"> X10 CM17 (Firecracker) interface</a>
<li>Build your own "user code" to do whatever you like

<li>Send/receive data to the <a href=http://www.ibutton.com>Ibutton family</a> of devices,
including the weather station.
Expand All @@ -55,15 +60,10 @@ <h3>Some MisterHouse features</h3>
<li>Reads/writes to <a href=http://www.appdig.com/adicon.html>Applied Digital's</a>
CPU-XA and Ocelot interfaces via the cpuxad socket deamon.

<li>Reads data from
<a href="http://www.evation.com/irman">IRman infrared receiver</a> serial interface
and writes to
<a href="http://www.x10.com/products/ux17a_bj2.htm">X10 IR Commander</a>
wireless interface.
<li>Reads data from IRman infrared receiver serial interface and writes to X10 IR Commander wireless interface.

<li>Code has been written for DSC Alarm pannels, Stargate LCD displays, Alpha BetaBrite LED displays, Slinke IR send/receive,
Marrick X10, RCI X10 sprinklers, Xantech preamps,
ISDN modems, voice modems, ComPool and Aqualink pool equipment.
Marrick X10, RCI X10 sprinklers, Xantech preamps, ISDN modems, voice modems, ComPool and Aqualink pool equipment.

<li>Reads and writes from the
<a href="http://lcdproc.omnipotent.net">lcdproc server</a>
Expand All @@ -75,8 +75,7 @@ <h3>Some MisterHouse features</h3>

<li>Sends/receive instant messages using AIM, MSN, or <a href=http://www.jabbercentral.org>Jabber</a>

<li>Reads MS Outlook, Unix ical, or the <a href=http://localhost:8080/organizer/calendar.pl>built in Organizer</a>
calendar for event reminders and VCR programing.
<li>Reads MS Outlook, Unix ical, or the built in Organizer calendar for event reminders and TV programing.

<li>Uses free internet TV web pages to allow for VCR programing and show reminders.

Expand All @@ -85,37 +84,16 @@ <h3>Some MisterHouse features</h3>
<li>Can monitor NetGear RT311 / RT314 or LinkSys syslog router traffic, so you can track
stuff like incoming web hits and online game time.

<li>Uses Voice XML to interface to <a href=http://tellme.com>tellme.com</a>. To try it,
dial 1-800-555-Tell, then after you ear 'tellme more', enter 1-46630 (1-HOME0).
With a XML browser (e.g. IE), you can see a test vxml menu <a href="http://mh.misterhouse.net/sub?menu_vxml">here</a>

<li>Use simple menu templates to generate menus for LCD, VXML, or WAP phones. If you have a WAP
phone or WAP browser, you can see <a href=http://misterhouse.net/mh/code/bruce/test.menu>this test menu</a>
with this url: <a href=http://mh.misterhouse.net/sub?menu_wml>http://mh.misterhouse.net/sub?menu_wml</a>.
You can also walk the menus with an html browser <a href=http://mh.misterhouse.net/bin/menu.pl>with a frames version</a>
or a <a href=http://mh.misterhouse.net/sub?menu_html>a simpler version</a> .
These menus can also be controled with a single switch (e.g. air sip switch for the disabled), using
audible feedback to select items/states.
You can also drive menus with an SSH client, like this <a href=http://misterhouse.net/pictures/terminal-menu_on_nokia.jpg>phone example</a>

<li>Logs weather data to the
<a href=http://wunderground.com/weatherstation>wunderground personal weather project</a>. Here's
<a href="http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=KMNROCHE3">
weather logs from my house</a>
<a href=http://wunderground.com/weatherstation>wunderground personal weather project</a>.

<li>Here is a list of some <a href="http://misterhouse.net/mh/code/public/README.txt">users written code files</a>
along with <a href="http://mh.misterhouse.net/bin/code_select.pl">standard code files</a>
that demonstrate some other MisterHouse features.

<li>You can use RSS readers to track various data, like
<a href="http://mh.misterhouse.net/bin/rss_logs.pl?phone">phone</a> or
<a href="http://mh.misterhouse.net/bin/rss_logs.pl?speak">speak</a> logs.

<li>Control of RoboSapien, ESRA, and ER1 robots.
Some pictures and videos are in <a href=http://local.misterhouse.net/public/robot/>local.misterhouse.net/public/robot/</a>.
<li>You can use RSS readers to track various data.

<li>Uses the rrd program to generate
<a href=http://w3.misterhouse.net:8090/ia5/outside/weather_index.shtml>weather graphs</a>.
<li>Uses the rrd program to generate various graphs.

<li>Support for
<a href=http://www.xapautomation.org>xAP</a> and
Expand Down
Loading

0 comments on commit 005a06e

Please sign in to comment.