/weewx-jas

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

WeeWX-JAS (Just Another Skin)

A WeeWX skin that uses Apache ECharts to chart the data. The following javascript libraries are used in addition to Apache ECharts.

Installation Notes

Because there are multiple methods to install WeeWX, location of files can vary. See where to find things in the WeeWX User's Guide for the definitive information. The following symbolic names are used to define the various locations:

  • $DOWNLOAD_ROOT - The directory containing the downloaded WeeWX-JAS extension.
  • $BIN_ROOT - The directory where WeeWX executables are located.
  • $CONFIG_ROOT - The directory where the configuration (typically, weewx.conf) is located.
  • $HTML_ROOT - The directory where the Web pages and images are created.

The notation vX.Y.Z designates the version being installed. X.Y.Z is the release.

Prior to making any updates/changes, always make a backup.

Preqrequisites

WeeWX version Python version
4.6.0 or greater Python 3.6 or greater

Installation

  1. Download WeeWX-JAS

    wget -P $DOWNLOAD_ROOT https://github.com/bellrichm/weewx-jas/archive/vX.Y.Z.tar.gz
    

    All of the releases can be found here and this is the latest.

  2. Install WeeWX-JAS

    wee_extension --install=$DOWNLOAD_ROOT/vX.Y.Z.tar.gz
    
  3. Optional - run wee_reports

    WeeWX-JAS extracts data from the WeeWX database to be visualized in either charts or tables. Historical and aggregated data does not have to be extracted every archive period. This means that on the first run of WeeWX-JAS all of this data must be extracted. On a low powered machine, such as a Raspberry Pi, this could take longer than one archive period. For this reason some may want to run wee_reports to extract this data.

  4. Restart WeeWX

    sudo /etc/init.d/weewx restart
    

    or

    sudo sudo service restart weewx
    

    or

    sudo systemctl restart weewx
    

Manual Installation

Why? Just use wee_extension. But if you must, read on.

Updating/Upgrading

WeeWX-JAS extracts data from the WeeWX database to be visualized in either charts or tables. Historical and aggregated data does not have to be extracted every archive period. For performance reasons it is extracted on this schedule. This means a new release WeeWX-JAS might require the extracted data to be in a different format. For this reason it is recommended to delete all files that WeeWX-JAS creates prior to upgrading WeeWX-JAS. The default location of these files is, $HTML_ROOT/jas.

After deleting the generated files follow the installation steps.

Customizing

Once the base installation is working see, customizinf for information on how to customize the skin.

Debugging

See, debugging.

Getting Help

Feel free to open an issue, start a discussion in github, or post on WeeWX google group. When doing so, see Help! Posting to weewx user for information on capturing the log. And yes, capturing the log from WeeWX startup makes debugging much easeier.