Skip to content

Commit 301570f

Browse files
committed
Updated readme, moved most information to the wiki
1 parent e54b0ab commit 301570f

File tree

1 file changed

+12
-199
lines changed

1 file changed

+12
-199
lines changed

README.md

Lines changed: 12 additions & 199 deletions
Original file line numberDiff line numberDiff line change
@@ -23,192 +23,13 @@ Animations
2323
Settings
2424
[![Settings](http://img.youtube.com/vi/sOlAI7qmnBM/0.jpg)](http://www.youtube.com/watch?v=sOlAI7qmnBM)
2525

26-
Clock
27-
-----
28-
29-
Clock display and settings require an optional real-time clock (RTC) module. If one is not present, clock display and settings will not be available.
30-
Aurora uses the [DS1307RTC Library], which supports DS1307, DS1337 and DS3231 real time clock chips that use the I2C interface.
31-
Here are some compatible boards that are available:
32-
* [ChronoDot] Ultra-precise Real Time Clock
33-
* [DS1307] Real Time Clock
34-
35-
Micro SD Card
36-
-------------
37-
38-
Aurora makes use of an optional MicroSD card to display animated GIF images and to store user preferences and settings. Aurora will still work fine if
39-
no MicroSD card is inserted into the slot, but obviously no animated GIFs will be displayed, and changes to any settings will not be retained if the display
40-
loses power.
41-
42-
Animated GIF Image support
43-
--------------------------
44-
45-
Animated GIFs to be displayed must meet the folowing requirements:
46-
47-
* 32x32 size (32 pixels wide and 32 pixels high)
48-
* Indexed color mode
49-
* Placed in a 'gifs' directory in the root of the MicroSD card.
50-
51-
Aurora Setting Storage
52-
----------------------
53-
54-
Aurora stores settings in a directory named Aurora in the root of the MicroSD card. Aurora will create the directory automatically if it does not exist.
55-
56-
Installation
57-
------------
58-
59-
Aurora includes and makes use of several optional files and example animated GIF images which can be downloaded, extracted, and copied into the
60-
root of your MicroSD card:
61-
62-
1. Download the [Aurora MicroSD Card] zip file.
63-
2. Extract all contents of the zip file.
64-
3. Insert a MicroSD card into your computer, using a card reader.
65-
4. Copy the extracted contents of the zip file to your MicroSD card.
66-
* The card should now contain at least two directories: aurora and gifs.
67-
5. Prepare the MicroSD card for safe removal from your computer by first ejecting, unmounting, etc.
68-
* Removing the MicroSD card from your computer without first preparing it can cause the corruption and/or loss of data.
69-
6. Remove the MicroSD card from your computer.
70-
7. Insert the MicroSD card into the MicroSD card slot on the SmartMatrix board. It's located underneath the Micro USB port.
71-
Make sure the label on the MicroSD card is facing up, and it's inserted with the narrower end with the contacts first.
72-
73-
Connect the display to power:
74-
75-
1. Insert the power cable into the power port on the back of the display.
76-
2. Plug the power cable in to a wall power outlet (the display does not draw power from the Micro USB cable).
77-
78-
The display will likey not light up or do anything, as the Aurora software did not come pre-installed on your display.
79-
Next we'll install the Aurora software. First connect your display to your computer:
80-
81-
1. Insert the smaller end of a Micro USB cable into the Micro USB port on the back of the display.
82-
2. Insert the larger end of the Micro USB cable into one of your computer's USB ports.
83-
84-
Next download the required software:
85-
86-
1. Download the [Aurora.hex] file.
87-
2. Download the [Teensy Loader Application] for your computer's operating system.
88-
3. Follow the instructions for running and using the Teensy Loader Application on the 'Using The Teensy Loader' page for your computer's operating system.
89-
90-
Finally, install the Aurora software on your display:
91-
92-
1. Click the 'Open HEX File' button on the toolbar or click the File menu, then click 'Open HEX File'.
93-
2. Find and open the Aurora.hex file you downloaded.
94-
2. Click the Program button on the toolbar or click the Operation menu, then click Program.
95-
96-
The Aurora software should now be running on your display.
97-
98-
Remote Control
99-
--------------
100-
101-
Aurora can use:
102-
103-
[![SparkFun Infrared Remote Control](https://cdn.sparkfun.com/r/92-92/assets/parts/7/9/8/6/11759-01.jpg)](https://www.sparkfun.com/products/11759)
104-
105-
[SparkFun Infrared Remote Control]
106-
107-
[![Adafruit Infrared Remote Control](http://www.adafruit.com/images/230x173/389-00.jpg)](http://www.adafruit.com/products/389)
108-
109-
[Adafruit Infrared Remote Control]
110-
111-
SparkFun remote button functions:
112-
113-
* ![Power Symbol] Power
114-
* Press to turn on the display.
115-
* Press to toggle through brightness presets:
116-
* Off, 1%, 25%, 50%, 75%, 100%
117-
* Hold to turn off the display without changing the brightness.
118-
* Unless unplugged, the display is never completely powered off. It enters a low-power state, where it uses
119-
just enough power to poll the infrared sensor.
120-
* **^** Up
121-
* Move to the previous menu item.
122-
* **v** Down
123-
* Move to the next menu item.
124-
* **<** Left
125-
* Switch to the previous content (Pattern or Animation).
126-
* **>** Right
127-
* Switch to the next content (Pattern or Animation).
128-
* **O** Select
129-
* Selects the currently displayed content, hiding the main menu.
130-
* Returns to the main menu from displayed content.
131-
* **A**
132-
* Press the A button to toggle through playback modes:
133-
* Pause
134-
* Stay on the current content until the left or right button is pressed.
135-
* Autoplay
136-
* Automatically switches to the next content after a short time.
137-
* Random
138-
* Automatically switches to a random content after a short time.
139-
* **B**
140-
* Switch to the next color palette in Pattern mode.
141-
* Most, but not all Patterns support multiple color palettes such as Rainbow, Fire, Ice, Forest, etc.
142-
* **C**
143-
* Shows and hides the clock display when content is selected and the main menu is hidden.
144-
145-
Aurora Menu
146-
-----------
147-
148-
* Patterns
149-
* Dynamic, procedurally generated color displays.
150-
* Animations
151-
* Animated GIF image files read from the MicroSD card.
152-
* Settings
153-
* Brightness
154-
* Adjust the overall display brightness using the up and down buttons.
155-
* 1%, 25%, 50%, 75%, 100%
156-
* Press select button to return to the settings menu.
157-
* BG Brightness (background brightness)
158-
* Adjust the brightness of content shown in the background, under the menu and clock text, using the up and down buttons.
159-
* 1%, 25%, 50%, 75%, 100%
160-
* Press select button to return to the settings menu.
161-
* Move Clock
162-
* Adjust the vertical location of the clock using the up and down buttons.
163-
* Press select button to return to the settings menu.
164-
* Clock Color
165-
* Change the color of the clock text using the up, down, left, and right buttons.
166-
* Press select button to return to the settings menu.
167-
* 12/24 Hour Clock
168-
* Press the up and down buttons to change from 12 to 24 hour clock display.
169-
* Press select button to return to the settings menu.
170-
* Set Time
171-
* Press up and down buttons to adjust the hour.
172-
* Press right button to change to minute adjustment.
173-
* Press up and down buttons to adjust the minute.
174-
* Press select button to return to the settings menu.
175-
* Exit Settings
176-
* Press select button to return to the main menu.
177-
178-
Power Utilization
179-
-----------------
180-
181-
Aurora requires a 5 volt power supply, capable of providing 4 amps of peak power. When in idle, low power mode, Aurora uses only 1.2 watts.
182-
When turned on, power use depends on the brightness and pattern displayed. When on 100% brightness with every LED on full white, it can draw as much as 20 watts, which is still only half of what a standard (40W) incandescent light bulb uses.
183-
184-
All power use was measured using a [Kill A Watt].
185-
186-
Compiling Aurora
26+
More Information
18727
----------------
18828

189-
For those familiar with Arduino development, Aurora can easily be compiled from source.
190-
191-
Required software:
192-
193-
* [Teensyduino Software]
194-
* [Arduino Software] *(currently requires version 1.0.6)*
195-
196-
Source code and libraries:
197-
198-
* [Aurora Source Code]
199-
* [SmartMatrix Library]
200-
* [FastLED Library]
201-
* [IR Remote Library]
202-
* [SD Library]
203-
* [Time Library]
204-
* [DS1307RTC Library]
205-
206-
After downloading and installing all of the software, download all of the required libraries and extract/place them in your
207-
Arduino libraries directory on your computer. For more information, see [Installing Additional Arduino Libraries]
208-
209-
Next, connect your Aurora display. See installation instructions above for more information.
210-
211-
Finally, open Aurora.ino in the Arduino IDE and click the Upload button.
29+
* [Aurora Project] on GitHub for source code
30+
* [Aurora Wiki] on GitHub for documentation
31+
* [Aurora Issue Tracker] on GitHub for reporting issues
32+
* [SmartMatrix User Community] on Google+ to ask questions, share your work, ideas, etc
21233

21334
Troubleshooting
21435
---------------
@@ -236,29 +57,25 @@ Many thanks to all of the fantastic hardware and open source software libraries
23657
* [Arduino Software]
23758

23859
A huge thank you to all of the projects and open source software that are used in and inspired Aurora!
60+
23961
* [Light Appliance] by Craig Lindley
24062
* [Funky Clouds] by [Stefan Petrick]
24163
* [Rainbow Smoke] by [Jozsef Fejes]
24264
* [LED Effects] by Robert Atkins
24365
* [The Nature of Code] by [Daniel Shiffman]
24466

24567
Thanks to these fine game companies for allowing us to use and distribute their pixel art to showcase Aurora!
246-
![Tiny Barbarian](https://github.com/pixelmatix/aurora/blob/master/sd/gifs/TinyFlex.gif) [Tiny Barbarian] by [StarQuail Games]
247-
![Chasm](https://github.com/pixelmatix/aurora/blob/master/sd/gifs/ChasmDaltynCrouch.gif) [Chasm] by [Discord Games]
24868

69+
![Tiny Barbarian](https://raw.githubusercontent.com/pixelmatix/aurora/master/sd/gifs/TinyFlex.gif) [Tiny Barbarian] by [StarQuail Games]
70+
![Chasm](https://raw.githubusercontent.com/pixelmatix/aurora/master/sd/gifs/ChasmDaltynCrouch.gif) [Chasm] by [Discord Games]
71+
72+
[SmartMatrix User Community]:https://plus.google.com/u/0/communities/105354523738870531811
73+
[Aurora Project]:https://github.com/pixelmatix/aurora
74+
[Aurora Wiki]:https://github.com/pixelmatix/aurora/wiki
24975
[Aurora Source Code]:https://github.com/pixelmatix/aurora/archive/master.zip
25076
[Aurora Issue Tracker]:https://github.com/pixelmatix/aurora/issues
251-
[SparkFun Infrared Remote Control]:https://www.sparkfun.com/products/11759
252-
[SparkFun Infrared Remote Image]:https://cdn.sparkfun.com/r/92-92/assets/parts/7/9/8/6/11759-01.jpg
253-
[Adafruit Infrared Remote Control]:http://www.adafruit.com/products/389
254-
[Adafruit Infrared Remote Image]:http://www.adafruit.com/images/230x173/389-00.jpg
255-
[ChronoDot]:http://www.adafruit.com/products/255
256-
[DS1307]:https://www.adafruit.com/product/264
257-
[Aurora.hex]:https://github.com/pixelmatix/aurora/raw/master/bin/Aurora.hex
258-
[Aurora MicroSD Card]:https://github.com/pixelmatix/aurora/blob/master/sd/sd.zip?raw=true
25977
[Teensyduino Software]:https://www.pjrc.com/teensy/td_download.html
26078
[Installing Additional Arduino Libraries]:http://arduino.cc/en/Guide/Libraries
261-
[Teensy Loader Application]:https://www.pjrc.com/teensy/loader.html
26279
[Arduino Software]:http://www.arduino.cc/en/Main/Software
26380
[SmartMatrix Library]:https://github.com/pixelmatix/SmartMatrix
26481
[SmartMatrix SD Shield]:http://docs.pixelmatix.com/SmartMatrix/shield-sd.html
@@ -269,14 +86,10 @@ Thanks to these fine game companies for allowing us to use and distribute their
26986
[Time Library]:https://github.com/PaulStoffregen/Time
27087
[DS1307RTC Library]:https://www.pjrc.com/teensy/td_libs_DS1307RTC.html
27188
[Teensy v3.1]:https://www.pjrc.com/teensy/index.html
272-
[Power Symbol]:http://upload.wikimedia.org/wikipedia/commons/thumb/b/b2/IEC5009_Standby_Symbol.svg/16px-IEC5009_Standby_Symbol.svg.png
273-
[Kill A Watt]:http://www.p3international.com/products/p4400.html
274-
27589
[Light Appliance]:https://github.com/CraigLindley/LightAppliance
27690
[Funky Clouds]:https://gist.github.com/anonymous/2eb826070e108b09b8fd
27791
[Stefan Petrick]:http://www.stefan-petrick.de/wordpress_beta
27892
[Rainbow Smoke]:http://rainbowsmoke.hu
279-
[Rainbow Smoke Codegolf]:http://codegolf.stackexchange.com/a/22326
28093
[Jozsef Fejes]:http://joco.name/
28194
[LED Effects]:https://bitbucket.org/ratkins/ledeffects
28295
[The Nature of Code]:http://natureofcode.com/

0 commit comments

Comments
 (0)