mirror of
https://github.com/weewx/weewx.git
synced 2026-06-10 01:55:07 -04:00
alphabetize drivers
This commit is contained in:
Matthew Wall
@@ -1103,6 +1103,27 @@ longitude = -77.0366</pre>
|
||||
<td>Option</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">Simulator</td>
|
||||
<td>A software weather station simulator. Useful for testing and
|
||||
debugging.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">CC3000</td>
|
||||
<td>RainWise CC3000 data logger</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">FineOffsetUSB</td>
|
||||
<td>Fine Offset 10xx, 20xx, and 30xx stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">TE923</td>
|
||||
<td>Hideki TE923 stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">Ultimeter</td>
|
||||
<td>PeetBros Ultimeter stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">Vantage</td>
|
||||
<td>Davis Vantage weather stations</td>
|
||||
@@ -1120,8 +1141,8 @@ longitude = -77.0366</pre>
|
||||
<td>Oregon Scientific WMR-918/968 series stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">FineOffsetUSB</td>
|
||||
<td>Fine Offset 10xx, 20xx, and 30xx stations</td>
|
||||
<td class="code first_col">WS1</td>
|
||||
<td>Argent Data Systems WS1 stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">WS23xx</td>
|
||||
@@ -1131,27 +1152,6 @@ longitude = -77.0366</pre>
|
||||
<td class="code first_col">WS28xx</td>
|
||||
<td>La Crosse 28xx stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">TE923</td>
|
||||
<td>Hideki TE923 stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">Ultimeter</td>
|
||||
<td>PeetBros Ultimeter stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">WS1</td>
|
||||
<td>Argent Data Systems WS1 stations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">CC3000</td>
|
||||
<td>RainWise CC3000 data logger</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code first_col">Simulator</td>
|
||||
<td>A software weather station simulator. Useful for
|
||||
debugging.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p id="station_url" class="config_option"><span class="config_important">station_url</span></p>
|
||||
<p>If you have a website, you may optionally specify an URL for
|
||||
@@ -1173,6 +1173,117 @@ longitude = -77.0366</pre>
|
||||
</p>
|
||||
<pre class="tty">week_start = 0</pre>
|
||||
|
||||
<h3 class="config_section">[Simulator]</h3>
|
||||
<p>This section is for options relating to the software weather station simulator
|
||||
that comes with <span class="code">weewx</span>.</p>
|
||||
<p class="config_option">loop_interval</p>
|
||||
<p>The time (in seconds) between emitting loop packets. Default is 2.5</p>
|
||||
<p class="config_option">mode</p>
|
||||
<p>One of either <span class='code'>simulator</span> or <span class='code'>generator</span>. Default is <span class='code'>simulator</span>.</p>
|
||||
<table class="indent">
|
||||
<tr>
|
||||
<td class="code">simulator</td>
|
||||
<td>Real-time simulator. It will sleep between emitting packets.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code">generator</td>
|
||||
<td>Emit packets as fast as it can. Useful for testing.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p class="config_option">start</p>
|
||||
<p>The start time for the generator in the format <span class="code">YYYY-MM-DD
|
||||
hh:mm</span>. Optional. Default is the present time.</p>
|
||||
|
||||
<h3 class="config_section">[CC3000]</h3>
|
||||
<p>This section is for options relating to the RainWise Mark III weather
|
||||
stations and CC3000 data logger.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class='config_option'>polling_interval</p>
|
||||
<p>The <span class="code">polling_interval</span> determines how often
|
||||
<span class="code">weewx</span> will query the station for data. The
|
||||
default is 1 second.
|
||||
</p>
|
||||
|
||||
<h3 class="config_section">[FineOffsetUSB]</h3>
|
||||
<p>This section is for options relating to the Fine Offset series of
|
||||
weather stations with USB connectors.</p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, WH1080, WS2080, WH3081, etc. </p>
|
||||
<p class='config_option'>polling_mode</p>
|
||||
<p>One of <span class='code'>PERIODIC</span> or
|
||||
<span class='code'>ADAPTIVE</span>. In
|
||||
<span class='code'>PERIODIC</span> mode,
|
||||
<span class='code'>weewx</span> queries the console at regular intervals
|
||||
determined by the <span class='code'>polling_interval</span>.
|
||||
In <span class='code'>ADAPTIVE</span> mode,
|
||||
<span class='code'>weewx</span> attempts to query the
|
||||
console at times when it is not reading data from the sensors or writing
|
||||
data to memory. See the section <a href="#polling_mode_and_the_polling_interval">
|
||||
Polling Mode and the Polling Interval</a>
|
||||
for details. The default is <span class='code'>PERIODIC</span>.</p>
|
||||
<p class='config_option'>polling_interval</p>
|
||||
<p>The frequency, in seconds, at which <span class='code'>weewx</span> will
|
||||
poll the console for data. Default is 60. This setting applies only
|
||||
when the <span class='code'>polling_mode</span> is
|
||||
<span class='code'>PERIODIC</span>.</p>
|
||||
|
||||
<h3 class="config_section">[TE923]</h3>
|
||||
<p>This section is for options relating to the Hideki TE923 series of
|
||||
weather stations.</p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, Meade TE923W or TFA Nexus.
|
||||
Default is "TE923".</p>
|
||||
<p class="config_option">sensor_map</p>
|
||||
<p>This option defines the mapping between temperature/humidity values in
|
||||
the database and the remote sensors. Up to 5 remote sensors are
|
||||
supported. A switch on each sensor determines which of 5 channels that
|
||||
sensor will use. For example, if the switch on the sensor is set to 3,
|
||||
the temperature from that sensor will be t_3 and the humidity from that
|
||||
sensor will be h_3.
|
||||
</p>
|
||||
<p>The default mapping is:
|
||||
</p>
|
||||
<pre class="tty">[[sensor_map]]
|
||||
outTemp = t_1
|
||||
outHumidity = h_1
|
||||
extraTemp1 = t_2
|
||||
extraHumid1 = h_2
|
||||
extraTemp2 = t_3
|
||||
extraHumid2 = h_3
|
||||
extraTemp3 = t_4
|
||||
extraHumid3 = h_4
|
||||
extraTemp4 = t_5
|
||||
extraHumid4 = h_5</pre>
|
||||
<p class="config_option">battery_map</p>
|
||||
<p>This option defines the mapping between battery status values in
|
||||
the database and the remote sensors. The default mapping is:
|
||||
</p>
|
||||
<pre class="tty">[[battery_map]]
|
||||
txBatteryStatus = batteryUV
|
||||
windBatteryStatus = batteryWind
|
||||
rainBatteryStatus = batteryRain
|
||||
outTempBatteryStatus = battery1
|
||||
extraBatteryStatus1 = battery2
|
||||
extraBatteryStatus2 = battery3
|
||||
extraBatteryStatus3 = battery4
|
||||
extraBatteryStatus4 = battery5</pre>
|
||||
|
||||
<h3 class="config_section">[Ultimeter]</h3>
|
||||
<p>This section is for options relating to the PeetBros Ultimeter weather
|
||||
stations.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, Ultimeter 2000 or Ultimeter 800.
|
||||
Default is "Ultimeter".</p>
|
||||
|
||||
<h3 class="config_section">[Vantage]</h3>
|
||||
<p>This section is for options relating to the Davis Vantage series of hardware
|
||||
(<em>VantagePro, VantagePro2</em> or <em>VantageVue</em>).</p>
|
||||
@@ -1274,28 +1385,19 @@ longitude = -77.0366</pre>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, WMR968 or WMR918.</p>
|
||||
|
||||
<h3 class="config_section">[FineOffsetUSB]</h3>
|
||||
<p>This section is for options relating to the Fine Offset series of
|
||||
weather stations with USB connectors.</p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, WH1080, WS2080, WH3081, etc. </p>
|
||||
<p class='config_option'>polling_mode</p>
|
||||
<p>One of <span class='code'>PERIODIC</span> or
|
||||
<span class='code'>ADAPTIVE</span>. In
|
||||
<span class='code'>PERIODIC</span> mode,
|
||||
<span class='code'>weewx</span> queries the console at regular intervals
|
||||
determined by the <span class='code'>polling_interval</span>.
|
||||
In <span class='code'>ADAPTIVE</span> mode,
|
||||
<span class='code'>weewx</span> attempts to query the
|
||||
console at times when it is not reading data from the sensors or writing
|
||||
data to memory. See the section <a href="#polling_mode_and_the_polling_interval">
|
||||
Polling Mode and the Polling Interval</a>
|
||||
for details. The default is <span class='code'>PERIODIC</span>.</p>
|
||||
<h3 class="config_section">[WS1]</h3>
|
||||
<p>This section is for options relating to the Argent Data Systems WS1
|
||||
weather stations.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class='config_option'>polling_interval</p>
|
||||
<p>The frequency, in seconds, at which <span class='code'>weewx</span> will
|
||||
poll the console for data. Default is 60. This setting applies only
|
||||
when the <span class='code'>polling_mode</span> is
|
||||
<span class='code'>PERIODIC</span>.</p>
|
||||
<p>The <span class="code">polling_interval</span> determines how often
|
||||
<span class="code">weewx</span> will query the station for data. The
|
||||
default is 1 second.
|
||||
</p>
|
||||
|
||||
<h3 class="config_section">[WS23xx]</h3>
|
||||
<p>This section is for options relating to the La Crosse WS-23xx series of
|
||||
@@ -1330,108 +1432,6 @@ longitude = -77.0366</pre>
|
||||
<p>Set to the station model. For example, LaCrosse WS2810, TFA Primus,
|
||||
etc. Default is "LaCrosse WS28xx".</p>
|
||||
|
||||
<h3 class="config_section">[TE923]</h3>
|
||||
<p>This section is for options relating to the Hideki TE923 series of
|
||||
weather stations.</p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, Meade TE923W or TFA Nexus.
|
||||
Default is "TE923".</p>
|
||||
<p class="config_option">sensor_map</p>
|
||||
<p>This option defines the mapping between temperature/humidity values in
|
||||
the database and the remote sensors. Up to 5 remote sensors are
|
||||
supported. A switch on each sensor determines which of 5 channels that
|
||||
sensor will use. For example, if the switch on the sensor is set to 3,
|
||||
the temperature from that sensor will be t_3 and the humidity from that
|
||||
sensor will be h_3.
|
||||
</p>
|
||||
<p>The default mapping is:
|
||||
</p>
|
||||
<pre class="tty">[[sensor_map]]
|
||||
outTemp = t_1
|
||||
outHumidity = h_1
|
||||
extraTemp1 = t_2
|
||||
extraHumid1 = h_2
|
||||
extraTemp2 = t_3
|
||||
extraHumid2 = h_3
|
||||
extraTemp3 = t_4
|
||||
extraHumid3 = h_4
|
||||
extraTemp4 = t_5
|
||||
extraHumid4 = h_5</pre>
|
||||
<p class="config_option">battery_map</p>
|
||||
<p>This option defines the mapping between battery status values in
|
||||
the database and the remote sensors. The default mapping is:
|
||||
</p>
|
||||
<pre class="tty">[[battery_map]]
|
||||
txBatteryStatus = batteryUV
|
||||
windBatteryStatus = batteryWind
|
||||
rainBatteryStatus = batteryRain
|
||||
outTempBatteryStatus = battery1
|
||||
extraBatteryStatus1 = battery2
|
||||
extraBatteryStatus2 = battery3
|
||||
extraBatteryStatus3 = battery4
|
||||
extraBatteryStatus4 = battery5</pre>
|
||||
|
||||
<h3 class="config_section">[Ultimeter]</h3>
|
||||
<p>This section is for options relating to the PeetBros Ultimeter weather
|
||||
stations.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class="config_important">model</p>
|
||||
<p>Set to the station model. For example, Ultimeter 2000 or Ultimeter 800.
|
||||
Default is "Ultimeter".</p>
|
||||
|
||||
<h3 class="config_section">[WS1]</h3>
|
||||
<p>This section is for options relating to the Argent Data Systems WS1
|
||||
weather stations.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class='config_option'>polling_interval</p>
|
||||
<p>The <span class="code">polling_interval</span> determines how often
|
||||
<span class="code">weewx</span> will query the station for data. The
|
||||
default is 1 second.
|
||||
</p>
|
||||
|
||||
<h3 class="config_section">[CC3000]</h3>
|
||||
<p>This section is for options relating to the RainWise Mark III weather
|
||||
stations and CC3000 data logger.</p>
|
||||
<p class="config_important">port</p>
|
||||
<p>The serial port, e.g., <span class='code'>/dev/ttyS0</span>. When using
|
||||
a USB-Serial converter, the port will be something like
|
||||
<span class='code'>/dev/ttyUSB0</span>. Default is
|
||||
<span class='code'>/dev/ttyUSB0</span></p>
|
||||
<p class='config_option'>polling_interval</p>
|
||||
<p>The <span class="code">polling_interval</span> determines how often
|
||||
<span class="code">weewx</span> will query the station for data. The
|
||||
default is 1 second.
|
||||
</p>
|
||||
|
||||
<h3 class="config_section">[Simulator]</h3>
|
||||
<p>This section is for options relating to the software weather station simulator
|
||||
that comes with <span class="code">weewx</span>.</p>
|
||||
<p class="config_option">loop_interval</p>
|
||||
<p>The time (in seconds) between emitting loop packets. Default is 2.5</p>
|
||||
<p class="config_option">mode</p>
|
||||
<p>One of either <span class='code'>simulator</span> or <span class='code'>generator</span>. Default is <span class='code'>simulator</span>.</p>
|
||||
<table class="indent">
|
||||
<tr>
|
||||
<td class="code">simulator</td>
|
||||
<td>Real-time simulator. It will sleep between emitting packets.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="code">generator</td>
|
||||
<td>Emit packets as fast as it can. Useful for testing.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p class="config_option">start</p>
|
||||
<p>The start time for the generator in the format <span class="code">YYYY-MM-DD
|
||||
hh:mm</span>. Optional. Default is the present time.</p>
|
||||
|
||||
<h2 class="config_section">[StdRESTful]</h2>
|
||||
<p>This section is for configuring the <span class="code">StdRESTful</span>
|
||||
services, which upload to simple
|
||||
@@ -2126,8 +2126,220 @@ report_services = weewx.engine.StdPrint, weewx.engine.StdReport
|
||||
your configuration file is in a non-standard location, specify the
|
||||
path to the configuration file as the first argument. For example,</p>
|
||||
<p class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device /path/to/weewx.conf --help </p>
|
||||
|
||||
<h2 id="wee_config_vantage">Davis Vantage</h2>
|
||||
|
||||
|
||||
<h2 id="wee_config_cc3000">CC3000</h2>
|
||||
<p>The CC3000 data logger may be configured to return data in
|
||||
METRIC or US units. These are not the same groups of METRIC and US
|
||||
units as defined within <span class='code'>weewx</span>. However, the
|
||||
CC3000 driver will convert to the appropriate units for the
|
||||
<span class='code'>weewx</span> configuration.</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>When the <span class='code'>station_type</span> is
|
||||
<span class='code'>CC3000</span>,
|
||||
the <span class='code'>--help</span> option will produce output
|
||||
something like this:</p>
|
||||
<p class="tty">CC3000 driver version 0.8
|
||||
Usage: wee_config_device [config_file] [options] [--debug] [--help]
|
||||
|
||||
Configuration utility for weewx devices.
|
||||
|
||||
Options:
|
||||
-h, --help show this help message and exit
|
||||
--debug display diagnostic information while running
|
||||
-y answer yes to every prompt
|
||||
--info display weather station configuration
|
||||
--current display current weather readings
|
||||
--history=N display N records (0 for all records)
|
||||
--history-since=N display records since N minutes ago
|
||||
--clear-memory clear station memory
|
||||
--set-clock set station clock to computer time
|
||||
--set-interval=N set logging interval to N minutes
|
||||
--set-units=UNITS set units to METRIC or ENGLISH
|
||||
|
||||
Mutating actions will request confirmation before proceeding.</p>
|
||||
|
||||
<h3>Station information</h3>
|
||||
<p>Display the station settings with the <span class='code'>--info</span>
|
||||
option.</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --info </pre>
|
||||
<p>This will result in something like this:</p>
|
||||
<pre class='tty'>firmware: Rainwise CC-3000 Version: 1.3 Build 006 Sep 04 2013
|
||||
time: 2014/06/02 08:22:17
|
||||
units: ENGLISH
|
||||
memory: 251372 bytes, 4334 records, 12%
|
||||
interval: 1</pre>
|
||||
|
||||
<h3 id="cc3000_changing_the_archive_interval">Changing the archive interval</h3>
|
||||
<p>CC3000 loggers ship from the factory with an archive interval
|
||||
of 1 minutes (60 seconds). To change the station's
|
||||
interval to 5 minutes, do the following:</p>
|
||||
<p class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --set-interval=5</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_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>When the <span class='code'>station_type</span> is
|
||||
<span class='code'>FineOffsetUSB</span>,
|
||||
the <span class='code'>--help</span> option will produce output
|
||||
something like this:</p>
|
||||
<p class="tty">FineOffsetUSB driver version 1.7
|
||||
Usage: wee_config_device [config_file] [options] [--debug] [--help]
|
||||
|
||||
Configuration utility for weewx devices.
|
||||
|
||||
Options:
|
||||
-h, --help show this help message and exit
|
||||
--debug display diagnostic information while running
|
||||
-y answer yes to every prompt
|
||||
--info display weather station configuration
|
||||
--current get the current weather conditions
|
||||
--history=N display N records
|
||||
--history-since=N display records since N minutes ago
|
||||
--clear-memory clear station memory
|
||||
--set-time set station clock to computer time
|
||||
--set-interval=N set logging interval to N minutes
|
||||
--live display live readings from the station
|
||||
--logged display logged readings from the station
|
||||
--fixed-block display the contents of the fixed block
|
||||
--check-usb test the quality of the USB connection
|
||||
--check-fixed-block monitor the contents of the fixed block
|
||||
--format=FORMAT format for output, one of raw, table, or dict
|
||||
|
||||
Mutating actions will request confirmation before proceeding.</p>
|
||||
|
||||
<h3>Station information</h3>
|
||||
<p>Display the station settings with the <span class='code'>--info</span>
|
||||
option.</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --info </pre>
|
||||
<p>This will result in something like this:</p>
|
||||
<pre class='tty'>Fine Offset station settings:
|
||||
local time: 2013.02.11 18:34:28 CET
|
||||
polling_mode: ADAPTIVE
|
||||
|
||||
abs_pressure: 933.3
|
||||
current_pos: 592
|
||||
data_changed: 0
|
||||
<span class="highlight">data_count: 22</span>
|
||||
date_time: 2007-01-01 22:49
|
||||
hum_in_offset: 18722
|
||||
hum_out_offset: 257
|
||||
id: None
|
||||
lux_wm2_coeff: 0
|
||||
magic_1: 0x55
|
||||
magic_2: 0xaa
|
||||
model: None
|
||||
rain_coef: None
|
||||
<span class="highlight">read_period: 30</span>
|
||||
<span class="highlight">rel_pressure: 1014.8</span>
|
||||
temp_in_offset: 1792
|
||||
temp_out_offset: 0
|
||||
timezone: 0
|
||||
unknown_01: 0
|
||||
unknown_18: 0
|
||||
version: 255
|
||||
wind_coef: None
|
||||
wind_mult: 0</pre>
|
||||
<p><span class="highlight">Highlighted </span> values can be modified with the <span class='code'>wee_config_device</span> utility.</p>
|
||||
|
||||
<h3 id="fo_changing_the_archive_interval">Changing the archive interval</h3>
|
||||
<p>Fine Offset stations ship from the factory with an archive interval
|
||||
(read_period) of 30 minutes (1800 seconds). To change the station's
|
||||
interval to 5 minutes, do the following:</p>
|
||||
<p class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --set-interval=5</p>
|
||||
|
||||
<h3 id="fo_dumping_the_console_memory">Dumping the console memory</h3>
|
||||
<p>Fine Offset stations store records in a circular buffer — once the buffer fills, the oldest records are replaced by newer records. The 1080 and 2080 consoles store up to 4080 records. The 3080 consoles store up to 3264 records. The <span class='code'>data_count</span> indicates how many records are in memory. The <span class='code'>read_period</span> indicates the number of minutes between records. <span class='code'>wee_config_device</span> can display these records in space-delimited, raw bytes, or dictionary format.</p>
|
||||
<p>For example, to display the most recent 30 records from the console memory:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --history=30</pre>
|
||||
<p>To clear the console memory:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --clear-memory</pre>
|
||||
|
||||
<h3>Checking the USB quality</h3>
|
||||
<p>Use the <span class='code'>wee_config_device</span> utility to test the quality of the USB connection between computer and console. Poor quality USB cables, under-powered USB hubs, and other devices on the bus can interfere with communication.</p>
|
||||
<p>To test the quality of the USB connection to the console:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --check-usb</pre>
|
||||
<p>Let the utility run for at least a few minutes, or possibly an hour or two. It is not unusual to see a few 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>
|
||||
|
||||
<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>
|
||||
<p class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = ADAPTIVE</p>
|
||||
</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>
|
||||
<p class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = PERIODIC
|
||||
polling_interval = 60</p>
|
||||
</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_config_te923">TE923</h2>
|
||||
<p>The <span class='code'>wee_config_device</span> utility cannot
|
||||
configure TE923 stations.</p>
|
||||
<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'>sensor_map</span> in
|
||||
<span class='code'>weewx.conf</span> to map each sensor to a database
|
||||
field.
|
||||
</p>
|
||||
<p>The station has either 200 or 3300 history records, depending on
|
||||
the model. That is just over a day (200 records) or about 23 days
|
||||
(3300 records) with an archive interval of 5 minutes.</p>
|
||||
<p>The TE923 driver is not capable of reading archive records from
|
||||
the station.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_ultimeter">Ultimeter</h2>
|
||||
<p>The <span class='code'>wee_config_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>
|
||||
|
||||
|
||||
<h2 id="wee_config_vantage">Vantage</h2>
|
||||
<p>When the <span class='code'>station_type</span> is
|
||||
<span class='code'>Vantage</span>,
|
||||
the <span class='code'>--help</span> option will produce output
|
||||
@@ -2374,140 +2586,13 @@ Mutating actions will request confirmation before proceeding.</p>
|
||||
services.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_fousb">Fine Offset 10xx, 20xx, 30xx</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>When the <span class='code'>station_type</span> is
|
||||
<span class='code'>FineOffsetUSB</span>,
|
||||
the <span class='code'>--help</span> option will produce output
|
||||
something like this:</p>
|
||||
<p class="tty">FineOffsetUSB driver version 1.7
|
||||
Usage: wee_config_device [config_file] [options] [--debug] [--help]
|
||||
|
||||
Configuration utility for weewx devices.
|
||||
|
||||
Options:
|
||||
-h, --help show this help message and exit
|
||||
--debug display diagnostic information while running
|
||||
-y answer yes to every prompt
|
||||
--info display weather station configuration
|
||||
--current get the current weather conditions
|
||||
--history=N display N records
|
||||
--history-since=N display records since N minutes ago
|
||||
--clear-memory clear station memory
|
||||
--set-time set station clock to computer time
|
||||
--set-interval=N set logging interval to N minutes
|
||||
--live display live readings from the station
|
||||
--logged display logged readings from the station
|
||||
--fixed-block display the contents of the fixed block
|
||||
--check-usb test the quality of the USB connection
|
||||
--check-fixed-block monitor the contents of the fixed block
|
||||
--format=FORMAT format for output, one of raw, table, or dict
|
||||
|
||||
Mutating actions will request confirmation before proceeding.</p>
|
||||
|
||||
<h3>Station information</h3>
|
||||
<p>Display the station settings with the <span class='code'>--info</span>
|
||||
option.</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --info </pre>
|
||||
<p>This will result in something like this:</p>
|
||||
<pre class='tty'>Fine Offset station settings:
|
||||
local time: 2013.02.11 18:34:28 CET
|
||||
polling_mode: ADAPTIVE
|
||||
|
||||
abs_pressure: 933.3
|
||||
current_pos: 592
|
||||
data_changed: 0
|
||||
<span class="highlight">data_count: 22</span>
|
||||
date_time: 2007-01-01 22:49
|
||||
hum_in_offset: 18722
|
||||
hum_out_offset: 257
|
||||
id: None
|
||||
lux_wm2_coeff: 0
|
||||
magic_1: 0x55
|
||||
magic_2: 0xaa
|
||||
model: None
|
||||
rain_coef: None
|
||||
<span class="highlight">read_period: 30</span>
|
||||
<span class="highlight">rel_pressure: 1014.8</span>
|
||||
temp_in_offset: 1792
|
||||
temp_out_offset: 0
|
||||
timezone: 0
|
||||
unknown_01: 0
|
||||
unknown_18: 0
|
||||
version: 255
|
||||
wind_coef: None
|
||||
wind_mult: 0</pre>
|
||||
<p><span class="highlight">Highlighted </span> values can be modified with the <span class='code'>wee_config_device</span> utility.</p>
|
||||
|
||||
<h3 id="fo_changing_the_archive_interval">Changing the archive interval</h3>
|
||||
<p>Fine Offset stations ship from the factory with an archive interval
|
||||
(read_period) of 30 minutes (1800 seconds). To change the station's
|
||||
interval to 5 minutes, do the following:</p>
|
||||
<p class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --set-interval=5</p>
|
||||
|
||||
<h3 id="fo_dumping_the_console_memory">Dumping the console memory</h3>
|
||||
<p>Fine Offset stations store records in a circular buffer — once the buffer fills, the oldest records are replaced by newer records. The 1080 and 2080 consoles store up to 4080 records. The 3080 consoles store up to 3264 records. The <span class='code'>data_count</span> indicates how many records are in memory. The <span class='code'>read_period</span> indicates the number of minutes between records. <span class='code'>wee_config_device</span> can display these records in space-delimited, raw bytes, or dictionary format.</p>
|
||||
<p>For example, to display the most recent 30 records from the console memory:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --history=30</pre>
|
||||
<p>To clear the console memory:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --clear-memory</pre>
|
||||
|
||||
<h3>Checking the USB quality</h3>
|
||||
<p>Use the <span class='code'>wee_config_device</span> utility to test the quality of the USB connection between computer and console. Poor quality USB cables, under-powered USB hubs, and other devices on the bus can interfere with communication.</p>
|
||||
<p>To test the quality of the USB connection to the console:</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --check-usb</pre>
|
||||
<p>Let the utility run for at least a few minutes, or possibly an hour or two. It is not unusual to see a few 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>
|
||||
|
||||
<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>
|
||||
<p class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = ADAPTIVE</p>
|
||||
</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>
|
||||
<p class='tty' style='margin:0'>[FineOffsetUSB]
|
||||
polling_mode = PERIODIC
|
||||
polling_interval = 60</p>
|
||||
</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_config_ws1">WS1</h2>
|
||||
<p>The <span class='code'>wee_config_device</span> utility cannot
|
||||
configure WS1 stations.</p>
|
||||
<p>The WS1 stations produce data every 1/2 second or so.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_ws23xx">La Crosse WS23xx</h2>
|
||||
<h2 id="wee_config_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
|
||||
@@ -2595,7 +2680,7 @@ in humidity: 48.0
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --clear-memory</pre>
|
||||
|
||||
|
||||
<h2 id="wee_config_ws28xx">La Crosse WS28xx</h2>
|
||||
<h2 id="wee_config_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
|
||||
@@ -2736,90 +2821,6 @@ wind_gust_max_time: None</p>
|
||||
can do much more than the console alarms anyway.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_te923">TE923</h2>
|
||||
<p>The <span class='code'>wee_config_device</span> utility cannot
|
||||
configure TE923 stations.</p>
|
||||
<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'>sensor_map</span> in
|
||||
<span class='code'>weewx.conf</span> to map each sensor to a database
|
||||
field.
|
||||
</p>
|
||||
<p>The station has either 200 or 3300 history records, depending on
|
||||
the model. That is just over a day (200 records) or about 23 days
|
||||
(3300 records) with an archive interval of 5 minutes.</p>
|
||||
<p>The TE923 driver is not capable of reading archive records from
|
||||
the station.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_ultimeter">Ultimeter</h2>
|
||||
<p>The <span class='code'>wee_config_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>
|
||||
|
||||
|
||||
<h2 id="wee_config_ws1">WS1</h2>
|
||||
<p>The <span class='code'>wee_config_device</span> utility cannot
|
||||
configure WS1 stations.</p>
|
||||
<p>The WS1 stations produce data every 1/2 second or so.</p>
|
||||
|
||||
|
||||
<h2 id="wee_config_cc3000">RainWise CC3000</h2>
|
||||
<p>The CC3000 data logger may be configured to return data in
|
||||
METRIC or US units. These are not the same groups of METRIC and US
|
||||
units as defined within <span class='code'>weewx</span>. However, the
|
||||
CC3000 driver will convert to the appropriate units for the
|
||||
<span class='code'>weewx</span> configuration.</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>When the <span class='code'>station_type</span> is
|
||||
<span class='code'>CC3000</span>,
|
||||
the <span class='code'>--help</span> option will produce output
|
||||
something like this:</p>
|
||||
<p class="tty">CC3000 driver version 0.8
|
||||
Usage: wee_config_device [config_file] [options] [--debug] [--help]
|
||||
|
||||
Configuration utility for weewx devices.
|
||||
|
||||
Options:
|
||||
-h, --help show this help message and exit
|
||||
--debug display diagnostic information while running
|
||||
-y answer yes to every prompt
|
||||
--info display weather station configuration
|
||||
--current display current weather readings
|
||||
--history=N display N records (0 for all records)
|
||||
--history-since=N display records since N minutes ago
|
||||
--clear-memory clear station memory
|
||||
--set-clock set station clock to computer time
|
||||
--set-interval=N set logging interval to N minutes
|
||||
--set-units=UNITS set units to METRIC or ENGLISH
|
||||
|
||||
Mutating actions will request confirmation before proceeding.</p>
|
||||
|
||||
<h3>Station information</h3>
|
||||
<p>Display the station settings with the <span class='code'>--info</span>
|
||||
option.</p>
|
||||
<pre class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --info </pre>
|
||||
<p>This will result in something like this:</p>
|
||||
<pre class='tty'>firmware: Rainwise CC-3000 Version: 1.3 Build 006 Sep 04 2013
|
||||
time: 2014/06/02 08:22:17
|
||||
units: ENGLISH
|
||||
memory: 251372 bytes, 4334 records, 12%
|
||||
interval: 1</pre>
|
||||
|
||||
<h3 id="cc3000_changing_the_archive_interval">Changing the archive interval</h3>
|
||||
<p>CC3000 loggers ship from the factory with an archive interval
|
||||
of 1 minutes (60 seconds). To change the station's
|
||||
interval to 5 minutes, do the following:</p>
|
||||
<p class="tty"><span class="symcode">$BIN_ROOT</span>/wee_config_device --set-interval=5</p>
|
||||
|
||||
|
||||
<h1 id="configuring_mysql">Configuring MySQL</h1>
|
||||
<p>This section applies only to those who wish to use the MySQL
|
||||
database, instead of the default sqlite database.</p>
|
||||
|
||||
Reference in New Issue
Block a user