-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor reformatting for v0.2.1 release
- Loading branch information
Showing
4 changed files
with
93 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,20 @@ | ||
| v0.2.0 | ||
| v0.2.1 | ||
| * fixed error that resulted in incorrect pressL and pressH values | ||
| v0.2 | ||
| * now runs in a thread to eliminate blocking impact on weewx | ||
| * now calculates WindRoseData | ||
| * now calculates pressL and pressH | ||
| * frequency of generation is now specified by a single config option | ||
| * frequency of generation is now specified by a single config option | ||
| min_interval | ||
| * gauge-data.txt output path is now specified by rtgd_path config option | ||
| * added config options for windrose period and number of compass points to | ||
| * added config options for windrose period and number of compass points to | ||
| be generated | ||
|
|
||
| v0.1.2 | ||
| * fix error that occurred when stations do not emit radiation | ||
|
|
||
| v0.1.1 | ||
| * better handle loop observations that are None | ||
| v0.1.0 | ||
|
|
||
| v0.1 | ||
| * initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,12 +11,14 @@ | |
| # | ||
| # Installer for Realtime gauge-data | ||
| # | ||
| # Version: 0.2.0 Date: 24 January 2017 | ||
| # Version: 0.2.1 Date: 15 February 2017 | ||
| # | ||
| # Revision History | ||
| # 24 January 2017 v0.2.0 | ||
| # 15 February 2017 v0.2.1 | ||
| # - minor formatting changes | ||
| # 24 January 2017 v0.2 | ||
| # - updated weewx.conf options | ||
| # 10 January 2017 v0.1.0 | ||
| # 10 January 2017 v0.1 | ||
| # - initial implementation | ||
| # | ||
|
|
||
|
|
@@ -26,22 +28,22 @@ | |
| from setup import ExtensionInstaller | ||
|
|
||
| REQUIRED_VERSION = "3.4.0" | ||
| RTGD_VERSION = "0.2.0" | ||
| RTGD_VERSION = "0.2.1" | ||
|
|
||
| def loader(): | ||
| return RtgdInstaller() | ||
|
|
||
| class RtgdInstaller(ExtensionInstaller): | ||
| def __init__(self): | ||
| if StrictVersion(weewx.__version__) < StrictVersion(REQUIRED_VERSION): | ||
| msg = "%s requires weewx %s or greater, found %s" % ('Rtgd ' + RTGD_VERSION, | ||
| msg = "%s requires weeWX %s or greater, found %s" % ('Rtgd ' + RTGD_VERSION, | ||
| REQUIRED_VERSION, | ||
| weewx.__version__) | ||
| raise weewx.UnsupportedFeature(msg) | ||
| super(RtgdInstaller, self).__init__( | ||
| version=RTGD_VERSION, | ||
| name='Rtgd', | ||
| description='weewx support for near realtime updating of the SteelSeries Weather Gauges.', | ||
| description='weeWX support for near realtime updating of the SteelSeries Weather Gauges.', | ||
| author="Gary Roderick", | ||
| author_email="[email protected]", | ||
| report_services=['user.rtgd.RealtimeGaugeData'], | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,128 +1,134 @@ | ||
| The Realtime gauge-data extension provides for near realtime updating of the | ||
| SteelSeries Weather Gauges by weewx. The extension consists of a weewx service | ||
| that generates the file gauge-data.txt used to update the SteelSeries Weather | ||
| The Realtime gauge-data extension provides for near realtime updating of the | ||
| SteelSeries Weather Gauges by weeWX. The extension consists of a weeWX service | ||
| that generates the file gauge-data.txt used to update the SteelSeries Weather | ||
| Gauges. | ||
|
|
||
| Pre-Requisites | ||
|
|
||
| The Realtime gauge-data extension requires weewx v3.4.0 or greater. | ||
| The Realtime gauge-data extension requires weeWX v3.4.0 or greater. | ||
|
|
||
| Installation Instructions | ||
|
|
||
| Installation using the wee_extension utility | ||
| Installation using the 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 | ||
| 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: | ||
|
|
||
| - $DOWNLOAD_ROOT. The path to the directory containing the downloaded | ||
| - $DOWNLOAD_ROOT. The path to the directory containing the downloaded | ||
| Realtime gauge-data extension. | ||
|
|
||
| - $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: | ||
| http://weewx.com/docs/usersguide.htm#Where_to_find_things for further | ||
|
|
||
| - $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: | ||
| http://weewx.com/docs/usersguide.htm#Where_to_find_things for further | ||
| information. | ||
|
|
||
| - $BIN_ROOT. The path to the directory where weeWX executables are located. | ||
| This directory varies depending on weeWX installation method. Refer to | ||
| 'where to find things' in the weeWX User's Guide: | ||
| http://weewx.com/docs/usersguide.htm#Where_to_find_things for further | ||
| information. | ||
| - $SKIN_ROOT. The path to the directory where weewx skin folders are located | ||
| This directory is normally set in the [StdReport] section of | ||
| weewx.conf. Refer to 'where to find things' in the weewx User's Guide: | ||
| http://weewx.com/docs/usersguide.htm#Where_to_find_things for further | ||
|
|
||
| - $SKIN_ROOT. The path to the directory where weeWX skin folders are located. | ||
| This directory is normally set in the [StdReport] section of | ||
| weewx.conf. Refer to 'where to find things' in the weeWX User's Guide: | ||
| http://weewx.com/docs/usersguide.htm#Where_to_find_things for further | ||
| information. | ||
|
|
||
| 1. Download the latest Realtime gauge-data extension from the Realtime | ||
| 1. Download the latest Realtime gauge-data extension from the Realtime | ||
| gauge-data releases page (https://github.com/gjr80/weewx-realtime_gauge-data | ||
| /releases) into | ||
| a directory accessible from the weewx machine. | ||
| a directory accessible from the weeWX machine. | ||
|
|
||
| wget -P $DOWNLOAD_ROOT https://github.com/gjr80/weewx-realtime_gauge-data | ||
| /releases/download/v0.2.0/rtgd-0.2.0.tar.gz | ||
| /releases/download/v0.2.1/rtgd-0.2.1.tar.gz | ||
|
|
||
| where $DOWNLOAD_ROOT is the path to the directory where the Realtime | ||
| gauge-data extension is to be downloaded. | ||
| where $DOWNLOAD_ROOT is the path to the directory where the Realtime | ||
| gauge-data extension is to be downloaded. | ||
|
|
||
| 2. Stop weewx: | ||
| 2. Stop weeWX: | ||
|
|
||
| sudo /etc/init.d/weewx stop | ||
|
|
||
| or | ||
|
|
||
| sudo service weewx stop | ||
|
|
||
| 3. Install the Realtime gauge-data extension downloaded at step 1 using the | ||
| 3. Install the Realtime gauge-data extension downloaded at step 1 using the | ||
| *wee_extension* utility: | ||
|
|
||
| wee_extension --install=$DOWNLOAD_ROOT/rtgd-0.2.0.tar.gz | ||
| wee_extension --install=$DOWNLOAD_ROOT/rtgd-0.2.1.tar.gz | ||
|
|
||
| This will result in output similar to the following: | ||
|
|
||
| Request to install '/var/tmp/rtgd-0.2.0.tar.gz' | ||
| Extracting from tar archive /var/tmp/rtgd-0.2.0.tar.gz | ||
| Request to install '/var/tmp/rtgd-0.2.1.tar.gz' | ||
| Extracting from tar archive /var/tmp/rtgd-0.2.1.tar.gz | ||
| Saving installer file to /home/weewx/bin/user/installer/Rtgd | ||
| Saved configuration dictionary. Backup copy at /home/weewx/weewx.conf.20161123124410 | ||
| Finished installing extension '/var/tmp/rtgd-0.2.0.tar.gz' | ||
| Finished installing extension '/var/tmp/rtgd-0.2.1.tar.gz' | ||
|
|
||
| 4. Start weewx: | ||
| 4. Start weeWX: | ||
|
|
||
| sudo /etc/init.d/weewx start | ||
|
|
||
| or | ||
|
|
||
| sudo service weewx start | ||
|
|
||
| This will result in the gauge-data.txt file being generated upon receipt of | ||
| every nth loop packet. A default installation will result in the generated | ||
| gauge-data.txt file being placed in the $HTML_ROOT directory. The Realtime | ||
| gauge-data extension installation can be further customized (eg file locations | ||
| This will result in the gauge-data.txt file being generated upon receipt of | ||
| every nth loop packet. A default installation will result in the generated | ||
| gauge-data.txt file being placed in the $HTML_ROOT directory. The Realtime | ||
| gauge-data extension installation can be further customized (eg file locations | ||
| etc) by referring to the Realtime gauge-data extension wiki. | ||
|
|
||
| Manual installation | ||
|
|
||
| 1. Download the latest Realtime gauge-data extension from the Realtime | ||
| 1. Download the latest Realtime gauge-data extension from the Realtime | ||
| gauge-data releases page (https://github.com/gjr80/weewx-realtime_gauge-data | ||
| /releases) into | ||
| a directory accessible from the weewx machine. | ||
| a directory accessible from the weeWX machine. | ||
|
|
||
| wget -P $DOWNLOAD_ROOT https://github.com/gjr80/weewx-realtime_gauge-data | ||
| /releases/download/v0.2.0/rtgd-0.2.0.tar.gz | ||
| /releases/download/v0.2.1/rtgd-0.2.1.tar.gz | ||
|
|
||
| where $DOWNLOAD_ROOT is the path to the directory where the Realtime | ||
| gauge-data extension is to be downloaded. | ||
| where $DOWNLOAD_ROOT is the path to the directory where the Realtime | ||
| gauge-data extension is to be downloaded. | ||
|
|
||
| 2. Unpack the extension as follows: | ||
|
|
||
| tar xvfz rtgd-0.2.0.tar.gz | ||
| tar xvfz rtgd-0.2.1.tar.gz | ||
|
|
||
| 3. Copy files from within the resulting folder as follows: | ||
|
|
||
| cp rtgd/bin/user/rtgd.py $BIN_ROOT/user | ||
| replacing the symbolic name $BIN_ROOT with the nominal locations for your | ||
|
|
||
| replacing the symbolic name $BIN_ROOT with the nominal locations for your | ||
| installation. | ||
|
|
||
| 4. Edit weewx.conf: | ||
|
|
||
| vi weewx.conf | ||
|
|
||
| 5. In weewx.conf, modify the [Engine] [[Services]] section by adding the | ||
| 5. In weewx.conf, modify the [Engine] [[Services]] section by adding the | ||
| RealtimeGaugeData service to the list of process services to be run: | ||
|
|
||
| [Engine] | ||
| [[Services]] | ||
|
|
||
| report_services = weewx.engine.StdPrint, weewx.engine.StdReport, user.rtgd.RealtimeGaugeData | ||
|
|
||
| 6. Start weewx: | ||
| 6. Start weeWX: | ||
|
|
||
| sudo /etc/init.d/weewx start | ||
|
|
||
| or | ||
|
|
||
| sudo service weewx start | ||
|
|
||
| This will result in the gauge-data.txt file being generated upon receipt of | ||
| every nth loop packet. A default installation will result in the generated | ||
| gauge-data.txt file being placed in the $HTML_ROOT directory. The Realtime | ||
| gauge-data extension installation can be further customized (eg file locations | ||
| This will result in the gauge-data.txt file being generated upon receipt of | ||
| every nth loop packet. A default installation will result in the generated | ||
| gauge-data.txt file being placed in the $HTML_ROOT directory. The Realtime | ||
| gauge-data extension installation can be further customized (eg file locations | ||
| etc) by referring to the Realtime gauge-data extension wiki. |