This is an uptimes.net client for the Netgear RT311 Router.  It should
also work for the RT314 model, and possibly ZyXEL Prestige P310/P314
routers as well since they use the same firmware.


Requirements:

- Python 1.5 or later (try http://www.python.org to download)
- Linux (possibly FreeBSD) or Windows (no serial support in Windows)


Installation:

1. Edit the rt311.cfg file.  You MUST include a auth string as provided
   on the uptimes.net information page!  All other values are optional
   (they default to the values the router ships with), but must be 
   changed if you've modified any values from the default.

2. Run the program: python rt311up.py


Tips:

In Unix, you may want to run the program in the background.  You can do 
this by appropriate use of your shell.  In bash, you can do:

    python rt311up.py > rt311up.out 2>&1 &

This will run the application in the background, storing all output to 
the file "rt311up.out".

If you only want to see errors and warnings, then you can use the "-q" 
option to request a quiet run:

    python rt311up.py -q > rt311up.err 2>&1 &


Details for Configuration File

Lines beginning with a '#' are comments - you'll see plenty of 
comments in the sample configuration file to help you set it up.
The file is like a Windows .ini file, meaning that there are sections,
described by brackets.

Because the password for the router is listed here, make sure that the
file is not readable by anyone!  In Unix you can do this via the "chmod"
command, like this:

    chmod og-rw rt311up.cfg

The options you can specify are:

auth 
    If you log in to uptimes.net, and click on "login", then "hosts", 
    you'll see the "AuthKey" for all of your hosts.  Put that value
    here (cut and paste is easiest).

password
    The router password.  The default router password is used, but you
    should change this on your router and put the new password here.

connection
    This must be either "serial" or "network".  

    Network uses the telnet interface to get the information from the 
    router.  This interface is always available, but is less secure, 
    because it sends your password in clear text over your local 
    network.  If you are certain your local network is secure (i.e. 
    not running any servers that may have been hacked, running virus 
    scans frequently), then you can use this.

    The serial option uses the RS232 serial port console on the 
    router.  This is pretty secure, because it involves a direct cable 
    connection to the device.  It does mean you have to buy a cable
    and connect it to both your computer and the router.  
    Unfortunately the firmware on the router does not support flow 
    control - this means that occasionally it drops a byte, either 
    sending or receiving, with the serial port.  The software handles 
    this by retrying the entire operation in this case.  If you want 
    to use a terminal program to access the router you can, as the 
    program uses the standard serial lock file mechanisms.  This 
    connection option is not available in Windows.

frequency
    Number of seconds between sending updates to the uptimes.net 
    server.  This must be no less than 30 seconds, and no more than 
    600 seconds.  I use 120 seconds, and that's the default.

address
    The address of the router.  Either an IP address or hostname.
    Only used in network mode.

dev
    The name of the device the serial port is connected to.  Only
    used in serial mode.

baud
    The speed the router communicates on the serial port.  Only used
    in serial mode.

Feel free to report any problems or suggestions to me at 
<shane@time-travellers.org>.

Shane Kerr
2001-07-04