Highcharts for WeeWX extension

Description

The Highcharts for WeeWX extension provides a JSON data feed to support weekly and yearly observation plots using Highcharts. A sample HTML page and the JavaScript necessary to render the Highcharts plots is also included in the Highcharts for WeeWX repositry.

The Highcharts for WeeWX extension consists of a skin generating two reports, a number of Search List Extensions (SLE) and supporting JavaScript.

Pre-Requisites

The Highcharts for WeeWX extension requires WeeWX v3.4.0 or greater. The display of the Highcharts for WeeWX extension data on a web page using the included Javascript files requires the Highcharts Highstock charting tool and the JQuery JavaScript library.

Installation

The preferred method to install the Highcharts for WeeWX extension is to use the WeeWX wee_extension utility. To install the Highcharts for WeeWX extension using the WeeWX wee_extension utility:

Note: Symbolic names are used below to refer to some file location on the WeeWX system. These symbolic names allow a common name to be used to refer to a directory that may be different from system to system. The following symbolic names are used below:

$HTML_ROOT. The path to the directory where WeeWX generated reports are saved. This directory is normally set in the [StdReport] section of weewx.conf. Refer to where to find things in the WeeWX User's Guide for further information.

1. Download the latest Highcharts for WeeWX extension from the Highcharts for WeeWX releases page into a directory accessible from the WeeWX machine.

   $ wget -P /var/tmp https://github.com/gjr80/weewx-highcharts/releases/download/v0.3.2/hfw-0.3.2.tar.gz
   

2. Install the Highcharts for WeeWX extension downloaded at step 1 using the wee_extension utility:

   $ wee_extension --install=/var/tmp/hfw-0.3.2.tar.gz
   

   Note: Depending on your system/installation the above command may need to be prefixed with sudo.

   This will result in output similar to the following:

   Request to install '/var/tmp/hfw-0.3.2.tar.gz'
   Extracting from tar archive /var/tmp/hfw-0.3.2.tar.gz
   Saving installer file to /home/weewx/bin/user/installer/Hfw
   Saved configuration dictionary. Backup copy at /home/weewx/weewx.conf.20200923124410
   Finished installing extension '/var/tmp/hfw-0.3.2.tar.gz'
   

3. Restart WeeWX:

   $ sudo /etc/init.d/weewx restart
   

   or

   $ sudo service weewx restart
   

   or

   $ sudo systemctl restart weewx
   

This will result in the Highcharts for WeeWX JSON data files being generated during each report generation cycle. A default installation will result in the generated JSON data files being placed in the $HTML_ROOT/json directory. The Highcharts for WeeWX installation can be further customized (eg units of measure, file locations etc) by referring to the Highcharts for WeeWX wiki.

Support

General support issues may be raised in the Google Groups weewx-user forum. Specific bugs in the Highcharts for WeeWX extension code should be the subject of a new issue raised via the Issues Page.

Licensing

The Highcharts for WeeWX extension is licensed under the GNU Public License v3.