Skip to content

kovrom/circle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Circle

This is a quick weekend project, so expect spaghetti code :)

The main idea was to find parts that would be easy to put together and would look good on your desk/shelf. All you need is the round display and Raspberry Pi. Alternatively you can just use hdmi and usb cables and connect the display to your existing computer/node.

Desk Example Bookshelf Example

Short video demo: https://www.youtube.com/watch?v=7DtQNCBLffI

Features

  • Full-screen: Full-screen display with navigation controls buttons or swipes
  • Web Content Display: Show any website or web application with matching background color
  • Auto-rotation: Automatically cycle through multiple URLs
  • Screensaver Mode: Built-in screensaver functionality
  • Settings Management: Easy configuration through JSON file or Settings Menu
  • Cross-platform: Works on Windows, macOS, and Linux
  • Weather: Includes lunar phase tracking, sunrise/sunset, UV Index, outside temperature. Weather data provided by open-meteo.com
  • This Day in Bitcoin History: Highlights interesting and significant events that occurred on this day in Bitcoin's past. A clickable icon appears if there's a historical event for the current date. The database currently includes around 105 entries - feel free to contribute more and submit a pull request! :)

Requirements

  • Node.js
  • npm

Hardware to make the same build

  • Waveshare 5 inch HDMI Round Touch Display
  • Raspberry Pi 5 4GB and Power Supply
  • Armor Lite V5 Cooler (not mandatory but recommended)
  • 60-Degree Angle Acrylic Plate Display Stand , 4.5 Inch

Installation

  1. Clone or download this repository
  2. Install dependencies:
    npm install

Alternatively you can download prebuilt AppImage for Raspberry Pi Arm64 or Linux x64 in Releases and run it.

On the first run tap the gear icon to adjust settings, connect to wifi, setup autostart.

Configuration

The app uses a config.json file for configuration. On first run, it will copy the default config to your user data directory where you can modify it. Or you can simply use Settings button.

Settings Image

For sunrise/sunset and UV Index you will need to provide long/lat for your location. You can easily look it up here: https://www.latlong.net/

Screensaver

'Use "The Quotable Satoshi" screensaver' option will display quotes compiled by Satoshi Nakamoto Institute. Quotes are loaded from the device and the screensaver will work without the Internet.

Some websites where you can find urls for the Screensaver:

Running the Application

Development Mode

npm run dev

Production Mode

npm start

Building the Application

Create distribution without publishing:

npm run dist

The built applications will be available in the dist/ directory.

To auto start it on system boot in linux

You can either use Autostart option in the Settings or do it manually:

Create a file in

~/.config/systemd/user/circle.service
[Unit]
Description=Circle
After=graphical.target
After=network.target
Wants=graphical.target

[Service]
Type=simple
ExecStart=/path/to/Circle-0.1.0.AppImage # Replace with the actual path
Restart=on-failure
RestartSec=10
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=default.target

Then enable and start the service

systemctl --user enable circle.service
systemctl --user start circle.service

Moon Phase Color Emoji

If you want some color and texture for the moon phase icon, make sure you have Noto Color Emoji font installed

sudo apt install fonts-noto-color-emoji

Keyboard bindings

  • Esc - Exit
  • Left/Right Arrow - previous/next screen
  • F11 - Toggle fullscreen on/off

I don't want/need round display, will it look ok on a regular monitor?

Yes, it will look just fine

Bookshelf Example

Supported Platforms

  • Windows: Generates NSIS installer
  • macOS: Creates .app bundle with .icns icon
  • Linux: Produces AppImage format

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors