diff --git a/TODO.txt b/TODO.txt index 4c038395..3722b332 100644 --- a/TODO.txt +++ b/TODO.txt @@ -1,3 +1,5 @@ TODO before the next release: -Document the five service lists. +Document the five service lists in customizing.htm + +Upgrade instructions. diff --git a/docs/customizing.htm b/docs/customizing.htm index f45113b4..d536a22a 100644 --- a/docs/customizing.htm +++ b/docs/customizing.htm @@ -1804,7 +1804,7 @@ inch = ' in'

You may wish to do something fancier. For example, try this one

month = %d-%b-%Y %H:%M
-

which results in a lable that looks like:

+

which results in a label that looks like:

06-Oct-2009 15:20

Section [[TimeFormats]] also allows diff --git a/docs/usersguide.htm b/docs/usersguide.htm index 8b282216..a1981d76 100644 --- a/docs/usersguide.htm +++ b/docs/usersguide.htm @@ -775,7 +775,13 @@ longitude = -77.0366

model

Set to the station model. For example, WH1080, WS2080, WH3081, etc.

pressure_offset

-

The offset, in millibars, that is applied to values from the station sensor. This offset is applied to the station pressure before calculating barometer and altimeter sea level pressures. Only the raw station pressure is recorded to database, not the station pressure with offset applied.

+

+ The offset, in millibars, that is applied to values from the + station sensor. This offset is applied to the station pressure before + calculating barometer and altimeter sea level pressures. Only the + raw station pressure is recorded to the database, not the station + pressure with offset applied. +

polling_mode

One of PERIODIC or ADAPTIVE. In @@ -801,7 +807,13 @@ longitude = -77.0366 either US or EU. US uses 915 MHz, EU uses 868.3 MHz. Default is US.

pressure_offset

-

The offset, in millibars, that is applied to values from the station sensor. This offset is applied to the station pressure before calculating barometer and altimeter sea level pressures. Only the raw station pressure is recorded to database, not the station pressure with offset applied.

+

+ The offset, in millibars, that is applied to values from the + station sensor. This offset is applied to the station pressure before + calculating barometer and altimeter sea level pressures. Only the + raw station pressure is recorded to the database, not the station + pressure with offset applied. +

[Simulator]

This section is for options relating to the software weather station simulator @@ -840,8 +852,7 @@ longitude = -77.0366

[StdRestful]
     [[Wunderground]]
         station = 12345678  # Replace with your station number
-        password = xxxxx    # Replace with your password
-        driver = weewx.restful.Ambient
+ password = xxxxx # Replace with your password

station

Set to your Weather Underground station ID (e.g., KORHOODR3). Required.

@@ -856,8 +867,7 @@ longitude = -77.0366
[StdRestful]
     [[PWSweather]]
         station = 12345678  # Replace with your station number
-        password = xxxxx    # Replace with your password
-        driver = weewx.restful.Ambient
+ password = xxxxx # Replace with your password

station

Set to your PWSweather station ID. Required.

password

@@ -873,8 +883,7 @@ longitude = -77.0366
[StdRestful]
     [[WOW]]
         station = 12345678  # Replace with your station number
-        password = xxxxx    # Replace with your password
-        driver = weewx.restful.WOW
+ password = xxxxx # Replace with your password

station

Set to your WOW station ID. Required.

password

@@ -890,8 +899,7 @@ longitude = -77.0366 station = 12345678 # Replace with your station number passcode = xxxxx # Replace with your passcode (APRS stations only) server = cwop.aprs.net:14580, cwop.aprs.net:23 - interval = 600 - driver = weewx.restful.CWOP + interval = 600

station

Set to your CWOP station ID (e.g., CW1234). Required.

@@ -917,19 +925,38 @@ longitude = -77.0366 conditions. Optional. Default is 1800 seconds.

[[StationRegistry]]

-

A registry of weewx weather stations is maintained at weewx.com. Stations are displayed on a map and a list at http://weewx.com/stations.html

-

How does the registry work? Individual weather stations periodically contact the registry. Each station provides a URL to identify itself, plus other information such as the station type and weewx version. The registry does not keep track of meteorological data; no information about the weather is sent to the registry.

-

To add your station to this list, enable the StationRegistry in weewx.conf. Your station will contact the registry once per week. If your station does not contact the registry for about a month, it will be removed from the list.

+

+ A registry of weewx weather stations is maintained at weewx.com. + Stations are displayed on a map and a list at http://weewx.com/stations.html +

+

How does the registry work? Individual weather stations + periodically contact the registry. Each station provides a URL to + identify itself, plus other information such as the station type + and weewx version. The registry does not keep track of + meteorological data; no information about the weather is sent to + the registry.

+

To add your station to this list, enable the StationRegistry + in weewx.conf. Your station will contact the registry once per + week. If your station does not contact the registry for about a + month, it will be removed from the list.

[StdRestful]
     [[StationRegistry]]
-        register_this_station = True
-        driver = weewx.restful.StationRegistry
+ register_this_station = True

register_this_station

Set this to True to register the weather station.

description

-

A description of the station. If no description is specified, the location from the [Station] section will be used.

+

+ A description of the station. If no description is specified, the + location from the [Station] section will be used. +

station_url

-

The URL to the weather station. If no URL is specified, the station_url from the [Station] section will be used.

+

+ The URL to the weather station. If no URL is specified, the station_url from the [Station] section will be used. +

[StdReport]

This section is for configuring the StdReport service, @@ -1052,10 +1079,7 @@ longitude = -77.0366 StdConvert above. It is also important that this service be run before the archiving service StdArchive, so that it is the corrected data that - is stored.

-

If you do not wish to apply any calibrations, you can leave it out of - service_list, the list - of services to be run, and it will not be loaded or run at all.

+ are stored.

[[Corrections]]

In this section you list all correction expressions. For example, say that you know your outside thermometer reads high by 0.2°F. You could add @@ -1081,10 +1105,7 @@ longitude = -77.0366 StdConvert. It is also important that it be run after the calibration service, StdCalibrate and before the archiving service StdArchive, - so that it is the calibrated and corrected data that is stored.

-

If you do not wish to use this service, you can leave it out of - service_list, the list - of services to be run, and it will not be loaded or run.

+ so that it is the calibrated and corrected data that are stored.

[[MinMax]]

In this section you list the observation types you wish to have checked, along with their minimum and maximum values. The units should be in the @@ -1219,21 +1240,63 @@ longitude = -77.0366 how to do this can be found in the section Customizing the weewx service engine of the Customizing Guide.

+ +

[[WxEngine]]

-

This section is for options used by the service engine.

-

service_list

-

This option is the list of services that are to be run by the service - engine. After each event (such as the arrival of LOOP data, etc.), they will - be run in the given order. The standard list of services run by weewx is: +

+ This section is for options used by the internal weewx service engine.

-
service_list = weewx.wxengine.StdConvert, weewx.wxengine.StdCalibrate, weewx.wxengine, StdQC, weewx.wxengine.StdArchive, weewx.wxengine.StdTimeSynch, weewx.wxengine.StdPrint, weewx.wxengine.StdRESTful, weewx.wxengine.StdReport
-

Note that despite how it may or may not read above, this option must be all on one line!

-

You can leave some of these services out if you do not need them. For example, - the bare minimum if you are using a Davis Vantage instrument, storing your data - in US Customary units, doing no data corrections or quality control and running - as a daemon (no printing to console) would be:

-
service_list = weewx.wxengine.StdArchive, weewx.wxengine.StdTimeSynch, weewx.wxengine.StdRESTful, weewx.wxengine.StdReport
-

However, this will only make a slight difference in execution speed.

+

+ Internally, weewx consists of many services, + each responsible for some aspect of the program's functionality. + After an event happens, such as + the arrival of a new LOOP packet, any interested service gets a + chance to do some useful work on the event. For example, a service + might manipulate the packet, print it out, store it in a database, + etc. This section controls which services are loaded and in what + order they get their opportunity to do that work. Before weewx v2.6, this section held one, looong + option called service_list, which held + the names of all the services that should be run. Since then, this + list has been broken down into five, smaller, lists, given below. + They are run in the order given below. +

+

prep_services

+

+ These services get called before any others. They are typically + used to prepare the console. For example, the service weewx.wxengine.StdTimeSynch, which is + responsible for making sure the console's clock is up to date, is + a member of this group. +

+

process_services

+

Services in this group tend to process any incoming data. + They typically do things like quality control, or unit conversion, + or sensor calibration.

+

archive_services

+

Once data have been processed, services in this group archive + them.

+

restful_services

+

RESTful services, such as the Weather Underground, or CWOP, + are in this group. They need processed data that have been + archived, hence they are run after the preceeding groups.

+

report_services

+

The various reporting services run in this group, including + the standard reporting engine.

+

For reference, here is the standard set of services that are + run with the default distribution.

+
+prep_services    = weewx.wxengine.StdTimeSynch
+process_services = weewx.wxengine.StdConvert, weewx.wxengine.StdCalibrate, weewx.wxengine.StdQC
+archive_services = weewx.wxengine.StdArchive,
+restful_services = weewx.restx.StdWunderground, weewx.restx.StdPWSweather, weewx.restx.StdCWOP, weewx.restx.StdStationRegistry
+report_services  = weewx.wxengine.StdPrint, weewx.wxengine.StdReport
+
+

If you're the type who cleans out your car's trunk after every use, + you can leave some of these services out if you do not need + them. However, this will only make a slight difference in execution + speed and memory use.

Configuring Station Hardware

Davis Vantage