Install Family Calendar
Family Calendar turns a Raspberry Pi and a touchscreen into your family's wall calendar, chore chart, and planner. Everything stays on the device in your home.
The Raspberry Pi version is in beta. It works, but it's new, and we'd love to hear what you find. Email support@wyvernbyte.com with questions, problems, or ideas.
What you need
- Raspberry Pi 4 or 5 with at least 2 GB of memory (4 GB recommended), its power supply, and a 16 GB or larger microSD card (a high-endurance card or USB SSD lasts longer).
- A screen, ideally a touchscreen (15" to 24" works well), connected by HDMI.
- Wi-Fi or a network cable, and a computer to prepare the SD card.
Family Calendar also runs on most 64-bit PCs with Debian or Ubuntu.
1. Prepare the Raspberry Pi
- Install Raspberry Pi Imager on your computer.
- Choose your Pi model, then Raspberry Pi OS (64-bit), the version with the desktop.
- In the settings (gear or "Edit settings"):
- set a username and password,
- enter your Wi-Fi name and password,
- set your time zone (this is the time zone Family Calendar will use),
- optionally turn on SSH.
- Write the card, put it in the Pi, connect the screen, and power it on. Wait for the desktop to appear.
2. Install Family Calendar
On the Pi, open Terminal (or connect with SSH) and run:
curl -fsSL https://wyvernbyte.com/familycalendar/releases/install.sh | sudo FAMILYHUB_CHANNEL=beta sh
It takes a few minutes. When it finishes it shows the address to use from phones, like http://raspberrypi.local. To give it a friendlier name, add FAMILYHUB_HOSTNAME:
curl -fsSL https://wyvernbyte.com/familycalendar/releases/install.sh | sudo FAMILYHUB_CHANNEL=beta FAMILYHUB_HOSTNAME=familycalendar sh
and it will be at http://familycalendar.local. Then restart:
sudo reboot
The Pi starts straight into Family Calendar, full screen.
Release notes for every version are on the downloads page.
3. Set it up
You can set everything up on the touchscreen, or more comfortably from a phone:
- On the screen, tap Connect a phone and scan the QR code (your phone must be on the same Wi-Fi).
- In Settings:
- People: add everyone, with a photo or emoji so younger kids can find themselves.
- Household: your ZIP code or town for the weather.
- Google Account → Connect Google account: do this on the wall screen itself; it finishes by itself there. Then choose which calendars to show, and who each belongs to, under Calendars.
- This device (on the wall screen): turn on This screen is the wall display for night sleep and a tidier screen.
- Grown-ups: optionally set a PIN so kids can't change settings.
- Add chores, Daily Tasks routines, practice instruments, meals, and rewards from their pages.
Android wall displays
The installed Android app offers Enter kiosk mode on first launch. Keep the device plugged in: kiosk mode keeps the screen awake while the app is visible, without changing Android's screen timeout. The choice is remembered on that Android device. Switching to another app allows normal screen sleep; Android's Home button or gesture still works.
To enter or exit later, open Settings → This device → Kiosk mode options in the installed app. This option is separate from This screen is the wall display, which controls the app's night sleep and menu. The screen saver still runs in kiosk mode, and night sleep darkens the app rather than turning off the physical display.
Trial and license
Family Calendar is free to try for 7 days. On a fresh install, press Start 7-day free trial when you are ready; installing or rebooting the Pi does not start the countdown. To buy a one-time license, email support@wyvernbyte.com and we'll send you a license key. Paste the key into the activation screen (or Settings → System → License during the trial). One license covers your whole home: the wall display and every connected phone and computer. Normal use and updates require a license after the trial, but your data stays on the hub and you can still create and download backups. There is no subscription or automatic charge.
Updates and backups
- When an update is available, Settings → System → Updates shows it. Choose Beta there to get new versions first, or Stable to wait for ones that have been through beta. Installing with
FAMILYHUB_CHANNEL=betachooses Beta for you. Tap Install. Family Calendar backs up first and goes back to the previous version if anything goes wrong. - Family Calendar backs itself up every night. In Settings → System → Backups you can download a copy, restore one, or also copy backups to a USB stick. Backups don't include your Google sign-ins' encryption key, so after restoring onto a different Pi, connect your Google accounts again under Settings → Google Account.
Troubleshooting
- Phone can't open the address: check the phone is on the home Wi-Fi (not mobile data). The address can change if your router restarts; use the
.localname instead (shown on the Connect a phone page), or reserve the number for the hub in your router settings. - Screen doesn't start Family Calendar after a restart: run the install command again; it repairs the setup.
- Forgot the grown-up PIN: run
sudo -u familyhub /opt/familyhub/familyhub -data /var/lib/familyhub -reset-pinon the Pi. - Google says the account can't connect (work or school account): the account's administrator may need to allow Family Calendar.