Quick Start Guide

Quick Start Guide

Introduction

This is the quick start guide to installing the Realtime gauge-data extension. It should be used to complete a Realtime gauge-data extension installation using the WeeWX utility wee_extension. If you wish to manually install the Realtime gauge-data extension you should refer to the manual installation instructions in the Realtime gauge-data readme. If you wish to customise an existing installation or configure the SteelSeries Weather Gauges for use with the Realtime gauge-data extension output you should refer to the relevant page in the Realtime gauge-data extension wiki.

Pre-requisites

The Realtime gauge-data extension requires WeeWX v3.4.0 or greater operating under Python2 or Python 3.

File Locations

As WeeWX file locations vary by system and installation method, the following symbolic name, as per the Where to find things section of the WeeWX User's Guide, are used in these instructions:

• 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.

Quick Start

1. Download the latest Realtime gauge-data extension package:

    $ wget -P /var/tmp https://github.com/gjr80/weewx-realtime_gauge-data/releases/download/v0.5.0/rtgd-0.5.0.tar.gz
   

2. Install the Realtime gauge-data extension:

    $ wee_extension --install=/var/tmp/rtgd-0.5.0.tar.gz
   

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

   Note: Depending on your WeeWX installation wee_extension may need to be prefixed with the path to wee_extension.

3. Restart the WeeWX daemon:

    $ sudo /etc/init.d/weewx restart
   

   or

    $ sudo service weewx restart
   

   or

    $ sudo systemctl restart weewx
   

4. This will result in the gauge-data.txt file being generated and saved in the HTML_ROOT directory.