mini-led-cube/README.md

61 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2014-10-16 11:09:34 +02:00
# mini LED CUBE
2014-08-11 00:06:07 +02:00
2014-10-16 11:09:34 +02:00
A 3x3x3 LED cube, originally based on [Paul Wilhelms project][2] with USB and a
lot of new features. An AVR (attiny2313) with [V-USB][3] (software
USB stack) control a matrix of 3x3x3 LEDs which forms a 3D cube of LEDs. Every
2014-08-11 00:06:07 +02:00
LED in this cube can be controlled independently over a simple
2014-10-16 11:09:34 +02:00
protocol. Various tools (commandline-tool, 3D OpenGL editor) can be used to
create animation sequences or simply use the cube as an [XFD][4] device.
2014-08-11 00:06:07 +02:00
2014-08-11 00:25:47 +02:00
![pcb](/doc/readme_cover.png?raw=true)
2014-06-22 22:28:43 +02:00
2014-08-11 00:06:07 +02:00
## Building
2014-08-12 23:38:13 +02:00
The project consists of two parts: The LED cube and the controller PCB. Both parts can
2014-10-16 11:11:04 +02:00
be build completely separate but need to work together.
2014-08-11 00:06:07 +02:00
2014-10-16 11:13:51 +02:00
* The Cube is a little bit tricky to solder. To see which wire need to be bend
2014-08-11 00:06:07 +02:00
and solder in which direction, use the [3D STL model][12] for reference. To
see more detail, install [OpenSCAD][13] and load the [threedvis.scad][14] file.
2014-10-16 11:13:51 +02:00
* For the PCB, there is a [detailed instruction plan][11] available. The
2014-08-11 00:06:07 +02:00
instructions include soldering the parts, testing, flashing the firmware and
2014-10-16 11:13:51 +02:00
setting the fuse bits. (Be careful, this file is for the through-hole version
of the PCB)
2014-08-11 00:06:07 +02:00
## Tools
* The [client lib][5] is a simple interface for other software
implementations. Have a look at the [demo.c][6] file how to include the lib
into your own project.
* A commandline client [clcc][9] can be used to control the cube interactively
over the commandline. Various commands can be send to the cube, see
[the sourcecode][10] for explanation.
* The [3D OpenGL Editor][7] is using the client lib mentioned above. The editor
shows a 3D representation of the LED cube and can be moved with the cursor
2014-08-12 23:38:13 +02:00
keys. All virtual LEDs can be clicked with the mouse to toggle it on or off.
2014-08-11 00:06:07 +02:00
2014-08-12 23:38:13 +02:00
* To use the cube as a XFD (show number of mails in INBOX, finished tickets today,
incoming phone call, number of missed chat messages in an IRC channel, ...)
2014-08-11 00:06:07 +02:00
you can use the [frame2cube.pl][8] script to send a complete frame to the cube.
[1]:http://www.cthn.de/projects/LEDCube
[2]:http://mosfetkiller.de/?s=miniledcube
[3]:http://www.obdev.at/products/vusb/index.html
[4]:https://www.google.de/search?q=extreme+feedback+device
2014-10-15 21:39:06 +02:00
[5]:https://github.com/okoyono/mini-led-cube/tree/master/client
[6]:https://github.com/okoyono/mini-led-cube/blob/master/client/demo.c
[7]:https://github.com/okoyono/mini-led-cube/tree/master/editor
[8]:https://github.com/okoyono/mini-led-cube/blob/master/tools/frame2cube.pl
[9]:https://github.com/okoyono/mini-led-cube/blob/master/client/clcc.c
[10]:https://github.com/okoyono/mini-led-cube/blob/master/client/clcc.c#L34-L44
[11]:https://github.com/okoyono/mini-led-cube/blob/master/doc/aufbauanleitung.txt
[12]:https://github.com/okoyono/mini-led-cube/blob/master/doc/threedvis/threedvis.stl
2014-08-11 00:06:07 +02:00
[13]:http://www.openscad.org/
2014-10-15 21:39:06 +02:00
[14]:https://github.com/okoyono/mini-led-cube/blob/master/doc/threedvis/threedvis.scad