nrinas/Cube4Fun
1
0
Fork 0
mirror of https://github.com/workinghard/Cube4Fun.git synced 2025-12-13 20:32:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

Browse Source
This commit is contained in:
workinghard
2015-05-10 00:10:04 -07:00
parent 736560ffdd 196f235748
commit 5e72ba67a0
1 changed files with 41 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -1,24 +1,53 @@
Cube4Fun
==================
# Cube4Fun
![alt text][logo]
Details coming soon ...
## Index
1. [Overview](#overview)
2. [Requirements](#requirements)
3. [Software](##software)
4. [Hardware](##hardware)
5. [Arduino controller](#arduino-with-network-shield-and-sd-card)
Arduino:
--------------------------------------
## Overview
* Create your own cool 3D animations and tag them
* Upload to your Cube4Fun
* Use the animation-tag from any internet service/device by sending GET/ request to activate animations
* Share your animations with everybody on [this site:](http://www.cube4fun.net)
...
![alt text][overview1]
## Requirements
### Software
* MacOS 10.10 or higher
* Cube4Fun Application (TODO: Link)
* Arduino Image (TODO: Link)
* Rainbowduino Image (TODO: Link)
### Hardware
* Arduino Uno or Arduino Mega
* Arduino network shield
* SD card
* Rainbowduino + RGB Cube [check this Wiki for more details](http://www.seeedstudio.com/wiki/Rainbow_Cube)
----
Rainbowduino:
--------------------------------------
## Arduino with network shield and sd-card
This piece is a main controller. The main objectives are:
* Handle the communcation like receiving animation requests and process
* Save and read animations from SD card
* Send data to the Rainbowduino
TODO: More details to come
...
## Rainbowduino:
This piece receives data over I2C protocol and displays it on the cube.
It has also some animations. In case there is no data to display it plays default animations.
There is not much logic on this side. For more details please check the [Rainbowduino Wiki](http://www.seeedstudio.com/wiki/Rainbow_Cube)
----
## Cube4Fun Application
The application is written in a new apple programming language [Swift](https://developer.apple.com/swift/). The communication part is using the [Poco Library](http://pocoproject.org/) which is written in C++. So it's easy to create a new application for any other device and don't care about TCP/IP communication.
[logo]: http://cube4fun.net/public/Cube6-128j.png "Logo"
[logo]: http://cube4fun.net/public/Cube6-128j.png "Logo"
[overview1]: http://cube4fun.net/public/Overview-Pic1.png "Overview"