README.md

WeeWX Pusher extension

This WeeWX extension allows you to send your realtime weather data to Pusher. You can use Pusher to send realtime weather condition updates to your web application or app. Find more information about Pusher on their website.

Requirements

This extension requires the Pusher library for Python. The installation guide of the Pusher library can be found on the official GitHub repository. If you're running WeeWX on Raspbian on a Raspberry Pi, you'll need to install development libraries in order to install the Pusher dependencies. More information about the required development libraries: Building cryptography on Linux.

Installation

This extension can be installed very easily using the WeeWX installer.

1. Go to the releases section and check the version number of the latest release. Download the latest release from the releases section, or use the following command. Change the version number to the version you want to download:

   wget https://github.com/raymondelooff/weewx-pusher/archive/refs/tags/v2.x.x.tar.gz

2. Install the extension with the WeeWX's extension installer:

   wee_extension --install=v1.x.x.tar.gz

3. Edit your weewx.conf file and add the Pusher configuration to the StdRestful section. The installer automatically adds the Pusher configuration to your configuration file. If you prefer to have some comments in the configuration, copy and paste the following configuration into your weewx.conf file:

   [StdRestful]
       ...
       [[Pusher]]
           # This section is for configuring pushes to Pusher.
           enable = true
   
           # Set to the credentials of your Pusher application.
           # If you are not using the main cluster of Pusher
           # you need to specify the cluster.
           app_id = replace_me
           key = replace_me
           secret = replace_me
           # cluster = eu
   
           # Channel and event settings. The weather data is pushed
           # to the given channel, with the specified event name.
           channel = replace_me
           event = replace_me
   
           # The post interval of the weather data that is being pushed to
           # Pusher, in seconds. The default post interval is 5 seconds.
           post_interval = 5
   
           # You can customize the observations that are being sent
           # to Pusher. For example you can add 'dayRain' to the
           # observations to push the daily rain summary.
           # observation_types = dateTime, barometer, inTemp, outTemp, inHumidity, outHumidity, windSpeed, windDir, rain, rainRate

4. Restart WeeWX. WeeWX should then push your weather data to Pusher. You should be able to see the weather data in the Pusher debug console.

   /etc/init.d/weewx restart

Issues

If you have any issues with the extension, please let me know via the GitHub issues section. Provide as much information as possible, including the system log, so I can try to reproduce the problem. Turn WeeWX debugging on before posting your system log. Make sure you don't post any private information like API keys or secret keys.

License & Copyright

Copyright (c) 2016 Raymon de Looff raydelooff@gmail.com. This extension is open-source software licensed under the GPLv3 license.