-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
36 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,37 @@ | ||
## Software to create a Raspberry Pi based wordclock | ||
|
||
### :vertical_traffic_light: Repo status | ||
|
||
<p align="left"> | ||
<img alt="Source code license" src="https://img.shields.io/github/license/bk1285/rpi_wordclock"/> | ||
<img alt="GitHub Issue Count" src="https://img.shields.io/github/issues/bk1285/rpi_wordclock"/> | ||
<img alt="GitHub (Pre-)Release Date" src="https://img.shields.io/github/release-date-pre/bk1285/rpi_wordclock"> | ||
<img alt="Build status documentation" src="https://readthedocs.org/projects/rpi-wordclock/badge/"/> | ||
</p> | ||
|
||
### ✔️ Features | ||
* [Various language layouts](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_layouts) | ||
* [Various plugins](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_plugins) to | ||
* display the current time | ||
* get information on current temperature, sunrise, sunset, IP-settings, ... | ||
* play tetris (credits to [@mrksngl](https://github.com/mrksngl)) | ||
* View a demo [here](https://youtu.be/wcLQDykRBbM?t=84) | ||
* RESTful, [swagger](https://swagger.io/specification/)-based API to access and control the wordclock functionality | ||
* [Documentation](http://rpi-wordclock.readthedocs.io/en/master/) on how to build the clock. | ||
* Remote control via webinterface (credits to [@FrankX0](https://github.com/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](https://www.home-assistant.io/) using [this repository](https://github.com/bk1285/rpi_wordclock_for_homeassistant/) | ||
* [Various language layouts](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_layouts) | ||
* [Various plugins](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_plugins) to | ||
* display the current time | ||
* get information on current temperature, sunrise, sunset, IP-settings, ... | ||
* play tetris (credits to [@mrksngl](https://github.com/mrksngl)) | ||
* View a demo [here](https://youtu.be/wcLQDykRBbM?t=84) | ||
* RESTful, [swagger](https://swagger.io/specification/)-based API to access and control the wordclock functionality | ||
* [Documentation](http://rpi-wordclock.readthedocs.io/en/master/) on how to build the clock. | ||
* Remote control via webinterface (credits to [@FrankX0](https://github.com/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](https://www.home-assistant.io/) using [this repository](https://github.com/bk1285/rpi_wordclock_for_homeassistant/) | ||
|
||
### ⏳ In progress | ||
* Integration of a brightness sensor | ||
* Integration of a brightness sensor | ||
|
||
### :books: Further reading | ||
* Exemplary builds are available at [pinterest](https://www.pinterest.de/berndkrolla/wordclock-gallery/) | ||
* [Roadmap](https://github.com/bk1285/rpi_wordclock/projects) | ||
* Exemplary builds are available at [pinterest](https://www.pinterest.de/berndkrolla/wordclock-gallery/) | ||
* [Roadmap](https://github.com/bk1285/rpi_wordclock/projects) | ||
|
||
### 👏 Support | ||
* :star2: Star this repo, if you like the project. | ||
* Request a new feature by [opening a issue](https://github.com/bk1285/rpi_wordclock/issues), describing your feature request. | ||
* Contribute your code: [Learn how to create your own plugin](https://rpi-wordclock.readthedocs.io/en/master/doc_further_reading.html#adding-a-new-plugin) | ||
* :star2: Star this repo, if you like the project. | ||
* Request a new feature by [opening a issue](https://github.com/bk1285/rpi_wordclock/issues), describing your feature request. | ||
* Contribute your code: [Learn how to create your own plugin](https://rpi-wordclock.readthedocs.io/en/master/doc_further_reading.html#adding-a-new-plugin) |
Oops, something went wrong.