xxx

.classpath

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
 	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="lib" path="libs/RXTXcomm.jar"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright Tomas Uktveris (c) 2015 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,46 @@
-DotMatrixJava
-=============
+8x8x8 Led Cube control program
+---------
 
-Java PC animation generator for 3D8S 8x8x8 Led charlieplexed
+PC control program for generic 8x8x8 3D LED Cube found on eBay
+(e.g. 3D LightSquared 8x8x8 LED Cube DIY kit, ideasoft, etc.)
+
+![Program view](/help/program_view.png)
+
+* Written in Java (requires Java RE, download here: http://java.com)
+* Supports direct animation playback through Serial/UART interface (rxtx library)
+* Various GUI usability enhancements
+
+##### Firmware
+This program can control any packet format compatible LED cube (see below).
+Example firmware of a compatible LED cube with an STC12C5A60S2 MCU can be found here: [Source Code](https://github.com/tomazas/ledcube8x8x8)
+
+##### Using the program
+* Run run_x32.bat for 32-bit Windows
+* Run run_x64.bat for 64-bit Windows
+
+Check this YouTube video for example: https://youtu.be/UplJi7pdV_Y
+[![Using program](http://img.youtube.com/vi/UplJi7pdV_Y/0.jpg)](https://youtu.be/UplJi7pdV_Y)
+
+##### LED Cube control packet format
+
+8x8x8 LED Cubes that support below packet format can be controlled with the program via Serial console or other MCU such as an Atmega/Arduino.
+Example UART/Serial packet (in hex):
+```
+F2
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+00 00 00 00 00 00 00 FF
+```
+
+* F2 - denotes packet header (aka. batch update)
+* next 64 bytes - (8x8x8 bits) of LED light states
+  * one byte - controls a LED row (8 LEDs)
+  * can be any value in range: 00-FF (i.e. 00 - all 8 LEDs in row are off, FF - all 8 LEDs are on)
+  * a single line (e.g. 00 00 00 00 00 00 00 FF) denotes a 64 LED layer
+
+`Implementation note:` to save energy/current consumption only a single layer (64 LEDs) in a LED cube is ON at one time. This is done for all layers and so fast (using a hardware timer), that the human eye does not recognize this. This hack allows to view the cube (all layers) as fully lit. 

arduino-controller/SDAnimation.ino

@@ -1,18 +1,15 @@
 #include "SD.h"
 #include "string.h"
 
-Sd2Card card;
-SdVolume volume;
-const int chipSelect = 4;
 File root;
 
 void setup()
 {
-	Serial.begin(57600);
+	Serial.begin(9600);
 
-	pinMode(10, OUTPUT); // change this to 53 on a mega
+	pinMode(10, OUTPUT); // SS pin must be output, change this to 53 on a mega
 
-	bool sd_ok = SD.begin(9);
+	bool sd_ok = SD.begin(9); // chip select pin
 
 	if (!sd_ok)
 	{
@@ -25,22 +22,13 @@ void setup()
 
 void sendAnimation(byte *data)
 {
-	Serial.write(0xf3);
-	Serial.write(data[1]);
-
-	Serial.write(0xf4);
-	Serial.write(data[2]);
-
-	Serial.write(0xf5);
-	Serial.write(data[3]);
-
-	Serial.write(0xf2);
+	Serial.write(0xf2); // batch update supported
 	for (byte i = 8; i < 72; i++)
 	{
 		Serial.write(data[i]);
 	}
 
-	delay(makeWord(data[6], data[7]));	
+	delay(20);	
 }
 
 void readAnimation(File & file)
@@ -61,7 +49,7 @@ void loop(void)
 		char *p = file.name();
 		char *p_dot = strchr(p, '.');
 
-		if (p_dot != NULL && strcmp(p_dot, ".DAT") == 0)
+		if (p_dot != NULL && strcmp(p_dot, ".dat") == 0)
 		{
 			readAnimation(file);
 		}

run_x32.bat

@@ -0,0 +1 @@
+java -Djava.library.path=./runtime/x32 -jar dotmatrixjava.jar

run_x64.bat

@@ -0,0 +1 @@
+java -Djava.library.path=./runtime/x64 -jar dotmatrixjava.jar

src/aguegu/dotmatrix/DMRecordFrame.java

@@ -85,6 +85,15 @@ public byte[] getData() {
 
 		return data;
 	}
+
+	public byte[] getSimpleData() {
+		byte[] data = new byte[65];
+
+		data[0] = (byte) 0xf2;
+		System.arraycopy(dm.getCache(), 0, data, 1, DotMatrix.CACHE_LENGTH);
+
+		return data;
+	}
 
 	public String getCacheString() {
 		return DotMatrix.cacheString(getData());