From 95bf1fbf52ee7cc1631c030a4e98fb32fb0b58bf Mon Sep 17 00:00:00 2001 From: Tom Keffer Date: Mon, 19 Sep 2016 07:20:42 -0700 Subject: [PATCH] Created a new section in the user's guide "Hardware notes" --- docs/css/weewx_docs.css | 3 +- docs/usersguide.htm | 178 ++++++++++++++++++++++++++++++++++++++-- docs/utilities.htm | 151 +++------------------------------- 3 files changed, 182 insertions(+), 150 deletions(-) diff --git a/docs/css/weewx_docs.css b/docs/css/weewx_docs.css index 06ec3a46..bb96a2d4 100644 --- a/docs/css/weewx_docs.css +++ b/docs/css/weewx_docs.css @@ -143,12 +143,13 @@ h1 { webkit-border-radius: 3px; moz-border-radius: 3px; border-radius: 3px; + margin-top: 2em; } h2 { color: teal; font-size: 140%; font-weight: bold; - margin-top: 10px; + margin-top: 2em; } h3 { color: teal; diff --git a/docs/usersguide.htm b/docs/usersguide.htm index a178606e..b5986b8c 100644 --- a/docs/usersguide.htm +++ b/docs/usersguide.htm @@ -2878,13 +2878,176 @@ report_services = weewx.engine.StdPrint, weewx.engine.StdReport difference in execution speed and memory use.

-

Configuring hardware

-

For information on how to configure your hardware, see - the documentation for the utility +

Hardware notes

+ + +

This section lists some the limitations and abilities of the various types + of hardware that weewx supports.

+ +

For information on how to configure your hardware, see the utility wee_device.

+

AcuRite

+

The AcuRite console must be set to USB mode 3 or 4. Communication via USB is disabled in modes 1 and 2. Mode + 4 is more reliable than mode 3; mode 3 enables logging of data, mode 4 does not. When the console is logging + it frequently causes USB communication problems.

+ +

The wind speed updates every 18 seconds. The wind direction updates every 30 seconds. Other sensors update + every 60 seconds.

+ +

The AcuRite stations do not record wind gusts.

+ +

The station emits partial packets, which may confuse some online services

+ + +

CC3000

+

The CC3000 data logger stores 2MB of records.

+ +

The CC3000 driver supports catchup on startup, but it does not support hardware record generation.

+ + +

FineOffsetUSB

+ +

The station clock can only be set manually via buttons on the console, or (if the station supports it) by + WWVB radio. The FineOffsetUSB driver ignores the station clock since it cannot be trusted.

+ +

The station reads data from the sensors every 48 seconds. The 30xx stations read UV data every 60 + seconds.

+ +

The 10xx and 20xx stations can save up to 4080 historical readings. That is about 85 days of data with the + default recording interval of 30 minutes, or about 14 days with a recording interval of 5 minutes. The 30xx + stations can save up to 3264 historical readings.

+ +

When weewx starts up it will attempt to download all records from the console since + the last record in the archive database.

+ +

Polling mode and the polling interval

+ +

When reading 'live' data, weewx can read as fast as possible, or at a user-defined + period. This is controlled by the option polling_mode in + weewx.conf.

+ + + + + + + + + + + + + + + + + +
Polling modes for Fine Offset stations
Modeweewx.confNotes
ADAPTIVE + 
[FineOffsetUSB]
+    polling_mode = ADAPTIVE
+ 		+

In this mode, weewx reads data from the station as often as possible, + but at intervals that avoid communication between the console and the sensors. Nominally this + results in reading data every 48 seconds.

+
PERIODIC + 
[FineOffsetUSB]
+    polling_mode = PERIODIC
+    polling_interval = 60
+ 		+

In this mode, weewx reads data from the station every polling_interval seconds.

+ +

The console reads the sensors every 48 seconds (60 seconds for UV), so setting the polling_interval to a value less than 48 will result in duplicate + readings.

+
+ +

TE923

+

Some station models will recognize up to 5 remote temperature/humidity sensor units. Use the hardware switch + in each sensor unit to identify sensors. Use the map in weewx.conf + to associate each sensor with a database field.

+ +

The station has either 208 or 3442 history records, depending on the model. That is just over a day (208 + records) or about 23 days (3442 records) with an archive interval of 5 minutes.

+ +

The TE923 driver will read history records from the station when weewx starts up, but it does not support + hardware record generation.

+ +

Ultimeter

+

The Ultimeter driver operates the Ultimeter in Data Logger Mode, which results in sensor readings every 1/2 + second or so.

+ +

The Ultimeter driver ignores the maximum, minimum, and average values recorded by the station.

+ +

WMR100

+ +

The station emits partial packets, which may confuse some online services.

+ + +

WMR200

+ +

The station emits partial packets, which may confuse some online services.

+ +

When weewx starts up it will attempt to download all records from the console since + the last record in the archive database.

+ + +

WMR300

+ +

The station emits partial packets, which may confuse some online services.

+ +

When weewx starts up it will attempt to download all records from the console since + the last record in the archive database. This can take a couple of hours, depending on the number of records + in the logger and the speed of the computer and disk.

+ +

WMR9x8

+ +

The station includes a data logger, but the driver does not read records from the station.

+ +

The station emits partial packets, which may confuse some online services.

+ + +

WS1

+ +

The WS1 stations produce data every 1/2 second or so.

+ + +

WS23xx

+ +

The hardware interface is a serial port, but USB-serial converters can be used with computers that have no + serial port. Beware that not every type of USB-serial converter will work. Converters based on ATEN UC-232A + chipset are known to work.

+ +

The station does not record wind gust or wind gust direction.

+ +

The hardware calculates windchill and dewpoint.

+ +

The station has 175 history records. That is just over 7 days of data with the factory default history + recording interval of 60 minutes, or about 14 hours with a recording interval of 5 minutes.

+ +

When weewx starts up it will attempt to download all records from the console since + the last record in the archive database.

+ + +

WS28xx

+ +

weewx communicates with a USB transceiver, which communicates with the station + console, which in turn communicates with the sensors. The transceiver and console must be paired and + synchronized.

+ +

The station has 1797 history records. That is just over 6 days of data with an archive interval of 5 + minutes.

+ +

When weewx starts up it will attempt to download all records from the console since + the last record in the archive database.

+ +

The WS28xx driver sets the station archive interval to 5 minutes.

+ +

The WS28xx driver does not support hardware archive record generation.

+ + -

Running weewx

@@ -3661,7 +3824,7 @@ Nov 27 20:30:23 rpi weewx[5607]: genimages: Generated 11 images in 2.53 seconds<

If you want data and reports closer to real-time, use the - wee_device + wee_device utility to change the interval.

@@ -3835,9 +3998,8 @@ Dec 30 10:54:17 saga weewx[10035]: wxengine: Using archive interval of 1800weewx defers to the station's interval.

-

Use the wee_device utility to change the - station's - interval.

+

Use the wee_device utility to change the + station's interval.

Spikes in the graphs

diff --git a/docs/utilities.htm b/docs/utilities.htm index 4474b30f..38636273 100644 --- a/docs/utilities.htm +++ b/docs/utilities.htm @@ -657,9 +657,9 @@ wee_debug report successfully generated code, it may not work for your specific device. If it does not, you will have to consult your manufacturer's instructions for how to set these things through your console or other means.

-

wee_device determines station type from the station_type - option in weewx.conf. Make sure it's set correctly before attempting to use this - utility.

+

wee_device uses the option station_type + in weewx.conf to determine what device you are using and what options + to display. Make sure it's set correctly before attempting to use this utility.

Because wee_device uses hardware-specific code, its options are different for every station type. You should run it with the --help command to see how to use it for @@ -693,19 +693,7 @@ wee_debug report successfully generated

AcuRite

-

The wee_device utility cannot configure AcuRite stations.

- -

The AcuRite console must be set to USB mode 3 or 4. Communication via USB is disabled in modes 1 and 2. Mode - 4 is more reliable than mode 3; mode 3 enables logging of data, mode 4 does not. When the console is logging - it frequently causes USB communication problems.

- -

The wind speed updates every 18 seconds. The wind direction updates every 30 seconds. Other sensors update - every 60 seconds.

- -

The AcuRite stations do not record wind gusts.

- -

The station emits partial packets, which may confuse some online services

- +

The wee_device utility cannot be used to configure AcuRite stations.

CC3000

@@ -713,10 +701,6 @@ wee_debug report successfully generated --set-units. These are then mapped to the weewx unit groups METRICWX or US, respectively.

-

The CC3000 data logger stores 2MB of records.

- -

The CC3000 driver supports catchup on startup, but it does not support hardware record generation.

-

Invoking wee_device with the --help option will produce something like this:

@@ -761,19 +745,6 @@ interval: 1

FineOffsetUSB

-

The station clock can only be set manually via buttons on the console, or (if the station supports it) by - WWVB radio. The FineOffsetUSB driver ignores the station clock since it cannot be trusted.

- -

The station reads data from the sensors every 48 seconds. The 30xx stations read UV data every 60 - seconds.

- -

The 10xx and 20xx stations can save up to 4080 historical readings. That is about 85 days of data with the - default recording interval of 30 minutes, or about 14 days with a recording interval of 5 minutes. The 30xx - stations can save up to 3264 historical readings.

- -

When weewx starts up it will attempt to download all records from the console since - the last record in the archive database.

-

Invoking wee_device with the --help option will produce something like this:

@@ -871,61 +842,11 @@ Mutating actions will request confirmation before proceeding. bad reads in an hour, but if you see many bad reads within a few minutes, consider replacing the USB cable, USB hub, or removing other devices from the bus.

- -

Polling mode and the polling interval

-

When reading 'live' data, weewx can read as fast as possible, or at a user-defined - period. This is controlled by the polling_mode parameter.

- - - - - - - - - - - - - - - - - -
Polling modes for Fine Offset stations
Modeweewx.confNotes
ADAPTIVE - 
[FineOffsetUSB]
-    polling_mode = ADAPTIVE
- 		-

In this mode, weewx reads data from the station as often as possible, - but at intervals that avoid communication between the console and the sensors. Nominally this - results in reading data every 48 seconds.

-
PERIODIC - 
[FineOffsetUSB]
-    polling_mode = PERIODIC
-    polling_interval = 60
- 		-

In this mode, weewx reads data from the station every polling_interval seconds.

- -

The console reads the sensors every 48 seconds (60 seconds for UV), so setting the polling_interval to a value less than 48 will result in duplicate - readings.

-

TE923

-

Some station models will recognize up to 5 remote temperature/humidity sensor units. Use the hardware switch - in each sensor unit to identify sensors. Use the map in weewx.conf - to associate each sensor with a database field.

- -

The station has either 208 or 3442 history records, depending on the model. That is just over a day (208 - records) or about 23 days (3442 records) with an archive interval of 5 minutes.

- -

The TE923 driver will read history records from the station when weewx starts up, but it does not support - hardware record generation.

-

The wee_device utility can be used to configure the station hardware. When the station_type is TE932, the --help option will produce output something like this:

@@ -1056,12 +977,7 @@ confirmation before proceeding.

Ultimeter

-

The wee_device utility cannot configure Ultimeter stations.

- -

The Ultimeter driver operates the Ultimeter in Data Logger Mode, which results in sensor readings every 1/2 - second or so.

- -

The Ultimeter driver ignores the maximum, minimum, and average values recorded by the station.

+

The wee_device utility cannot be used to configure Ultimeter stations.

Vantage

@@ -1338,64 +1254,31 @@ confirmation before proceeding.

WMR100

-

The wee_device utility cannot configure WMR100 stations.

- -

The station emits partial packets, which may confuse some online services.

+

The wee_device utility cannot be used to configure WMR100 stations.

WMR200

-

The wee_device utility cannot configure WMR200 stations.

- -

The station emits partial packets, which may confuse some online services.

- -

When weewx starts up it will attempt to download all records from the console since - the last record in the archive database.

+

The wee_device utility cannot be used to configure WMR200 stations.

WMR300

-

The wee_device utility cannot configure WMR300 stations.

- -

The station emits partial packets, which may confuse some online services.

- -

When weewx starts up it will attempt to download all records from the console since - the last record in the archive database. This can take a couple of hours, depending on the number of records - in the logger and the speed of the computer and disk.

+

The wee_device utility cannot be used to configure WMR300 stations.

WMR9x8

-

The wee_device utility cannot configure WMR9x8 stations.

- -

The station includes a data logger, but the driver does not read records from the station.

- -

The station emits partial packets, which may confuse some online services.

+

The wee_device utility cannot be used to configure WMR9x8 stations.

WS1

-

The wee_device utility cannot configure WS1 stations.

- -

The WS1 stations produce data every 1/2 second or so.

+

The wee_device utility cannot be used to configure WS1 stations.

WS23xx

-

The hardware interface is a serial port, but USB-serial converters can be used with computers that have no - serial port. Beware that not every type of USB-serial converter will work. Converters based on ATEN UC-232A - chipset are known to work.

- -

The station does not record wind gust or wind gust direction.

- -

The hardware calculates windchill and dewpoint.

- -

The station has 175 history records. That is just over 7 days of data with the factory default history - recording interval of 60 minutes, or about 14 hours with a recording interval of 5 minutes.

- -

When weewx starts up it will attempt to download all records from the console since - the last record in the archive database.

-

When the station_type is WS23xx, the --help option will produce output something like this:

@@ -1472,20 +1355,6 @@ in humidity: 48.0

WS28xx

-

weewx communicates with a USB transceiver, which communicates with the station - console, which in turn communicates with the sensors. The transceiver and console must be paired and - synchronized.

- -

The station has 1797 history records. That is just over 6 days of data with an archive interval of 5 - minutes.

- -

When weewx starts up it will attempt to download all records from the console since - the last record in the archive database.

- -

The WS28xx driver sets the station archive interval to 5 minutes.

- -

The WS28xx driver does not support hardware archive record generation.

-

When the station_type is WS28xx, the --help option will produce output something like this: