From e557a732807eb6f3c29630ce882c644936df1e02 Mon Sep 17 00:00:00 2001
From: Reena Lee <nobody@android.com>
Date: Wed, 20 May 2009 08:04:39 -0700
Subject: [PATCH] AI 149055: Add initial file for LED content including doxygen
 code from lights.h

Automated import of CL 149055
---
 pdk/Pdk.mk               |  3 ++-
 pdk/docs/guide/lights.jd | 44 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100755 pdk/docs/guide/lights.jd

diff --git a/pdk/Pdk.mk b/pdk/Pdk.mk
index c824037eb..526838410 100644
--- a/pdk/Pdk.mk
+++ b/pdk/Pdk.mk
@@ -80,7 +80,8 @@ pdk_headers := \
     $(pdk_legacy_hardware_dir)/gps.h \
     $(pdk_legacy_hardware_dir)/wifi.h \
     $(pdk_camera_dir)/CameraHardwareInterface.h \
-    $(pdk_hardware_dir)/sensors.h
+    $(pdk_hardware_dir)/sensors.h \
+    $(pdk_hardware_dir)/lights.h
 
 # Create a rule to copy the list of PDK headers to be doxyginated.
 # copy-one-header defines the actual rule.
diff --git a/pdk/docs/guide/lights.jd b/pdk/docs/guide/lights.jd
new file mode 100755
index 000000000..5437e631a
--- /dev/null
+++ b/pdk/docs/guide/lights.jd
@@ -0,0 +1,44 @@
+page.title=Lights
+pdk.version=1.0
+@jd:body
+ 
+<a name="toc"/> 
+<div style="padding:10px"> 
+<a href="#androidLightsIntroduction">Introduction</a><br/> 
+<a href="#androidLightsBuildingDriver">Building a Lights Library</a><br/> 
+<a href="#androidLightsInterface">Interface</a><br/></div></font></div> 
+ 
+<a name="androidLightsIntroduction"></a><h2>Introduction</h2> 
+ 
+<p>Android defines a user space C abstraction interface for LED hardware. The interface header is defined in 
+<code>hardware/libhardware/include/hardware/lights.h</code>.
+In order to integrate LEDs with Android you need to build a shared library that implements this interface. 
+
+The types of logical lights currently supported by Android include:
+<ul>
+<li>Backlight</li>
+<li>Keyboard</li>
+<li>Buttons</li>
+<li>Battery</li>
+<li>Notifications</li>
+<li>Attention</li>
+</ul>
+</p> 
+ 
+<a name="androidLightsBuildingDriver"></a><h2>Building a Lights Library</h2>
+<p> To implement a Lights driver, create a shared library that implements the interface defined in <code>lights.h</code>. You must name your shared library 
+<code>liblights.so</code> so that it will get loaded from <code>/system/lib</code> at runtime. 
+</p
+
+ 
+<a name="androidLightsInterface"></a><h2>Interface</h2> 
+ 
+ 
+ 
+<p><span class="lh2"><a name="androidDoxygenNote"></a></span> 
+ 
+<p class="note"><strong>Note</strong>: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, <a href="lights.html">click here</a>.</p> 
+ 
+ 
+<iframe onLoad="resizeDoxFrameHeight();" src="lights_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" 
+frameborder="0" style="width:100%;"></iframe>