python/eink-calendar
1
0
Fork 0
mirror of https://github.com/javierpena/eink-calendar.git synced 2025-08-10 21:52:01 +02:00
Code Issues Releases Activity

Minor README enhancements

Browse Source
This commit is contained in:
Javier Peña
2021-01-17 13:27:55 +01:00
parent cbfd4b4f96
commit 24ffae2a97
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -4,7 +4,8 @@
I needed to have an updatable calendar to keep track of my children's school agenda, I needed to have an updatable calendar to keep track of my children's school agenda,
as well as some post-school activities. So instead of using a whiteboard, I thought as well as some post-school activities. So instead of using a whiteboard, I thought
it would be a nice holiday project to do it with a Raspberry Pi 2 and an e-ink it would be a nice holiday project to do it with a Raspberry Pi 2 and an e-ink
screen. screen. I got some inspiration from [this similar project](https://github.com/zli117/EInk-Calendar)
and went for it, and here's the result:
<img src="https://raw.githubusercontent.com/javierpena/eink-calendar/main/img/calendar.jpg" width="600"> <img src="https://raw.githubusercontent.com/javierpena/eink-calendar/main/img/calendar.jpg" width="600">
@@ -25,8 +26,8 @@ to check the GPIO pins you need to connect them to.
The keypad will be connected to GPIO pins 29, 31, 33, 35 and 37. The keypad will be connected to GPIO pins 29, 31, 33, 35 and 37.
## Configuring ## Configuring
Once the basic setup and connections are done (TODO: add diagram for GPIO connections), Once the basic setup and connections are done, you will need to set up the `config.ini` file.
you will need to set up the `config.ini` file. This is the syntax: This is its syntax:
```ini ```ini
[DEFAULT] [DEFAULT]
@@ -45,7 +46,7 @@ password = password
``` ```
### Driver configuration ### Driver configuration
We have two different drivers to be used for both video output and keyboard input. We can use two different drivers to be used for both video output and keyboard input.
This allows us to hack and tests locally without using the e-ink screen all the time. This allows us to hack and tests locally without using the e-ink screen all the time.
- For video, we can use `pygame` for the [Pygame](https://github.com/pygame/pygame) - For video, we can use `pygame` for the [Pygame](https://github.com/pygame/pygame)
@@ -55,19 +56,19 @@ This allows us to hack and tests locally without using the e-ink screen all the
(5, 6, 13, 19 and 26 if you use the BCM2835 pin notation). (5, 6, 13, 19 and 26 if you use the BCM2835 pin notation).
### Open Weather Map API configuration ### Open Weather Map API configuration
You need to subscribe to the "Current Weather Data" API [link](https://openweathermap.org/api). You need to subscribe to the "Current Weather Data" [API](https://openweathermap.org/api).
Note that you need to sign in as a user (it's free). Once you get the API key and the Note that you need to sign in as a user (it's free). Once you get the API key and the
location id for your town, add them to the `owm_api_key` and `owm_location` keys in location id for your town, add them to the `owm_api_key` and `owm_location` keys in
the configuration file. the configuration file.
### Calendar configuration ### Calendar configuration
You can use any CalDav link; in my case, I set up 3 calendars in a [Synology](https://www.synology.com) You can use any CalDav link; in my case, I set up 3 calendars in a [Synology](https://www.synology.com)
DiskStation. The code should adapt to any number of calendars, but keep in mind the DiskStation using Synology Calenar. The code should adapt to any number of calendars,
resolution and font size ;). but keep in mind the resolution and font size.
The `urls` parameter is a comma-separated list of CalDav urls. Since each of those The `urls` parameter is a comma-separated list of CalDav URLs. Since each of those
calendars will correspond to an actual person, `names` will contain the list of calendars will correspond to an actual person, `names` will contain the list of
names for each url. Make sure you spefify the same number of urls and names. names for each url. Make sure you spefify the same number of URLs and names.
The `username` and `password` fields are self-explaining: include the user and The `username` and `password` fields are self-explaining: include the user and
password to access the calendars. password to access the calendars.
@@ -110,10 +111,10 @@ Bitstream Vera and Public Domain.
The `epd7in5bc.py` and `epdconfig.py` files are taken from the [Waveshare e-Paper repository](https://github.com/waveshare/e-Paper/), The `epd7in5bc.py` and `epdconfig.py` files are taken from the [Waveshare e-Paper repository](https://github.com/waveshare/e-Paper/),
including patches inspired by [this pull request](https://github.com/waveshare/e-Paper/pull/104) including patches inspired by [this pull request](https://github.com/waveshare/e-Paper/pull/104)
to improve performance. to improve screen refresh performance.
## Anything missing? ## Anything missing?
Feel free to contact me. This project was mainly set to scratch a personal itch, Feel free to contact me. This project was mainly created to scratch a personal itch,
but if it can be helpful to anyone, I'd be more than happy to improve it and but if it can be helpful to anyone, I'd be more than happy to improve it and
its documentation. its documentation.