Upgrading to weewx v1.10

Version specific directions

What follows are directions for upgrading from specific versions.

V1.9 or earlier

Version 1.10 introduced several new features.

Backwards compatibility

With the introduction of explicit control of output units in the templates such as

$day.outTemp.max.degree_C

the calling signature of the following two Python classes was changed

The example of writing a custom generator MyFileGenerator (which produced "all time" statistics) has been changed to reflect the new signatures.

This will only affect you if you have written a custom generator.

New icons and mobile templates

The skins now include a template formatted for smartphones, as well as an icon ("favicon.ico") that displays in your browser toolbar. If you do nothing, your old skins will continue to work, but you will not take advantage of these new features.

If you want these new features then you have two choices:

  1. Rename your old skin directory (call it "skin.old") then do the install. This will install the new skin distribution. You can modify it to reflect any changes you have made, referring to skin.old for guidance.
  2. Alternatively, change the contents of your existing skin directory to take advantage of the new features. If you take this approach, you will need to copy over files favicon.ico, mobile.css, and mobile.html.tmpl from the distribution into your skin/Standard directory. You will then need to modify your skin.conf.

    Add a new [[[Mobile]]] section:

    [FileGenerator]
      .
      .
      .
      [[ToDate]]
        .
        .
        .
        [[[Mobile]]]
          template = mobile.html.tmpl

    Then add mobile.css and favicon.ico to the list of files to be copied on report generation:

    [CopyGenerator]
      copy_once = backgrounds/*, weewx.css, mobile.css, favicon.ico

Which approach you should take will depend on how extensively you have modified the stock skin distribution. If the modifications are slight, approach #1 will be easier, otherwise use approach #2.

V1.7.0 or earlier

With the introduction of a standard archiving service, StdArchive, the names of some events have changed. This will not affect you unless you have written a custom service.

V.1.5.0 or earlier

V1.7 introduces skins. The skins live in subdirectory skins. They are not compatible with the old template subdirectory --- you can't simply rename templates to skins.

The part of the configuration file dealing with the presentation layer has been split off into a separate file skin.conf. Hence, once again, the installation script setup.py will NOT merge your old weewx.conf configuration file into the new one. You will have to re-edit weewx.conf to put in your customizations. You may also have to edit skin.conf for whatever skin you choose (right now, only one skin, Standard, comes with the distribution).

However, a reinstall of V1.7 will merge your changes for weewx.conf. It will also merge any changes you have made to skin.conf as well.

Please check the following:

The directory 'templates' is no longer used; it has been replaced with directory 'skins'. You may delete it if you wish:

rm -r $WEEWX_ROOT/templates

V1.4.0 or earlier

Because the configuration file weewx.conf changed significantly going from V1.4 to V1.5, the installation script setup.py will NOT merge your old configuration file into the new one. You will have to re-edit weewx.conf to put in your customizations.

V1.2.0 or earlier

Optional

Option clock_check, previously found in the [VantagePro] section, is now found in the [Station] section. The install program will put a default value in the new place, but it will not delete nor move your old value over. If you have changed this value or if you can't stand the thought of clock_check appearing in two different places, you should delete the old one found under [VantagePro] and make sure the new value, found under [Station] is correct.

Two Python files are no longer used, so they may be deleted from your installation if you wish:

rm $WEEWX_ROOT/bin/weewx/processdata.py
rm $WEEWX_ROOT/bin/weewx/mainloop.py

In addition, file readme.htm has been moved to subdirectory $WEEWX_ROOT/docs, so the old one can be deleted:

rm $WEEWX_ROOT/readme.htm