A software for rpi zero w to display live-weather info and sync events from any online calendar to a beautiful E-Paper Display, or to just show a slideshow of simplified images.
Find a file
2019-03-17 20:32:32 +01:00
.github/ISSUE_TEMPLATE Update issue templates 2018-10-03 14:53:28 +02:00
Calendar Added broad multiline alignment support 2019-03-17 20:32:32 +01:00
developers Delete test 2019-02-03 17:32:25 +01:00
Gallery Changed images 2019-03-17 10:49:59 +01:00
.gitignore First steps. Deleted alot, added even more. 2019-02-28 15:17:43 +01:00
Changelog.md Update Changelog.md 2019-03-17 11:22:07 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-09-09 12:05:09 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md 2018-10-02 16:53:48 +02:00
Installer-with-debug.sh Added missing library feedparser 2019-03-17 16:33:33 +01:00
LICENSE Initial commit 2018-08-26 23:56:49 +02:00
New-version-planning.md Update New-version-planning.md 2019-03-17 11:15:51 +01:00
prototype.sh Update prototype.sh 2019-02-06 02:12:25 +01:00
README.md Update README.md 2019-03-17 11:13:14 +01:00
wpa_supplicant.conf Rename wpa_applicant.conf to wpa_supplicant.conf 2018-08-28 03:02:53 +02:00

E-Paper Calendar

This is a software written in python3 that allows you to transform an E-Paper display (like the kindle) into an information display. It fetches live data from Openweathermap (a weather info provider), rss-feeds and your Online Calendar (Google/Yahoo Calendar/...) and displays them on a large, beautiful and ultra-low power E-Paper display. It's ideal for staying organised and keeping track of important details without having to check them up online.

This software fully supports the 3-Colour and 2-Colour version of the 7.5" E-Paper display from waveshare/gooddisplay and works with Raspberry Pi 2, 3 and 0 (Zero, Zero W, Zero WH).

To get started, follow the instructions below.

News:

  • Specified README for this fork, added new design and many options (Mid March 2019)
  • Version 1.5 released with a new layout, displayed events and many back-end improvements (Early February 2019)
  • Added Support for the 2-Colour E-Paper Display as well! (Late September 2018)
  • Added Support for Raspbian Stretch lite. (Late September 2018)

Left: Day-List Panel
Right: Month-Overview Panel

Main features

  • Display the date and a full monthly calendar or a list of today and the next days
  • Optionally get RSS-Feed fetched and shown
  • Syncronise events from any online calendar (like google, yahoo etc.)
  • Get live weather data (including temperature, humidity, etc.) using openweathermap api

Hardware required

  • 7.5" 3-Colour E-Paper Display (Black, White, Red/Yellow) with driver hat from waveshare or
  • 7.5" 2-Colour E-Paper Display (Black, White) with driver hat from waveshare
  • Raspberry Pi Zero WH (with headers) (no soldering iron required)
  • Or: Raspberry Pi Zero W. In this case, you'll need to solder 2x20 pin GPIO headers yourself
  • MicroSD card (min. 4GB)
  • MicroUSB cable (for power)
  • Something to be used as a case (e.g. a (RIBBA) picture frame or a 3D-printed case)

Setup

Getting the Raspberry Pi Zero W ready

  1. After flashing Raspbian Stretch (Lite or Desktop), set up Wifi on the Raspberry Pi Zero W by copying the file wpa_supplicant.conf (from above) to the /boot directory and adding your Wifi details in that file.
  2. Create a simple text document named ssh in the boot directory to enable ssh.
  3. Expand the filesystem in the Terminal with sudo raspi-config --expand-rootfs
  4. Enable SPI by entering sudo sed -i s/#dtparam=spi=on/dtparam=spi=on/ /boot/config.txt in the Terminal
  5. Set the correct timezone with sudo dpkg-reconfigure tzdata, selecting the correct continent and then the capital of your country.
  6. Reboot to apply changes
  7. Optional: If you want to disable the on-board leds of the Raspberry, follow these instructions: Disable on-board-led

Installing required packages for python 3.5

Execute the following command in the Terminal to install all required packages. This will work on both, Raspbian Stretch with Desktop and Raspbian Stretch lite.

bash -c "$(curl -sL https://raw.githubusercontent.com/mgfcf/E-Paper-Calendar/master/Installer-with-debug.sh)"

If the Installer should fail for any reason, kindly open an issue and paste the error. Thanks.

This is how the installer will run:

Adding details to the programm

Once the packages are installed, navigate to the home directory, open 'E-Paper-Master' and open the file 'settings.py' inside the Calendar folder. Adjust the values as needed. You can use the table below as a reference.

Parameter Description
ical_urls Your iCalendar URL/s. To add more than one URL, seperate each with a comma.
highlighted_ical_urls Your iCalendar URL/s that should be higlighted in comparison the ical_urls. To add more than one URL, seperate each with a comma.
rss_feeds All the sources for your rss-feed. To add more than one URL, seperate each with a comma.
api_key Your personal openweathermap API-key which you can generate and find in your Account info.
owm_paid_subscription If you have a paid owm subscription you can set it to true and in some panels receive forecast information.
location Location refers to the closest weather station from your place. It isn't necessarily the place you live in. To find this location, type your city name in the search box on openweathermap. The output should be in the following format: City Name, Country ISO-Code. Not sure what your ISO code is? Check here: (find iso-code).
week_starts_on When does the work start on your Region? Possible options are "Monday" or "Sunday".
display_colours This should normally be set by the installer when you choose the type of your display. Options include "bw" if you're using the black and white E-Paper or "bwr" when you're using the black-white-red or black-white-yellow E-Paper.
language Choosing the language allows changing the language of the month and week-icons. Possible options are "en" for english and "de" for german.
units Selecting units allows switching units from km/h (kilometer per hour) and °C (degree Celcius) to mph (miles per hour) and °F (degree Fahrenheit). Possible options are "metric" or "imperial".
hours Which time format do you prefer? This will change the sunrise and sunset times from 24-hours format to 12-hours format. Possible options are "24" for 24-hours and "12" for 12-hours.
update_interval The update delay between two updates in minutes. By default there is always an update on a full hour.

iCalendar

It is a bit tricky to set up the iCalendar so it works correctly without throwing any errors. If you encounter errors related to your iCalendar, please open up an issue and paste the error message there.

A more detailed section about the iCalendar will be added to the wiki soon, but for now, here are some suggestions to prevent error messages:

  1. Ensure your iCalendar URL is fine. If you receive an error showing error 404, it means the URL is wrong.
  2. If your existing iCalendar doesn't work at all, export the Calendar as a file, then create a new Calendar and import the file from before.
  3. If you receive errors related to 'alarm' or 'trigger', please make sure your iCalendar does not use reminders. The problem is that some actions are not supported by the Raspberry and cause errors. For example, the Rapsberry can't send a mail, make a noise or display a message as soon as an event starts.

Updating

If you want to update to the latest version, run the Installer from above again and select the 'update' option.

Before updating, the Installer checks if the settings file (/home/pi/E-Paper-Master/Calendar/settings.py) exists. This is done to test if a previous version was installed correctly. If the settings file exists, it is copied to the home directory and renamed as 'settings.py.old'. The old software folder 'E-Paper-Master' is renamed to 'E-Paper-Master-old'. Lastly, the latest version of the software is copied to the Raspberry as 'E-Paper-Master'.

After updating, copy the contents from your old settings file to the new one. There are usally more options in the new settings.py file so a 'template' is prepared with each update. This template can be found in /home/pi/E-Paper-Master/Calendar/settings.py.sample.