rpi_wordclock

Software to create a Raspberry Pi based wordclock

:vertical_traffic_light: Repo status

✔️ Features

• Various language layouts
• Various plugins to
  • display the current time
  • get information on current temperature, sunrise, sunset, IP-settings, …
  • play tetris (credits to @mrksngl)
  • View a demo here
• RESTful, swagger-based API to access and control the wordclock functionality
• Documentation on how to build the clock.
• Remote control via webinterface (credits to @FrankX0)
  • Control the wordclock with a browser within your local network
  • Linking the webinterface to your smartphones homescreen provides an app-like usage of the interface
  • Hardware buttons are not mandatory anymore.
• Integration to your instance of home-assistant using this repository
• Support for a brightness sensor (TSL2561)

:books: Further reading

• Exemplary builds are available at pinterest
• Roadmap

👏 Support

• Star this repo, if you like the project.
• Request a new feature by opening a issue, describing your feature request.
• Contribute your code: Learn how to create your own plugin

Python3

When using the Python 3 branch the follwing changes have to be made during installation. Tested on latest Raspian Buster (11.08.2021)

System Packages

sudo apt-get update
sudo apt-get install python3-pip python3-scipy scons git swig fonts-freefont-ttf libopenjp2-7

Python Packages

Instead of flask-restplus which is no longer maintained we are using now flask-restx. For the great rpi-ws281x Library there is no need to compile it yourself. It is just installed via pip now.

sudo pip3 install pytz astral feedparser pillow svgwrite freetype-py netifaces monotonic flask-restx rpi-ws281x coloredlogs

Repository

For using pyhton3-develop branch:

git clone https://github.com/bk1285/rpi_wordclock.git
cd rpi_wordclock/
git checkout --track origin/develop

Brightness sensor

For using brightness sensor (tsl2561) i2c must be ativated via raspi-config

sudo raspi-config
use the arrow keys to select 'Interfacing Options' and 'I2C' to tell the RasPi to enable the I2C interface. Then select 'Finish' and reboot the RasPi

Install adafruit-circuitpython-tsl2561 lib

sudo pip3 install adafruit-circuitpython-tsl2561

Set use_brightness_sensor config value to true and its address

# Set the brightness of the display (between 1 and 255)
brightness = 200
use_brightness_sensor = True
sensor_address = 0x39

Cronjob

For the cronjob you have to use python3 instead of python command

@reboot sudo python3 /home/pi/rpi_wordclock/wordclock.py

This site is open source. Improve this page.