Skip to content

seaniedan/weatherWHAT

Repository files navigation

weatherWHAT

Weather forecast display for the Pimeroni Inky wHAT, with global weather data powered by the UK's Met Office Weather DataHub. If you don't have an Inky wHAT, you can display the weather on your desktop background or screensaver, or just as text in your terminal.

display example

Get Started

Download the git repo (if using Docker, you don't need to type 'sudo'):

sudo apt-get update && sudo apt install git
git clone --depth=1 https://github.com/seaniedan/weatherWHAT.git

Prerequisites

If you are using Raspberry Pi OS lite, install pip3.

To separate the required Python libraries from others in your system, it's recommended to deploy a virtual environment, e.g. 'venv':

python3 -m venv venv --prompt="weatherWHAT"

To show images and use the location functions, install the rest of the prerequisites.

If you have one, install, connect and test your Inky wHAT.

Install

Register with Met Office Weather DataHub, enter your email adress and create a password. You also need to subscribe to their 'Site Specific forecast'. The service allows 360 free calls per day and you don't need to give any payment information.

You should receive a Client ID and Client Secret. Enter these values into the api.py file, by copying the example_api.py file:

cp example_api.py api.py
nano api.py #or use your favourite text editor

Deploy

If using 'venv', set your environment:

source venv/bin/activate

To show the weather on the command line:

./weatherWHAT.py

If you have installed the prerequisites to display an image:

./weatherWHAT.py -d

The numbers at the bpottom of the screen are hours: yellow means sunshine (high UV). Bars appearing above the numbers show the amount of rain at that hour.

If you have installed GeoPy, to see the weather in Paris:

./weatherWHAT.py -l 'paris, france' 

To display a map, use -m (or -z for the zoomed map):

./weatherWHAT.py -dz -l melbourne

To display a particular image or folder of images, use the -bg option. You'll also need -d to display the image onscreen, or -i to send to the InkyWHAT.

./weatherWHAT.py -bg icons/kids -d

Use the -h option for help!

You can use a Raspberry Pi connected to a Inky wHAT. If you don't have a suitable display, you can set this script up to, for example, change your desktop backdrop, or use the output images in your screensaver.

Use the -s option and specify a file to save to (.jpg or .png).

e.g. On Ubuntu Mate, to update your desktop background, you can use the instructions in this file:

crontab examples/mate_desktop_cron.txt

to save the image in your desktop background location.

Contribute

Please send a message or pull request if something isn't clear or doesn't work.

Want to help?

  • Write an installation script.
  • Share ideas, and folders of background images.
  • Rewrite it to work better on different resolution screens, color InkyWHAT etc.
  • Write additional API's to connect to other weather services, e.g. openweathermap.

Author

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details

Acknowledgments

  • Raspberry Pi for a great device
  • Pimeroni for their inspiring products
  • Everyone at Met Office Weather DataHub for fabulous support and weather data
  • Lee at 90 Degrees Picture Framing, 124 Fortess Rd, London NW5 2HP (+44 20 7267 4121) for the super frame
  • Olivia and Benet for cool drawings of various types of weather