This section describes how to configure some of the more popular station hardware, using - configuration utilities supplied with weewx. Directions follow for
-This section describes how to configure some of the more popular + station hardware.
+Some stations can be configured using the + wee_config_device utility supplied with weewx. + This utility uses code in the hardware-specific driver to set EEPROM + constants, read station memory, set the station archive interval, set + the altitude, configure rain bucket types, and many other options, + depending on the hardware.
+Note that some stations cannot be configured by software at all, + and some stations are only partly configurable by software.
+Run the utility with the --help option + to see which options are available.
+$BIN_ROOT/wee_config_device --help
+The utility requires a weewx.conf file. + If no file is specified, it will look for + weewx.conf in the standard location. If + your configuration file is in a non-standard location, specify the + path to the configuration file as the first argument. For example,
+$BIN_ROOT/wee_config_device /path/to/weewx.conf --help
+Weewx comes with a configuration utlity, wee_config_vantage, - that can set many of the on-board EEPROM constants in the Davis Vantage stations, - such as its archive interval, altitude, rain bucket type, etc.
-Run it with --help as an option to see its usage:
-$BIN_ROOT/wee_config_vantage --help
- This will print out something like:
-Usage: wee_config_vantage: [config_file] [--help] [--info] [--clear] - [--set-interval=SECONDS] [--set-altitude=FEET] [--set-barometer=inHg] - [--set-bucket=CODE] [--set-rain-year-start=MM] - [--set-offset=VARIABLE,OFFSET] - [--set-transmitter-type=CHANNEL,TYPE,TEMP,HUM] - [--set-time] [--set-dst=[AUTO|ON|OFF]] - [--set-tz-code=TZCODE] [--set-tz-offset=HHMM] - [--set-lamp=[ON|OFF]] [--dump] [--logger_summary=FILE] [--start | --stop] - -Configures the Davis Vantage weather station. - -Options: - -h, --help show this help message and exit - --config=FILE use configuration file FILE - --info To print configuration, reception, and barometer - calibration information about your weather station. - --clear To clear the memory of your weather station. - --set-interval=SECONDS - Sets the archive interval to the specified number of - seconds. Valid values are 60, 300, 600, 900, 1800, - 3600, or 7200. - --set-altitude=FEET Sets the altitude of the station to the specified - number of feet. - --set-barometer=inHg Sets the barometer reading of the station to a known - correct value in inches of mercury. Specify 0 (zero) - to have the console pick a sensible value. - --set-bucket=CODE Set the type of rain bucket. Specify '0' for 0.01 - inches; '1' for 0.2 mm; '2' for 0.1 mm - --set-rain-year-start=MM - Set the rain year start (1=Jan, 2=Feb, etc.). - --set-offset=VARIABLE,OFFSET - Set the onboard offset for VARIABLE (inTemp, outTemp, - extraTemp[1-7], inHumid, outHumid, extraHumid[1-7], - soilTemp[1-4], leafTemp[1-4], windDir) to OFFSET - --set-transmitter-type=CHANNEL,TYPE,TEMP,HUM - Set the transmitter type for CHANNEL (1-8), TYPE - (0=iss, 1=temp, 2=hum, 3=temp_hum, 4=wind, 5=rain, - 6=leaf, 7=soil, 8=leaf_soil, 9=sensorlink, 10=none), - as extra TEMP station and extra HUM station (both 1-7, - if applicable) - --set-time Set the onboard clock to the current time. - --set-dst=AUTO|ON|OFF - Set DST to 'ON', 'OFF', or 'AUTO' - --set-tz-code=TZCODE Set timezone code to TZCODE. See your Vantage manual - for valid codes. - --set-tz-offset=HHMM Set timezone offset to HHMM. E.g. '-0800' for U.S. - Pacific Time. - --set-lamp=ON|OFF Turn the console lamp 'ON' or 'OFF'. - --start Start the logger. - --stop Stop the logger. - --dump Dump all data to the archive. NB: This may result in - many duplicate primary key errors. - --logger-summary=FILE - Save diagnostic summary to FILE (for debugging the - logger). - -Mutating actions will request confirmation before proceeding. --
It is useful to run it with the --info option to - see what the current EEPROM settings are on your station:
-$BIN_ROOT/wee_config_vantage --info
+ Use the --info option to display the + current EEPROM settings:
+$BIN_ROOT/wee_config_device --info
This will print out something like:
Using configuration file /home/weewx/weewx.conf.
Querying...
@@ -2123,12 +2068,12 @@ Davis Vantage EEPROM settings:
Version: 3.12
CONSOLE SETTINGS:
- Archive interval: 300 (seconds)
- Altitude: 700 (foot)
+ Archive interval: 300 (seconds)
+ Altitude: 700 (foot)
Wind cup type: large
- Rain bucket type: 0.01 inches
- Rain year start: 10
- Onboard time: 2014-09-25 07:41:14
+ Rain bucket type: 0.01 inches
+ Rain year start: 10
+ Onboard time: 2014-09-25 07:41:14
CONSOLE DISPLAY UNITS:
Barometer: inHg
@@ -2139,21 +2084,21 @@ Davis Vantage EEPROM settings:
CONSOLE STATION INFO:
Latitude (onboard): 45.7
Longitude (onboard): -121.6
- Use manual or auto DST? AUTO
- DST setting: N/A
- Use GMT offset or zone code? ZONE_CODE
- Time zone code: 4
- GMT offset: N/A
+ Use manual or auto DST? AUTO
+ DST setting: N/A
+ Use GMT offset or zone code? ZONE_CODE
+ Time zone code: 4
+ GMT offset: N/A
TRANSMITTERS:
- Channel 1: iss
- Channel 2: (N/A)
- Channel 3: temp (as extra temperature 1)
- Channel 4: (N/A)
- Channel 5: (N/A)
- Channel 6: (N/A)
- Channel 7: (N/A)
- Channel 8: (N/A)
+ Channel 1: iss
+ Channel 2: (N/A)
+ Channel 3: temp (as extra temperature 1)
+ Channel 4: (N/A)
+ Channel 5: (N/A)
+ Channel 6: (N/A)
+ Channel 7: (N/A)
+ Channel 8: (N/A)
RECEPTION STATS:
Total packets received: 10670
@@ -2163,8 +2108,8 @@ Davis Vantage EEPROM settings:
Number of CRC errors: 651
BAROMETER CALIBRATION DATA:
- Current barometer reading: 29.834 inHg
- Altitude: 700 feet
+ Current barometer reading: 29.834 inHg
+ Altitude: 700 feet
Dew point: 55 F
Virtual temperature: 59 F
Humidity correction factor: 27
@@ -2174,22 +2119,21 @@ Davis Vantage EEPROM settings:
Offset: -47.000
OFFSETS:
- Wind direction: +0 deg
- Inside Temperature: +0.0 F
- Inside Humidity: +0%
- Outside Temperature: +0.0 F
- Outside Humidity: +0%
- Extra Temperature 1: +0.0 F
+ Wind direction: +0 deg
+ Inside Temperature: +0.0 F
+ Inside Humidity: +0%
+ Outside Temperature: +0.0 F
+ Outside Humidity: +0%
+ Extra Temperature 1: +0.0 F
The console version number is available only on consoles with firmware dates after about 2006.
-Highlighted values can be changed using this utility.
-For example, to change the archive interval to 10 minutes (600 seconds):
-$BIN_ROOT/wee_config_vantage --set-interval=600
+ Highlighted values can be changed using this utility.
+ +To set the time zone code to Central European Time (code 20):
-$BIN_ROOT/wee_config_vantage --set-tz-code=20
+ $BIN_ROOT/wee_config_device --set-tz-code=20
You can set either the time zone code or the time zone offset, but not both.
-Other parameters can be set in a similar manner.
Valid archive intervals for the Davis Vantage stations are 60, @@ -2199,30 +2143,34 @@ Davis Vantage EEPROM settings: archive record is due. If this is the case, you should pick an archive interval of at least 300 seconds, or trim the number of files you are using.
-I have found that a five minute (300 seconds) archive interval works well - for the Vantage stations. Because of the large amount of onboard memory they carry, - going to a larger interval does not have any real advantages.
+To change the archive interval to 10 minutes (600 seconds):
+$BIN_ROOT/wee_config_device --set-interval=600
+ I have found that a five minute (300 seconds) archive interval works + well for the Vantage stations. Because of the large amount of onboard + memory they carry, going to a larger interval does not have any real + advantages.
Normally, this is set by Davis, but if you have replaced your bucket with - a different kind, you might want to reconfigure. For example, to change to a - 0.1 mm bucket (bucket code "2"), use the following:
-$BIN_ROOT/wee_config_vantage --set-bucket=2
+ Normally, this is set by Davis, but if you have replaced your bucket + with a different kind, you might want to reconfigure. For example, to + change to a 0.1 mm bucket (bucket code "2"), use the + following:
+$BIN_ROOT/wee_config_device --set-bucket=2
- If you have additional sensors for your Vantage station, you can configure them using your console. However, if you have a Davis Weather Envoy receiver, it will not have a console! As an alternative, the weewx - utility wee_config_vantage lets + utility wee_config_device lets you do this from the command line.
For example, to add an extra temperature sensor to channel 3, do the following:
-$BIN_ROOT/wee_config_vantage --set-transmitter-type=3,1,2
+ $BIN_ROOT/wee_config_device --set-transmitter-type=3,1,2
This says to turn on channel 3, set its type to 1 ("Temperature only"), and have it show up in the database as extraTemp2. Here's another example, this time for a combined temperature / humidity sensor:
-$BIN_ROOT/wee_config_vantage --set-transmitter-type=5,3,2,4
+ $BIN_ROOT/wee_config_device --set-transmitter-type=5,3,2,4
This will add the combined sensor to channel 5, set its type to 3 ("Temperature and humidity"), and it will show up in the database as extraTemp2 and extraHumid4.
@@ -2240,7 +2188,7 @@ Davis Vantage EEPROM settings: 180° offset correction. You can do this with the following command: -$BIN_ROOT/wee_config_vantage --set-offset=windDir,180
+ $BIN_ROOT/wee_config_device --set-offset=windDir,180
Generally, weewx downloads only new archive @@ -2252,7 +2200,7 @@ Davis Vantage EEPROM settings: lose any data which might have accumulated in the logger memory, but not yet downloaded. By using the --dump command before clearing the memory, you might be able to save these data.
-$BIN_ROOT/wee_config_vantage --dump
+ $BIN_ROOT/wee_config_device --dump
This will dump all data archived in the Vantage memory directly to the database, without regard to whether or not they have been seen before. Because the command dumps all data, it may result in many @@ -2260,26 +2208,30 @@ Davis Vantage EEPROM settings:
There is no configuration utility in weewx - for the WMR100 stations.
-The station emits partial packets, which may confuse some online services.
+The wee_config_device utility cannot + configure WMR100 stations.
+The station emits partial packets, which may confuse some online + services.
There is no configuration utility in weewx - for the WMR200 stations.
+The wee_config_device utility cannot + configure WMR200 stations.
When weewx starts up it will attempt to download all records from the console since the last record in the archive database.
-The station emits partial packets, which may confuse some online services.
+The station emits partial packets, which may confuse some online + services.
There is no configuration utility in weewx - for the 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_config_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 configuration utility wee_config_fousb is - designed to diagnose and configure Fine Offset stations.
-Run it with --help as an option to see its usage:
-$BIN_ROOT/wee_config_fousb --help
- This will print out something like:
-Usage: wee_config_fousb [config_file] [options] [--help] - -Configuration utility for Fine Offset weather stations. - -Options: - -h, --help show this help message and exit - --config=FILE use configuration file FILE - --info display weather station configuration - --check-pressures query station for pressure sensor data - --check-units compare raw and converted LOOP packets - --check-usb test the quality of the USB connection - --check-fixed-block monitor the contents of the fixed block - --fixed-block display the contents of the fixed block - --live display live readings from the station - --logged display logged readings from the station - --history-since=N display records since N minutes ago - --history=N display N records - --format=FORMAT format for output, one of raw, table, or dict - --set-clock set station clock to computer time - --set-pressure=P set relative pressure to P hPa (mbar) - --set-interval=N set logging interval to N minutes - --clear-memory clear station memory - --slp=SLP calculate pressure offset from sea level pressure SLP - -y answer yes to every prompt - --debug display diagnostic information while running - -Mutating actions will request confirmation before proceeding.
Display the station settings with the --info option.
-$BIN_ROOT/wee_config_fousb --info
+ $BIN_ROOT/wee_config_device --info
This will result in something like this:
Fine Offset station settings:
local time: 2013.02.11 18:34:28 CET
@@ -2360,25 +2280,25 @@ Mutating actions will request confirmation before proceeding.
version: 255
wind_coef: None
wind_mult: 0
- Highlighted values can be modified with the wee_config_fousb utility.
+Highlighted values can be modified with the wee_config_device utility.
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:
-$BIN_ROOT/wee_config_fousb --set-interval=5
+$BIN_ROOT/wee_config_device --set-interval=5
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 data_count indicates how many records are in memory. The read_period indicates the number of minutes between records. wee_config_fousb can display these records in space-delimited, raw bytes, or dictionary format.
+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 data_count indicates how many records are in memory. The read_period indicates the number of minutes between records. wee_config_device can display these records in space-delimited, raw bytes, or dictionary format.
For example, to display the most recent 30 records from the console memory:
-$BIN_ROOT/wee_config_fousb --history=30
+ $BIN_ROOT/wee_config_device --history=30
To clear the console memory:
-$BIN_ROOT/wee_config_fousb --clear-memory
+ $BIN_ROOT/wee_config_device --clear-memory
Use the wee_config_fousb 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.
+Use the wee_config_device 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.
To test the quality of the USB connection to the console:
-$BIN_ROOT/wee_config_fousb --check-usb
+ $BIN_ROOT/wee_config_device --check-usb
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.
The configuration utility wee_config_ws23xx is - designed to diagnose and configure WS23xx stations.
-Run it with --help as an option to see its usage:
-$BIN_ROOT/wee_config_ws23xx --help
- This will print out something like:
-Usage: wee_config_ws23xx [config_file] [options] [--debug] -Configuration utility for WS-23xx weather stations. - -Options: - -h, --help show this help message and exit - --config=FILE configuration file - --info display weather station configuration - --current get the current weather conditions - --history-since=N display history records since N minutes ago - --history=N display N history records - --set-time set the station clock to the current time - --set-interval=N set the station archive interval to N minutes - --clear-memory clear station memory - -y answer yes to every prompt - --debug display diagnostic information while running - -Mutating actions will request confirmation before proceeding.
Display the station settings with the --info option.
-$BIN_ROOT/wee_config_ws23xx --info
+ $BIN_ROOT/wee_config_device --info
This will result in something like this:
Driver version 0.6
Querying the station for the configuration...
@@ -2489,12 +2387,9 @@ in humidity: 48.0
WS23xx stations ship from the factory with an archive interval of 60
minutes (3600 seconds). To change the station's interval to 5 minutes,
do the following:
- $BIN_ROOT/wee_config_ws23xx --set-interval=5
- Choose the archive interval carefully! Once
- chosen, it cannot be changed without messing up the statistics (highs
- and lows will be OK, but averages and RMS wind speed will be wrong).
- Changing the recording interval will clear the station
- memory.
+ $BIN_ROOT/wee_config_device --set-interval=5
+ Warning!
+ Changing the recording interval will clear the station memory.
Dumping the console memory
WS23xx stations store records in a circular buffer - once the
@@ -2505,9 +2400,9 @@ in humidity: 48.0
history interval indicates the number of
minutes between records.
For example, to display the latest 30 records from the console memory:
- $BIN_ROOT/wee_config_ws23xx --history=30
+ $BIN_ROOT/wee_config_device --history=30
To clear the console memory:
- $BIN_ROOT/wee_config_ws23xx --clear-memory
+ $BIN_ROOT/wee_config_device --clear-memory
@@ -2525,29 +2420,6 @@ in humidity: 48.0
The WS28xx driver does not support hardware archive record
generation.
- The configuration utility wee_config_ws28xx is
- designed to diagnose and configure WS28xx stations.
- Run it with --help as an option to see its usage:
- $BIN_ROOT/wee_config_ws28xx --help
- This will print out something like:
- Usage: wee_config_ws28xx [config_file] [options] [--debug]
-
-Configuration utility for WS-28xx weather stations.
-
-Options:
- -h, --help show this help message and exit
- --config=FILE configuration file
- --check-transceiver check USB transceiver
- --pair pair the USB transceiver with a station console
- --info display weather station configuration
- --current get the current weather conditions
- --history-since=N display history records since N minutes ago
- --history=N display N history records
- --format=FORMAT format for history, one of raw, table, or dict
- --maxtries=MAXTRIES maximum number of retries, 0 indicates no max
- --debug display diagnostic information while running
-
-Mutating actions will request confirmation before proceeding.
Pairing
The console and transceiver must be paired. Pairing ensures that your
@@ -2607,8 +2479,8 @@ Mutating actions will request confirmation before proceeding.
There is no configuration utility in weewx - for the TE923 stations.
+The wee_config_device utility cannot + configure TE923 stations.
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.
@@ -2624,8 +2496,8 @@ Mutating actions will request confirmation before proceeding.There is no configuration utility in weewx - for the Ultimeter stations.
+The wee_config_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 @@ -2633,8 +2505,8 @@ Mutating actions will request confirmation before proceeding.
There is no configuration utility in weewx - for the WS1 stations.
+The wee_config_device utility cannot + configure WS1 stations.
The WS1 stations produce data every 1/2 second or so.
@@ -2647,33 +2519,10 @@ Mutating actions will request confirmation before proceeding. units as defined within weewx. However, the CC3000 driver will convert to the appropriate units for the weewx configuration. -The configuration utility wee_config_cc3000 is - designed to diagnose and configure RainWise CC3000 data loggers.
-Run it with --help as an option to see its usage:
-$BIN_ROOT/wee_config_cc3000 --help
- This will print out something like:
-Usage: wee_config_cc3000 [config_file] [options] [--help] -Configuration utility for RainWise CC3000 data logger. - -Options: - -h, --help show this help message and exit - --config=FILE use configuration file FILE - --info display weather station configuration - --current display current weather readings - --history=N display N records (specify 0 for all records) - --set-clock set station clock to computer time - --set-units=UNITS set units to METRIC or ENGLISH - --set-interval=N set logging interval to N minutes - --clear-memory clear station memory - -y answer yes to every prompt - --debug display diagnostic information while running - -Mutating actions will request confirmation before proceeding. -
Display the station settings with the --info option.
-$BIN_ROOT/wee_config_cc3000 --info
+ $BIN_ROOT/wee_config_device --info
This will result in something like this:
firmware: Rainwise CC-3000 Version: 1.3 Build 006 Sep 04 2013 time: 2014/06/02 08:22:17 @@ -2685,10 +2534,7 @@ interval: 1
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:
-$BIN_ROOT/wee_config_cc3000 --set-interval=5
-Choose the archive interval carefully! Once - chosen, it cannot be changed without messing up the statistics (highs - and lows will be OK, but averages and RMS wind speed will be wrong).
+$BIN_ROOT/wee_config_device --set-interval=5
$BIN_ROOT/wee_config_vantage --clear
+ $BIN_ROOT/wee_config_device --clear
See also the section Dumping the logger memory, which may help you avoid data loss.
Use the appropriate wee_config_XXX utility to change the station's interval.
+Use the appropriate wee_config_device utility to change the station's interval.
Occasionally you may see anomalous readings, typically manifested as