mirror of
https://github.com/weewx/weewx.git
synced 2026-04-18 08:36:54 -04:00
Created a new section in the user's guide "Hardware notes"
This commit is contained in:
Tom Keffer
@@ -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;
|
||||
|
||||
@@ -2878,13 +2878,176 @@ report_services = weewx.engine.StdPrint, weewx.engine.StdReport
|
||||
difference in execution speed and memory use.</p>
|
||||
|
||||
|
||||
<h1 id="configuring_hardware">Configuring hardware</h1>
|
||||
<p>For information on how to configure your hardware, see
|
||||
the documentation for the utility
|
||||
<h1 id="hardware_notes">Hardware notes</h1>
|
||||
<!-- wee_device documentation moved to utilities.htm -->
|
||||
|
||||
<p>This section lists some the limitations and abilities of the various types
|
||||
of hardware that <span class="weewx">weewx</span> supports.</p>
|
||||
|
||||
<p>For information on how to configure your hardware, see the utility
|
||||
<a href="utilities.htm#wee_device_utility"><span class="code">wee_device</span></a>.</p>
|
||||
|
||||
<h2>AcuRite</h2>
|
||||
<p>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.</p>
|
||||
|
||||
<p>The wind speed updates every 18 seconds. The wind direction updates every 30 seconds. Other sensors update
|
||||
every 60 seconds.</p>
|
||||
|
||||
<p>The AcuRite stations do not record wind gusts.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services</p>
|
||||
|
||||
|
||||
<h2>CC3000</h2>
|
||||
<p>The CC3000 data logger stores 2MB of records.</p>
|
||||
|
||||
<p>The CC3000 driver supports catchup on startup, but it does not support hardware record generation.</p>
|
||||
|
||||
|
||||
<h2>FineOffsetUSB</h2>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The station reads data from the sensors every 48 seconds. The 30xx stations read UV data every 60
|
||||
seconds.</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database.</p>
|
||||
|
||||
<h3 id="polling_mode_and_the_polling_interval">Polling mode and the polling interval</h3>
|
||||
|
||||
<p>When reading 'live' data, <span class='code'>weewx</span> can read as fast as possible, or at a user-defined
|
||||
period. This is controlled by the option <span class='code'>polling_mode</span> in
|
||||
<span class="code">weewx.conf</span>.</p>
|
||||
<table class='indent'>
|
||||
<caption>Polling modes for Fine Offset stations</caption>
|
||||
<tr class="first_row">
|
||||
<td width='15%'>Mode</td>
|
||||
<td width='30%'><span class='code'>weewx.conf</span></td>
|
||||
<td>Notes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="first_col">ADAPTIVE</td>
|
||||
<td>
|
||||
<pre class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = ADAPTIVE</pre>
|
||||
</td>
|
||||
<td>
|
||||
<p>In this mode, <span class='code'>weewx</span> 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.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="first_col">PERIODIC</td>
|
||||
<td>
|
||||
<pre class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = PERIODIC
|
||||
polling_interval = 60</pre>
|
||||
</td>
|
||||
<td>
|
||||
<p>In this mode, <span class='code'>weewx</span> reads data from the station every <span
|
||||
class='code'>polling_interval</span> seconds.</p>
|
||||
|
||||
<p>The console reads the sensors every 48 seconds (60 seconds for UV), so setting the <span
|
||||
class='code'>polling_interval</span> to a value less than 48 will result in duplicate
|
||||
readings. </p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>TE923</h2>
|
||||
<p>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 <span class='code'>map</span> in <span class='code'>weewx.conf</span>
|
||||
to associate each sensor with a database field. </p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The TE923 driver will read history records from the station when weewx starts up, but it does not support
|
||||
hardware record generation.</p>
|
||||
|
||||
<h2>Ultimeter</h2>
|
||||
<p>The Ultimeter driver operates the Ultimeter in Data Logger Mode, which results in sensor readings every 1/2
|
||||
second or so.</p>
|
||||
|
||||
<p>The Ultimeter driver ignores the maximum, minimum, and average values recorded by the station.</p>
|
||||
|
||||
<h2>WMR100</h2>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
|
||||
<h2>WMR200</h2>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database. </p>
|
||||
|
||||
|
||||
<h2>WMR300</h2>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> 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. </p>
|
||||
|
||||
<h2>WMR9x8</h2>
|
||||
|
||||
<p>The station includes a data logger, but the driver does not read records from the station.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
|
||||
<h2>WS1</h2>
|
||||
|
||||
<p>The WS1 stations produce data every 1/2 second or so.</p>
|
||||
|
||||
|
||||
<h2>WS23xx</h2>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The station does not record wind gust or wind gust direction.</p>
|
||||
|
||||
<p>The hardware calculates windchill and dewpoint.</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database.</p>
|
||||
|
||||
|
||||
<h2>WS28xx</h2>
|
||||
|
||||
<p><span class='code'>weewx</span> 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.</p>
|
||||
|
||||
<p>The station has 1797 history records. That is just over 6 days of data with an archive interval of 5
|
||||
minutes.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database. </p>
|
||||
|
||||
<p>The WS28xx driver sets the station archive interval to 5 minutes.</p>
|
||||
|
||||
<p>The WS28xx driver does not support hardware archive record generation.</p>
|
||||
|
||||
|
||||
|
||||
<!-- wee_device documentation moved to utilities.htm -->
|
||||
|
||||
|
||||
<h1 id="running">Running <span class="code">weewx</span></h1>
|
||||
@@ -3661,7 +3824,7 @@ Nov 27 20:30:23 rpi weewx[5607]: genimages: Generated 11 images in 2.53 seconds<
|
||||
</p>
|
||||
|
||||
<p>If you want data and reports closer to real-time, use the
|
||||
<a href="#configuring_hardware"><span class="code">wee_device</span></a>
|
||||
<a href="utilities.htm#wee_device_utility"><span class="code">wee_device</span></a>
|
||||
utility to change the interval.
|
||||
</p>
|
||||
|
||||
@@ -3835,9 +3998,8 @@ Dec 30 10:54:17 saga weewx[10035]: wxengine: Using archive interval of 1800</pre
|
||||
hardware interval, <span class="code">weewx</span> defers to the
|
||||
station's interval.</p>
|
||||
|
||||
<p>Use the <a href="#configuring_hardware"><span class="code">wee_device</span></a> utility to change the
|
||||
station's
|
||||
interval.</p>
|
||||
<p>Use the <a href="utilities.htm#wee_device_utility"><span class="code">wee_device</span></a> utility to change the
|
||||
station's interval.</p>
|
||||
|
||||
<h3 id='spikes'>Spikes in the graphs</h3>
|
||||
|
||||
|
||||
@@ -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.</p>
|
||||
|
||||
<p><span class="code">wee_device</span> determines station type from the <span class="code">station_type</span>
|
||||
option in <span class="code">weewx.conf</span>. Make sure it's set correctly before attempting to use this
|
||||
utility.</p>
|
||||
<p><span class="code">wee_device</span> uses the option <span class="code">station_type</span>
|
||||
in <span class="code">weewx.conf</span> to determine what device you are using and what options
|
||||
to display. Make sure it's set correctly before attempting to use this utility.</p>
|
||||
|
||||
<p>Because <span class="code">wee_device</span> uses hardware-specific code, its options are different for every
|
||||
station type. You should run it with the <span class="code">--help</span> command to see how to use it for
|
||||
@@ -693,19 +693,7 @@ wee_debug report successfully generated
|
||||
|
||||
<h2 id="wee_device_acurite">AcuRite</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure AcuRite stations.</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The wind speed updates every 18 seconds. The wind direction updates every 30 seconds. Other sensors update
|
||||
every 60 seconds.</p>
|
||||
|
||||
<p>The AcuRite stations do not record wind gusts.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services</p>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure AcuRite stations.</p>
|
||||
|
||||
<h2 id="wee_device_cc3000">CC3000</h2>
|
||||
|
||||
@@ -713,10 +701,6 @@ wee_debug report successfully generated
|
||||
<span class="code">--set-units</span>. These are then mapped to the weewx unit groups METRICWX or US,
|
||||
respectively.</p>
|
||||
|
||||
<p>The CC3000 data logger stores 2MB of records.</p>
|
||||
|
||||
<p>The CC3000 driver supports catchup on startup, but it does not support hardware record generation.</p>
|
||||
|
||||
<p>Invoking <span class='code'>wee_device</span> with the <span class='code'>--help</span> option will produce
|
||||
something like this:</p>
|
||||
|
||||
@@ -761,19 +745,6 @@ interval: 1</pre>
|
||||
|
||||
<h2 id="wee_device_fousb">FineOffsetUSB</h2>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The station reads data from the sensors every 48 seconds. The 30xx stations read UV data every 60
|
||||
seconds.</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database.</p>
|
||||
|
||||
<p>Invoking <span class='code'>wee_device</span> with the <span class='code'>--help</span> option will produce
|
||||
something like this:</p>
|
||||
|
||||
@@ -871,61 +842,11 @@ Mutating actions will request confirmation before proceeding.</pre>
|
||||
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.</p>
|
||||
|
||||
<!-- TODO: this should be moved to the User's Guide -->
|
||||
<h3 id="polling_mode_and_the_polling_interval">Polling mode and the polling interval</h3>
|
||||
|
||||
<p>When reading 'live' data, <span class='code'>weewx</span> can read as fast as possible, or at a user-defined
|
||||
period. This is controlled by the <span class='code'>polling_mode</span> parameter. </p>
|
||||
<table class='indent'>
|
||||
<caption>Polling modes for Fine Offset stations</caption>
|
||||
<tr class="first_row">
|
||||
<td width='15%'>Mode</td>
|
||||
<td width='30%'><span class='code'>weewx.conf</span></td>
|
||||
<td>Notes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="first_col">ADAPTIVE</td>
|
||||
<td>
|
||||
<pre class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = ADAPTIVE</pre>
|
||||
</td>
|
||||
<td>
|
||||
<p>In this mode, <span class='code'>weewx</span> 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.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="first_col">PERIODIC</td>
|
||||
<td>
|
||||
<pre class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = PERIODIC
|
||||
polling_interval = 60</pre>
|
||||
</td>
|
||||
<td>
|
||||
<p>In this mode, <span class='code'>weewx</span> reads data from the station every <span
|
||||
class='code'>polling_interval</span> seconds.</p>
|
||||
|
||||
<p>The console reads the sensors every 48 seconds (60 seconds for UV), so setting the <span
|
||||
class='code'>polling_interval</span> to a value less than 48 will result in duplicate
|
||||
readings. </p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h2 id="wee_device_te923">TE923</h2>
|
||||
|
||||
<p>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 <span class='code'>map</span> in <span class='code'>weewx.conf</span>
|
||||
to associate each sensor with a database field. </p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The TE923 driver will read history records from the station when weewx starts up, but it does not support
|
||||
hardware record generation.</p>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility can be used to configure the station hardware. When the
|
||||
<span class='code'>station_type</span> is <span class='code'>TE932</span>, the <span
|
||||
class='code'>--help</span> option will produce output something like this:</p>
|
||||
@@ -1056,12 +977,7 @@ confirmation before proceeding.</pre>
|
||||
|
||||
<h2 id="wee_device_ultimeter">Ultimeter</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure Ultimeter stations.</p>
|
||||
|
||||
<p>The Ultimeter driver operates the Ultimeter in Data Logger Mode, which results in sensor readings every 1/2
|
||||
second or so.</p>
|
||||
|
||||
<p>The Ultimeter driver ignores the maximum, minimum, and average values recorded by the station.</p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure Ultimeter stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_vantage">Vantage</h2>
|
||||
@@ -1338,64 +1254,31 @@ confirmation before proceeding.</pre>
|
||||
|
||||
<h2 id="wee_device_wmr100">WMR100</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure WMR100 stations.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure WMR100 stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_wmr200">WMR200</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure WMR200 stations.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database. </p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure WMR200 stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_wmr300">WMR300</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure WMR300 stations.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> 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. </p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure WMR300 stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_wmr9x8">WMR9x8</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure WMR9x8 stations.</p>
|
||||
|
||||
<p>The station includes a data logger, but the driver does not read records from the station.</p>
|
||||
|
||||
<p>The station emits partial packets, which may confuse some online services.</p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure WMR9x8 stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_ws1">WS1</h2>
|
||||
|
||||
<p>The <span class='code'>wee_device</span> utility cannot configure WS1 stations.</p>
|
||||
|
||||
<p>The WS1 stations produce data every 1/2 second or so.</p>
|
||||
<p>The <span class='code'>wee_device</span> utility cannot be used to configure WS1 stations.</p>
|
||||
|
||||
|
||||
<h2 id="wee_device_ws23xx">WS23xx</h2>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>The station does not record wind gust or wind gust direction.</p>
|
||||
|
||||
<p>The hardware calculates windchill and dewpoint.</p>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database.</p>
|
||||
|
||||
<p>When the <span class='code'>station_type</span> is <span class='code'>WS23xx</span>, the <span class='code'>--help</span>
|
||||
option will produce output something like this:</p>
|
||||
|
||||
@@ -1472,20 +1355,6 @@ in humidity: 48.0
|
||||
|
||||
<h2 id="wee_device_ws28xx">WS28xx</h2>
|
||||
|
||||
<p><span class='code'>weewx</span> 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.</p>
|
||||
|
||||
<p>The station has 1797 history records. That is just over 6 days of data with an archive interval of 5
|
||||
minutes.</p>
|
||||
|
||||
<p>When <span class='code'>weewx</span> starts up it will attempt to download all records from the console since
|
||||
the last record in the archive database. </p>
|
||||
|
||||
<p>The WS28xx driver sets the station archive interval to 5 minutes.</p>
|
||||
|
||||
<p>The WS28xx driver does not support hardware archive record generation.</p>
|
||||
|
||||
<p>When the <span class='code'>station_type</span> is <span class='code'>WS28xx</span>, the <span class='code'>--help</span>
|
||||
option will produce output something like this:</p>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user