DigitalRooster

Internet radio, podcast player and alarmclock. Intended to run on embedded
Linux with a small touch display.

This repository is part of a larger project. For more information head to
www.digitalrooster.dev

Microsoft Windows and Desktop GNU/Linux systems are supported for development.

Some Screenshots

License

Copyright (c) 2018 by Thomas Ruschival thomas@ruschival.de

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License v3.0 for more details.

SPDX-License-Identifier: GPL-3.0-or-later

Third party work used in DigitalRooster

The icons of DigitalRooster use the font “materialdesignicons-webfont.ttf”. \
“Materialdesignicons-webfont” copyright (c) 2014, Austin Andrews
is licensed under SIL Open Font License, Version 1.1.

The name “Material Design Icons” is a
reserved font name, copyright (c) 2014 Google
licensed under Apache License Version 2.0

Parts of QML in DigitalRooster are inspired by Qmlbridgeformaterialfonts
by Kevin Carlso licenced under the SIL Open Font License, Version 1.1.

DigitalRooster uses include/wpa_ctrl/wpa_ctrl.h and wpa_ctrl/wpa_ctrl.c
to interface with wpa_supplicant\
Copyright (c) 2002-2018, Jouni Malinen j@w1.fi and contributors
licensed under BSD license.

wpa_ctrl.c was modified with input from
Holger Schurig

The fallback alarm sound “TempleBell” copyright (c) by Mike Koenig downloaded
from www.soundbible.com
“Temple Bell” is licensed under Creative Commons Attribution.

All license texts can be found in the directory licenses.

Build configuration

On how to build the desktop version see documentation/build.md
For information on how to build the embedded version see the project
buildroot_digitalrooster
and www.digitalrooster.dev

Runtime configuration

DigitalRooster as a range of options to configure the program behavior,
default paths etc. For detailed description see
documentation/configuration.md

User interface

I Hope the user interface is pretty intuitive - but I am no expert on UI/UX.
I tried to minimize menus and use icons whereever possible. To get an overview
where you can find interactive widgets have a look documentation/gui.md

REST interface

Apart from the configuration file DigitalRooster implements a REST server to
conveniently configure alarms, podcasts and Internet radio stations.
If DigitalRoosterGui was configured with -DREST_API=On you will find the
REST endpoint at http://<your_ip>:6666/api/1.0/
The REST API is described in REST/openapi.yml
For more details refer to documentation/rest.md