From b80ac8c92bd18f2d8be35d518e1d05ab7e2f9256 Mon Sep 17 00:00:00 2001 From: Tom Keffer Date: Tue, 9 Oct 2018 09:03:33 -0700 Subject: [PATCH] Consistent use of name "WeeWX" --- TODO.md | 2 +- docs/usersguide.htm | 286 ++++++++++++++++++++++---------------------- 2 files changed, 144 insertions(+), 144 deletions(-) diff --git a/TODO.md b/TODO.md index 7a8c6461..8d904b03 100644 --- a/TODO.md +++ b/TODO.md @@ -4,4 +4,4 @@ Documentation needs to be updated. - Change references to Standard skin to Seasons. - Mention the Mobile and Smartphone skins. -Check whether we can support Python 2.6 \ No newline at end of file +Document the dropping of Python 2.5. \ No newline at end of file diff --git a/docs/usersguide.htm b/docs/usersguide.htm index 4a2f57c6..93d6c2e1 100644 --- a/docs/usersguide.htm +++ b/docs/usersguide.htm @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - weewx: User's Guide + WeeWX: User's Guide @@ -43,7 +43,7 @@ Version: 3.9
- User's Guide to the weeWX Weather System + User's Guide to the WeeWX Weather System
@@ -51,10 +51,10 @@ Version: 3.9

This is the complete guide to installing, configuring, and - troubleshooting weeWX. + troubleshooting WeeWX.

-

About weeWX

+

About WeeWX

WeeWX is software, written in Python, that @@ -81,14 +81,14 @@ Version: 3.9

WeeWX includes support for many types of weather stations. In addition to hardware - support, weeWX comes with a software + support, WeeWX comes with a software simulator, useful for testing and evaluation.

The driver compatibility table in the hardware guide has a detailed list of the manufacturers and models supported by the drivers that come with - weeWX. If you do + WeeWX. If you do not see your hardware in this table, check the list of supported hardware; the pictures may help you identify the manufacturer and/or model. @@ -111,7 +111,7 @@ Version: 3.9 language. Nevertheless, it is "fast enough" on just about any hardware. It has been run on everything from an early MacBook to a router!

-

I run weeWX on a Fit-PC with a 500 MHz AMD +

I run WeeWX on a Fit-PC with a 500 MHz AMD Geode processor and 512 MB of memory. Configured this way, it consumes about 5% of the CPU, 100 MB of virtual memory, and 20 MB of real memory.

@@ -130,9 +130,9 @@ Version: 3.9 as the Weather Underground.

The time on some stations is automatically synchronized with the - weeWX server nominally every four hours. + WeeWX server nominally every four hours. The synchronization frequency can be adjusted in the - weeWX configuration.

+ WeeWX configuration.

Python

@@ -142,7 +142,7 @@ Version: 3.9

Permissions

-

There are a few places where permissions affect weeWX: +

There are a few places where permissions affect WeeWX:

-

Normally weeWX is installed and run with +

Normally WeeWX is installed and run with administrative (root) permissions. However, it is not uncommon to - install and run weeWX as a generic - non-root user, or even as a user created specifically to run weeWX. + install and run WeeWX as a generic + non-root user, or even as a user created specifically to run WeeWX.

-

Installing weeWX

+

Installing WeeWX

Required skills

In the world of open-source hobbyist software, - weeWX is pretty easy to install and + WeeWX is pretty easy to install and configure. There are not many package dependencies, the configuration is simple, and this guide includes extensive instructions. @@ -191,7 +191,7 @@ Version: 3.9 permissions and running commands;

  • No programming experience is necessary unless you wish - to extend weeWX. In this case, you should be comfortable + to extend WeeWX. In this case, you should be comfortable programming in Python.
    • @@ -203,14 +203,14 @@ Version: 3.9

    Overview

    This is an outline of the process to install, configure, and run - weeWX:

    + WeeWX:

    1. Read the hardware notes for your weather station. This will let you know of any features, limitations, or quirks of your hardware.
      2. -
    2. Install weeWX. Use the step-by-step +
    3. Install WeeWX. Use the step-by-step instructions in one of the installation methods below.
      4. @@ -227,14 +227,14 @@ Version: 3.9 configuration file.
    4. Customize the installation. This is an advanced topic, which allows you to - shape weeWX exactly to your liking! + shape WeeWX exactly to your liking!

    Installation methods

    - Weewx can be installed from a DEB (Debian) or RPM + WeeWX can be installed from a DEB (Debian) or RPM (Redhat, SUSE) package, or it can be installed using the standard Python utility setup.py.

    @@ -242,7 +242,7 @@ Version: 3.9

    The DEB or RPM package approach is simpler and is the recommended method for beginners. However, it requires root privileges, and will install the - bits and pieces of weeWX in standard + bits and pieces of WeeWX in standard operating system locations across the file system instead of in a single directory. The net effect is that configuration files, templates, and code will all be installed in separate locations, most @@ -252,13 +252,13 @@ Version: 3.9

    Installation using setup.py is the recommended method for those who plan to write custom services and - reports for weeWX. It will put everything + reports for WeeWX. It will put everything in a single directory, specified by the parameter home in the setup.cfg file, making it - easier to modify weeWX. This file is not + easier to modify WeeWX. This file is not used by the other installation methods. If the user installing - weeWX has permission to write to the directory, root privileges - will not be required to install, run, or modify weeWX. + WeeWX has permission to write to the directory, root privileges + will not be required to install, run, or modify WeeWX.

    Installing from DEB package

    @@ -286,7 +286,7 @@ Version: 3.9

    For all other operating systems, follow the setup.py instructions. This method can also be used on Debian-, Redhat-, and SUSE-based operating systems as well, - and may be a better choice if you intend to heavily customize weeWX. + and may be a better choice if you intend to heavily customize WeeWX.

    Where to find things

    @@ -328,7 +328,7 @@ Version: 3.9 Nominal Location - weeWX root directory + WeeWX root directory WEEWX_ROOT / @@ -390,7 +390,7 @@ Version: 3.9 Nominal Location - weeWX root directory + WeeWX root directory WEEWX_ROOT / @@ -453,7 +453,7 @@ Version: 3.9 Nominal Location - weeWX root directory + WeeWX root directory WEEWX_ROOT /Users/Shared/weewx/ @@ -517,7 +517,7 @@ Version: 3.9 Nominal Location - weeWX root directory + WeeWX root directory WEEWX_ROOT /home/weewx/ @@ -574,18 +574,18 @@ Version: 3.9 -

    Running weeWX

    +

    Running WeeWX

    WeeWX can be run either directly, or as a daemon. When first trying - weeWX, it is best to run it directly + WeeWX, it is best to run it directly because you will be able to see sensor output and diagnostics, as well as log messages. Once everything is working properly, run it as a daemon.

    Running directly

    -

    To run weeWX directly, invoke +

    To run WeeWX directly, invoke the main program, weewxd, giving the configuration file as its only parameter: 

    sudo weewxd weewx.conf
    @@ -601,7 +601,7 @@ Version: 3.9 once every two seconds for a Vantage station, or considerably longer for some other stations.

    -

    You can tell a running instance of weeWX to +

    You can tell a running instance of WeeWX to reread its configuration file by sending it the HUP signal. First run ps to find out the Process ID (PID) @@ -613,7 +613,7 @@ Version: 3.9

    Running as a daemon

    -

    For unattended operations it is best to have weeWX +

    For unattended operations it is best to have WeeWX run as a daemon, started automatically when the server is rebooted.

    If you use a packaged install from a DEB or RPM distribution, this is @@ -638,7 +638,7 @@ Version: 3.9

    Check the chosen script to make sure the variable WEEWX_ROOT has been set to the proper root directory for your - weeWX installation (it should have been set to the correct value automatically + WeeWX installation (it should have been set to the correct value automatically by the install process, but it is worth checking).

    Copy it to the proper location for your system:

    @@ -687,12 +687,12 @@ Version: 3.9

    WeeWX will now start automatically whenever your system is booted. - You can also manually start, stop, and restart the weeWX daemon: + You can also manually start, stop, and restart the WeeWX daemon: 

    sudo /etc/init.d/weewx start
 sudo /etc/init.d/weewx stop
 sudo /etc/init.d/weewx restart
    -

    By default, the scripts are designed to have weeWX +

    By default, the scripts are designed to have WeeWX run at run levels 2, 3, 4 and 5. Incidentally, a nice tool for setting run levels with Debian (Ubuntu, Mint) systems is sysv-rc-conf. It uses a curses @@ -701,12 +701,12 @@ sudo /etc/init.d/weewx restart Center, then look for Systems Services (Runlevel). Pick "Expert" mode to see the run levels.

    -

    You can also tell weeWX to reread its configuration +

    You can also tell WeeWX to reread its configuration file without stopping by using the 'reload' option: 

    sudo /etc/init.d/weewx reload
    -

    Monitoring weeWX

    +

    Monitoring WeeWX

    WeeWX logs many events to the system log. On Debian systems, this is /var/log/syslog, @@ -729,10 +729,10 @@ sudo /etc/init.d/weewx restart

    If the server is on the same machine

    -

    The reports generated by weeWX can be +

    The reports generated by WeeWX can be served by a web server running on the same computer as - weeWX. These are instructions for making - weeWX reports available via the Apache + WeeWX. These are instructions for making + WeeWX reports available via the Apache web server. The process is similar for other web servers such as nginx or lighthttpd.

    @@ -740,16 +740,16 @@ sudo /etc/init.d/weewx restart

    1. Install the Apache web server on the computer on which - weeWX is running. For example, on Debian systems:

      + WeeWX is running. For example, on Debian systems:

      sudo apt-get install apache2

    2. -

      Configure Apache to see the weeWX reports.

      +

      Configure Apache to see the WeeWX reports.

      • -

        If weeWX was installed from DEB or RPM package, no +

        If WeeWX was installed from DEB or RPM package, no configuration should be necessary since the reports are placed in the directory /var/www/html/weewx, @@ -757,9 +757,9 @@ sudo /etc/init.d/weewx restart /var/www/html

      • -

        If weeWX was installed using +

        If WeeWX was installed using setup.py, you must tell - Apache where to find the weeWX reports. + Apache where to find the WeeWX reports. One method is to install an Apache configuration snippet:

        @@ -768,7 +768,7 @@ sudo /etc/init.d/weewx restart

        Be sure that the path in the Apache configuration snippet matches the HTML_ROOT defined in the - weeWX configuration file. For example, + WeeWX configuration file. For example, the path for a default setup.py installation would look like this:

        @@ -786,18 +786,18 @@ sudo /etc/init.d/weewx restart
      • -

        Open the weeWX URL in a web browser:

        +

        Open the WeeWX URL in a web browser:

        http://localhost/weewx

    If the server is on a different machine

    -

    Use FTP or RSYNC to transfer the files generated by weeWX to your - remote server. In weeWX, FTP and RSYNC +

    Use FTP or RSYNC to transfer the files generated by WeeWX to your + remote server. In WeeWX, FTP and RSYNC are implemented as reports. They are configured in the [StdReport] section of the - weeWX configuration file.

    + WeeWX configuration file.

    For example, the following configuration would use RSYNC to copy the html and images files from the standard report to a folder /var/www/html/weewx on the server @@ -829,17 +829,17 @@ sudo /etc/init.d/weewx restart

    Making backups

    - To backup a weeWX installation, you will need to make a copy of + To backup a WeeWX installation, you will need to make a copy of

    It is not necessary to backup the generated images, HTML files, or - NOAA reports since weeWX will easily + NOAA reports since WeeWX will easily create these again.

    @@ -921,8 +921,8 @@ sudo /etc/init.d/weewx restart Do not make the copy of the SQLite database while in the middle of a transaction! Schedule the backup for immediately after an archive record is written, and then make sure the backup completes - before the next archive record arrives. Alternatively, stop weeWX, - perform the backup, then restart weeWX. + before the next archive record arrives. Alternatively, stop WeeWX, + perform the backup, then restart WeeWX.

    @@ -933,8 +933,8 @@ sudo /etc/init.d/weewx restart

    To restore from backup, do a fresh install of - weeWX, replace the default files with - those from a backup, then start weeWX. + WeeWX, replace the default files with + those from a backup, then start WeeWX.

    @@ -956,8 +956,8 @@ sudo /etc/init.d/weewx restart 
    sudo apt-get install python-mysqldb
    -

    Next, change the weeWX configuration to use MySQL instead of - SQLite. In the weeWX configuration file, change the +

    Next, change the WeeWX configuration to use MySQL instead of + SQLite. In the WeeWX configuration file, change the [[wx_binding]] section to point to the MySQL database, archive_mysql, @@ -1002,7 +1002,7 @@ mysql> GRANT select, update, create, delete, insert, drop O

    sqlite3

    -

    The SQLite archive database used by weeWX +

    The SQLite archive database used by WeeWX (nominally, weewx.sdb) is completely compatible with the database used by wview (usually called @@ -1011,7 +1011,7 @@ mysql> GRANT select, update, create, delete, insert, drop O

    If you have data from wview, you can - 'import' them into weeWX by simply copying the + 'import' them into WeeWX by simply copying the SQLite database file. Assuming that the wview data are in file /var/wview/archive/wview-archive.sdb,

    @@ -1024,7 +1024,7 @@ sudo /etc/init.d/weewx start

    Internally, within the weewx.sdb database, - weeWX also maintains a "daily summary" of all the statistics. This + WeeWX also maintains a "daily summary" of all the statistics. This is done for performance reasons. The daily summary will automatically be built on the first startup. This could take a few minutes if the wview archive contains @@ -1040,13 +1040,13 @@ sudo /etc/init.d/weewx start

    MySQL

    The MySQL archive database used by wview is "almost" compatible with - weeWX. The one difference is that in wview, the column interval is named arcInt (presumably because interval is a keyword in MySQL, although it can still be used by surrounding the word with backquotes).

    -

    To change the column name to what weeWX uses, namely To change the column name to what WeeWX uses, namely interval, use the utility mysql and issue the command:

    mysql> ALTER TABLE your-wview-archive-name CHANGE arcInt `interval` INTEGER NOT NULL;
    @@ -1067,7 +1067,7 @@ sudo /etc/init.d/weewx start

    The configuration file weewx.conf is a big text file that holds the configuration information about your - installation of weeWX. This includes things such as:

    + installation of WeeWX. This includes things such as: