English
资源说明：A wooden cube; a colorful, programmable information visualizer for your desk.
Things that the Lightcube could display:
* A graph of the network utilization of your HAproxy load balancers
* The temperature outside your house
* The status of your code build after the most recent commit
* Up/down status of all of your servers, by server type
Lightcube Simulator
-------------------
A simulator is provided for the Arduino Ethernet for those that want to try out the application without
building the Lightcube.
Architecture
------------
Lightcube Protocol
------------------
The Lightcube receives its graphical instructions in the form of data frames sent over a TCP/IP network.
The data is sent in a binary format, encoded in UDP datagrams. The format is designed to be easily
parsed by low-end microcontrollers such as the Arduino and is intented to acommodate both the current
8x8 LED Lightcube, along with future Lightcubes with more LEDs.
The Lightcube packets are constructed as follows:
```
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ID | CMD | Protocol | Display | Display |
| | | Version | Width | Height |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Retain | |
| Delay | Reserved for future use |
| (n * 1/10 sec)| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Pixel(0,0) RED |Pixel(0,0) GRN |Pixel(0,0) BLU |Pixel(1,0) RED |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Pixel(1,0) GRN |Pixel(1,0) BLU |Pixel(2,0) RED |Pixel(2,0) GRN |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Pixel(6,7) BLU |Pixel(7,7) RED |Pixel(7,7) GRN |Pixel(7,7) BLU |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Note that one tick mark represents one bit position.
Frame ID [4 bits] Will always be 0x7
CMD [4 bits] Command to perform
0x0 - "PING" - Instructs the Lightcube to send an acknoledgement that it is
up and responding to commands
0x1 - "STORE" - Store this frame in a frame queue
0x2 - "PLAY" - Display all frames in queue (in order received)
0x3 - "DEMO" - Display a demo screen
0xE - "CLEAR" - Blank all pixels but leave frame queue intact.
Leave screen blank for time indicated by Retain Delay
0xF - "WIPE" - Wipe all frames from queue and blank all pixels
Protocol Version [8 bits] Currently 0x1
Display Width [8 bits] The number of horizontal LEDs in the display. User-defined.
Display Height [8 bits] The number of vertical LEDs in the display. User-defined.
Retain Delay (seconds) [8 bits] The time (in 1/10 second increments) to display the current frame before advancing
to the next one. If set to 00000000 (zero), the frame is displayed indefinitely.
Reserved Space [24 bits] Reserved for future use. Any value stored in these bits is currently ignored.
Pixel Data [24 bits/pixel] Pixel data for the frame, starting at (0,0) in the lower-left corner and moving
down the row. When each row is complete, the data continues at the left-most cell
of the row above, until the entire frame is complete.
A total of 24 bits of color data is sent for each pixel, 8 bits per color for the
red (RED),green (GRN), and blue (BLU) components. The 8-bit color value indicates
the brightness for that component. 0xFF is maximum brightness, 0x00 is full dark.
So, 0xFF 0xFF 0xFF would produce a bright white color in a pixel.
The total packet size is determined by the Display Width and Display Height values.
For an 8x8 Lightcube, this would be 200 bytes (8 bytes frame header,
192 bytes frame data).
```
To Do
-----
* Move drawing library logic to RESTful API (eve-based?)
* Create simple drawing libraries for various languages that call this RESTful API
Lightcube =========
|
A colorful, programmable information visualizer for your desk. The Lightcube is an 8x8 matrix of RGB LEDs enclosed in a small wooden cube and connected to the network via WiFi/Ethernet. Client applications can use a simple Python library to draw simple graphics primitives such as dots, lines, boxes, bar graphs, etc., and send them over the network to the Lightcube. The Lightcube runs a simple framebuffer that displays whatever data is sent to it. Using the easy-to-use library, the user can visualize any data that can be captured within their code. |
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
