README.md
Piclodio3 - Raspberry Pi Clock Radio

This version of <![CDATA[]]>Piclodio3<![CDATA[]]> is hardware version of the alarm clock with a web radio player.
It should be installed on Raspberry Pi with:
- <![CDATA[]]>ReSpeaker 2-Mics Pi HAT<![CDATA[]]>
- Piclodio3 Hat

As in the Piclodio3 project, you can :
- add an url stream to complete the collection,
- schedule an alarm clock that can be periodic and
- add a local backup MP3 file that is used in case of losing internet connection or if the web radio is not anymore available to be sure you'll be awaken.



There is a lot of web radio online. In most of case, websites provide a pls or m3u file that contain the URL you need to give to Piclodio.
You can also get the URL from the console of your web browser. Look for the URL that consume the most brandwith in the network console.

Take a look to <![CDATA[]]>internet-radio.com<![CDATA[]]> for a large selection of web radio sorted by genre or <![CDATA[]]>fluxradios<![CDATA[]]>.

Installation

Installation procedures have been tested on a Raspberry Pi 3 Model B Rev 1.2 and on Raspbian GNU/Linux 11 (bullseye).

Seeed-voicecard (<![CDATA[]]>ReSpeaker 2-Mics Pi HAT<![CDATA[]]>)

Check this doc to install ReSpeaker 2-Mics Pi HAT on your RPI.

Docker

The project can be deployed via the provided docker compose file.
Check this doc to install Docker and docker-compose on your RPI.

git clone https://github.com/diallodavid/piclodio3.git
cd piclodio3
docker-compose up -d


Then access the UI via your web browser with the IP of your host (type ip a to get it). E.g: "<![CDATA[]]>http://192.168.0.22/<![CDATA[]]>"

Timezone

By default the time is showed in UTC. If you want to change the timezone, update the file piclodio3/back/piclodio3/settings.py
E.g:

TIME_ZONE = 'Europe/Paris'


Development env

The project is split in four parts:
- Backend based on Django Rest Framework
- Frontend based on Angular 13
- Device
- Piclodio3 Hat

Contribute

Fell free to open an issue to ask a new feature or raise a bug.

License

Copyright (c) 2022. All rights reserved.

Piclodio is covered by the MIT license, a permissive free software license that lets you do anything you want with the source code, as long as you provide back attribution and "don't hold you liable". For the full license text see the LICENSE.md file.