https://github.com/mtrudel/desk_clock

A Nerves-powered, NTP-synchronized, SPI-connected, OLED-outputting desktop clock
https://github.com/mtrudel/desk_clock

clock elixir-lang nerves-project oled-display rotary-encoder spi ssd1322

Last synced: about 1 month ago
JSON representation

A Nerves-powered, NTP-synchronized, SPI-connected, OLED-outputting desktop clock

• Host: GitHub
• URL: https://github.com/mtrudel/desk_clock
• Owner: mtrudel
• License: mit
• Created: 2019-09-06T02:54:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-13T14:58:10.000Z (over 3 years ago)
• Last Synced: 2025-04-09T18:13:50.418Z (about 1 month ago)
• Topics: clock, elixir-lang, nerves-project, oled-display, rotary-encoder, spi, ssd1322
• Language: Elixir
• Homepage:
• Size: 14.6 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Desk Clock

A Nerves-powered, NTP-synchronized, SPI-connected, OLED-outputting desktop clock, running on a Raspberry Pi.

It was built as a demo for a [talk

given](https://github.com/mtrudel/talks/tree/master/2020-07-Toronto-Elixir-Night-Nerves.pdf) at the July 2020 Toronto Elixir Meetup, but is also

suitable for actual use.

Time is synchronized via NTP and display updates are adjusted to optimize the timeliness of the displayed time. In

typical operation, the displayed time should be no more than ~5ms out of sync with the device's NTP dervied time.

It looks like this:

![desk_clock](https://user-images.githubusercontent.com/79646/89941198-af68d480-dbe8-11ea-9055-fb3ec7321884.png)

## Building Hardware

Desk Clock runs on a Raspberry Pi and uses the following peripherals:

* An SSD1322 display configured and connected as suggested in the [SSD1322 library](https://github.com/mtrudel/ssd1322)

* A PEC11-style rotary encoder connected as per the

  [docs](https://github.com/mtrudel/desk_clock/blob/master/lib/desk_clock/rotary_encoder.ex#L11). See [here](https://github.com/mtrudel/rotary_breakout) for an easy to use breakout board suitable to purpose.

## Building the Application

Desk Clock is a standard nerves application, so it's best to consult their [excellent

docs](https://hexdocs.pm/nerves/getting-started.html) for the most up-to-date guide.

## Setting up Networking

Desk Clock uses VintageNet to configure networking. In the common case where you want to set up wifi, you'll want 

to ssh into the device and run a `VintageNet.configure` command as described in their

[README](https://github.com/nerves-networking/vintage_net_wifi). Settings made in such a way will be persistent.

## User Interface

The rotary encoder attached to Desk Clock performs the following tasks:

* When rotated, it cycles the top time display through the available timezones  

* When rotated while depressed, it cycles the bottom time display through the available timezones  

* When tapped, it toggles the display on and off