Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nogweii/status-clock

School Project: A real-life version of the Weasley's family clock
https://github.com/nogweii/status-clock

Last synced: about 1 month ago
JSON representation

School Project: A real-life version of the Weasley's family clock

Host: GitHub
URL: https://github.com/nogweii/status-clock
Owner: nogweii
License: agpl-3.0
Created: 2013-08-19T20:09:09.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2013-08-19T20:38:44.000Z (over 11 years ago)
Last Synced: 2024-10-15T22:44:47.112Z (3 months ago)
Language: Ruby
Size: 250 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.AGPL

Awesome Lists containing this project

README

# Status Clock

This is the Status Clock, a school project to recreate the Weasley's family
clock from Harry Potter.

[![Demonstration of the project](https://img.youtube.com/vi/YRWMdjvVUF4/hqdefault.jpg)](https://youtu.be/YRWMdjvVUF4)
[A Youtube video demonstrating the project](https://youtu.be/YRWMdjvVUF4)

## Design

There are 3 major components:

- Raspberry Pi, requesting updates from the website and driving the Arduino.
- Arduino UNO, controlling the servos and LCD screens
- Website, containing all state data and configuration for a clock. Connects to
Google+ to dynamically update a person's status based on their public
check-ins. (*NB: During development, we originally targeted Google Latitude,
which was sunsetted. We began migration to using Google+, but did not have
enough time before final report.*)

### Raspberry Pi

This is also known as the "host computer" in the documentation. It's purpose is
to act as the network bridge to the Arduino. It runs a recurring task (every 15
seconds) to request the JSON output of a clock face from the website, and
communicates any changes to the Arduino over serial.

Code: **TBD**.

### Arduino UNO

Serial driver for the servos and LCDs. Takes a command from serial and either
updates the text on an LCD or moves a hand (to point at an LCD) via the servos.

Code: **TBD**.

### Website

A Rails 4 application. A user logs into it with their Google account, and
associates themselves with a clock. (Either by creating a new clock or adding
themselves to an existing one.) The clock is exported as a JSON representation
at `/clock/:id.json`, which the Raspberry Pi will grab and feed to the Arduino.

## License

Specific components of this project are licensed.

The Raspberry Pi and Arduino code is released under the MIT license. See
[LICENSE.MIT](LICENSE.MIT) for the full text of the license.

The Rails application is released under the AGPLv3. See
[LICENSE.APGL](LICENSE.APGL) for the full text of the license.