PVOutput uploader extension

A WeeWX RESTful service to upload solar PV power generation data to PVOutput.

Description

The PVOutput uploader extension allows uploading of solar PV power generation data to PVOutput using the PVOutput API.

The PVOutput uploader extension consists of:

a RESTful service for posting data to PVOutput, and
a utility for bulk uploading of solar PV generation data to PVOutput should Internet access be lost for some period of time.

Pre-Requisites

The PVOutput uploader extension requires:

WeeWX v3.7.0 or greater
a PVOutput account with system ID and API access key
a WeeWX system using a WeeWX archive to record solar PV power generation data using the Aurora driver custom schema

Installation

The PVOutput uploader extension can be installed manually or automatically using the wee_extension utility. The preferred method of installation is through the use of wee_extension.

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 PVOutput uploader extension.
$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 for further information.

Installation using the wee_extension utility

Download the latest PVOutput uploader extension from the PVOutput uploader extension releases page into a directory accessible from the WeeWX machine.
```
$ wget -P $DOWNLOAD_ROOT https://github.com/gjr80/weewx-pvoutput/releases/download/v0.5.1/pvoutput-0.5.1.tar.gz
```
where $DOWNLOAD_ROOT is the path to the directory where the PVOutput uploader extension is to be downloaded.

Stop WeeWX:

$ sudo /etc/init.d/weewx stop

$ sudo service weewx stop

Install the PVOutput uploader extension downloaded at step 1 using the wee_extension utility:

$ wee_extension --install=$DOWNLOAD_ROOT/pvoutput-0.5.1.tar.gz

This will result in output similar to the following:

Request to install '/var/tmp/pvoutput-0.5.1.tar.gz'
Extracting from tar archive /var/tmp/pvoutput-0.5.1.tar.gz
Saving installer file to /home/weewx/bin/user/installer/Aurora
Saved configuration dictionary. Backup copy at /home/weewx/weewx.conf.20180201124410
Finished installing extension '/var/tmp/pvoutput-0.5.1.tar.gz'

Edit weewx.conf:
```
$ vi weewx.conf
```
In weewx.conf under [StdRESTful] [[PVOutput]] check to ensure the enable configuration option is set to True and the system_id and api_key configuration options are set for the PVOutput system and API key to be used:
```
[[PVOutput]]
    # This section is for configuring posts to PVOutput.

    # If you wish to do this, set the option 'enable' to true,
    # and specify a station and password.
    enable = true
    system_id = ENTER_PVOUTPUT_SYSTEM_ID_HERE
    api_key = ENTER_PVOUTPUT_API_KEY_HERE
```
Note: The enable configuration option is set to False by default during the PVOutput uploader extension installation.
Save weewx.conf.

Start WeeWX:

$ sudo /etc/init.d/weewx start

$ sudo service weewx start

The WeeWX log should be monitored to verify data is being posted to PVOutput at the end of each archive period. Setting debug = 1 or debug = 2 in weewx.conf will provide additional information in the log. Using debug = 2 will generate significant amounts of log output and should only be used for verification of operation or testing.

Manual installation

Download the latest PVOutput uploader extension from the PVOutput uploader extension releases page into a directory accessible from the WeeWX machine.
```
$ wget -P $DOWNLOAD_ROOT https://github.com/gjr80/weewx-pvoutput/releases/download/v0.5.1/pvoutput-0.5.1.tar.gz
```
where $DOWNLOAD_ROOT is the path to the directory where the PVOutput uploader extension is to be downloaded.

Stop WeeWX:

$ sudo /etc/init.d/weewx stop

$ sudo service weewx stop

Unpack the extension as follows:
```
$ tar xvfz pvoutput-0.5.1.tar.gz
```
Copy files from within the resulting directory as follows:
```
$ cp pvoutput/bin/user/*.py $BIN_ROOT/user
```
replacing the symbolic name $BIN_ROOT with the nominal locations for your installation.
Edit weewx.conf:
```
$ vi weewx.conf
```

In weewx.conf under [StdRESTful] add a [[PVOutput]] stanza as follows ensuring the system_id and api_key configuration options are set for the PVOutput system and API key to be used:

[[PVOutput]]
    # This section is for configuring posts to PVOutput.

    # If you wish to do this, set the option 'enable' to true,
    # and specify a station and password.
    enable = true
    system_id = ENTER_PVOUTPUT_SYSTEM_ID_HERE
    api_key = ENTER_PVOUTPUT_API_KEY_HERE

In weewx.conf under [Services] add user.pvoutput.StdPVOutput to the list of restful_services:
```
[Services]
    ....
    restful_services = user.pvoutput.StdPVOutput
    ....
```
Save weewx.conf.

Start WeeWX:

$ sudo /etc/init.d/weewx start

$ sudo service weewx start

The WeeWX log should be monitored to verify data is being posted to PVOutput at the end of each archive period. Setting debug = 1 or debug = 2 in weewx.conf will provide additional information in the log. Using debug = 2 will generate significant amounts of log output and should only be used for verification of operation or testing.

Support

General support issues may be raised in the Google Groups weewx-user forum. Specific bugs in the PVOutput uploaderr extension code should be the subject of a new issue raised via the PVOutput uploader extension issues page.

Licensing

The PVOutput uploader extension is licensed under the GNU Public License v3.

gjr80 / weewx-pvoutput