From e2b3c2732b602d15eaf47dd8330109d3bbfae000 Mon Sep 17 00:00:00 2001
From: Jesse Young <youngj@envaya.org>
Date: Mon, 10 Oct 2011 16:21:30 -0700
Subject: [PATCH] document log parameter, device_status action for 2.0.1

---
 .phrozn/entries/history/index.twig   | 13 +++++++
 .phrozn/entries/serverapi/index.twig | 52 +++++++++++++++++++++++++++-
 .phrozn/entries/test/index.twig      |  3 +-
 history/index.html                   | 13 +++++++
 serverapi/index.html                 | 52 +++++++++++++++++++++++++++-
 test/index.html                      |  3 +-
 6 files changed, 130 insertions(+), 6 deletions(-)

diff --git a/.phrozn/entries/history/index.twig b/.phrozn/entries/history/index.twig
index 067d4d6..ebe37c5 100755
--- a/.phrozn/entries/history/index.twig
+++ b/.phrozn/entries/history/index.twig
@@ -2,6 +2,19 @@ id: history
 title: History
 ---
 
+Version 2.0.1 (2011/10/10)
+
+<ul>
+    <li>
+        Send EnvayaSMS log messages to server via <code>log</code> parameter
+    </li>
+    <li>
+        Notify server of changes in the Android device's power/battery state
+        via <code>device_status</code> action.
+    </li>     
+</ul>
+
+
 Version 2.0 (2011/10/01)
 
 <ul>
diff --git a/.phrozn/entries/serverapi/index.twig b/.phrozn/entries/serverapi/index.twig
index e69ade2..ad45c54 100755
--- a/.phrozn/entries/serverapi/index.twig
+++ b/.phrozn/entries/serverapi/index.twig
@@ -201,7 +201,18 @@ The following parameters are sent in all POST requests from EnvayaSMS:
         are running EnvayaSMS.
     </dd>
         
-    <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "test"</dt>
+    <dt>"log" ::= &lt;text&gt;</dt>
+    <dd>
+        Log messages printed to the EnvayaSMS console since the last successful HTTP request.
+        <br /><br />
+        You may wish to append this data to a log file to allow administrators 
+        to see error details without needing physical access to the phone.
+        <br /><br />
+        EnvayaSMS does not guarantee that the server receives log messages in order. Occasionally,
+        the server may receive the same log message multiple times.
+    </dd>
+        
+    <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
     <dd>
         The request action determines the purpose of the HTTP request:
         
@@ -221,10 +232,16 @@ The following parameters are sent in all POST requests from EnvayaSMS:
             Update the server on the status of sending an outgoing message
         </dd>
         
+        <dt>"device_status":</dt>
+        <dd>
+            Notify the server of a change in the Android device's state.
+        </dd>                    
+        
         <dt>"test":</dt>
         <dd>
             Test the server connection.
         </dd>            
+                
         
         </dl>        
             
@@ -360,6 +377,39 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
     </dd>
 </dl>
 
+Additional parameters sent in POST requests with <code>action=device_status</code>:
+
+<dl>
+    <dt>"status" ::= "power_connected" | "power_disconnected" <br />
+        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | "battery_low" | "battery_okay"</dt>
+    <dd>
+         This field describes a condition that has changed on the Android device.
+         
+        <dl>
+        <dt>"power_connected":</dt>
+        <dd>
+            The phone is now connected to external power.
+        </dd>
+        
+        <dt>"power_disconnected":</dt>
+        <dd>
+            This phone is no longer connected to external power.
+        </dd>
+                      
+        <dt>"battery_low":</dt>
+        <dd>
+            The phone's battery level has dropped below 15%.
+        </dd>
+        
+        <dt>"battery_okay":</dt>
+        <dd>
+            The phone's battery level is now at least 20% (after dropping below 15%).
+        </dd>                    
+        </dl>
+    </dd>
+</dl>
+
+
 <h3>
 HTTP Response Format
 </h4>
diff --git a/.phrozn/entries/test/index.twig b/.phrozn/entries/test/index.twig
index 567f7d4..e800de3 100755
--- a/.phrozn/entries/test/index.twig
+++ b/.phrozn/entries/test/index.twig
@@ -23,8 +23,7 @@ The following steps explain how to set up EnvayaSMS on an Android Virtual Device
    <small>Note: Android Market does not work in the emulator.</small></li>
    <li>Install EnvayaSMS</li>
    <li>Configure EnvayaSMS with the settings of your development server. <br />
-   <small>Note: Do not enter <code>localhost</code> as the Server URL (since this would refer to the AVD itself). Instead, use your computer's IP address on the local network, as shown by the <code>ipconfig</code>
-   or <code>ifconfig</code> utilities.</small>
+   <small>Note: Use <code>10.0.2.2</code> as the host in the Server URL. Do not enter <code>localhost</code>, since this would refer to the AVD itself).</small>
    </li>
     <li>        
     To simulate incoming SMS on the emulator:
diff --git a/history/index.html b/history/index.html
index 27c3677..a133132 100755
--- a/history/index.html
+++ b/history/index.html
@@ -42,6 +42,19 @@
     <h2>History</h2>
   
     
+Version 2.0.1 (2011/10/10)
+
+<ul>
+    <li>
+        Send EnvayaSMS log messages to server via <code>log</code> parameter
+    </li>
+    <li>
+        Notify server of changes in the Android device's power/battery state
+        via <code>device_status</code> action.
+    </li>     
+</ul>
+
+
 Version 2.0 (2011/10/01)
 
 <ul>
diff --git a/serverapi/index.html b/serverapi/index.html
index 93e3480..4874e73 100755
--- a/serverapi/index.html
+++ b/serverapi/index.html
@@ -241,7 +241,18 @@ The following parameters are sent in all POST requests from EnvayaSMS:
         are running EnvayaSMS.
     </dd>
         
-    <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "test"</dt>
+    <dt>"log" ::= &lt;text&gt;</dt>
+    <dd>
+        Log messages printed to the EnvayaSMS console since the last successful HTTP request.
+        <br /><br />
+        You may wish to append this data to a log file to allow administrators 
+        to see error details without needing physical access to the phone.
+        <br /><br />
+        EnvayaSMS does not guarantee that the server receives log messages in order. Occasionally,
+        the server may receive the same log message multiple times.
+    </dd>
+        
+    <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
     <dd>
         The request action determines the purpose of the HTTP request:
         
@@ -261,10 +272,16 @@ The following parameters are sent in all POST requests from EnvayaSMS:
             Update the server on the status of sending an outgoing message
         </dd>
         
+        <dt>"device_status":</dt>
+        <dd>
+            Notify the server of a change in the Android device's state.
+        </dd>                    
+        
         <dt>"test":</dt>
         <dd>
             Test the server connection.
         </dd>            
+                
         
         </dl>        
             
@@ -400,6 +417,39 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
     </dd>
 </dl>
 
+Additional parameters sent in POST requests with <code>action=device_status</code>:
+
+<dl>
+    <dt>"status" ::= "power_connected" | "power_disconnected" <br />
+        &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | "battery_low" | "battery_okay"</dt>
+    <dd>
+         This field describes a condition that has changed on the Android device.
+         
+        <dl>
+        <dt>"power_connected":</dt>
+        <dd>
+            The phone is now connected to external power.
+        </dd>
+        
+        <dt>"power_disconnected":</dt>
+        <dd>
+            This phone is no longer connected to external power.
+        </dd>
+                      
+        <dt>"battery_low":</dt>
+        <dd>
+            The phone's battery level has dropped below 15%.
+        </dd>
+        
+        <dt>"battery_okay":</dt>
+        <dd>
+            The phone's battery level is now at least 20% (after dropping below 15%).
+        </dd>                    
+        </dl>
+    </dd>
+</dl>
+
+
 <h3>
 HTTP Response Format
 </h4>
diff --git a/test/index.html b/test/index.html
index 7f84e21..bd49b76 100755
--- a/test/index.html
+++ b/test/index.html
@@ -63,8 +63,7 @@ The following steps explain how to set up EnvayaSMS on an Android Virtual Device
    <small>Note: Android Market does not work in the emulator.</small></li>
    <li>Install EnvayaSMS</li>
    <li>Configure EnvayaSMS with the settings of your development server. <br />
-   <small>Note: Do not enter <code>localhost</code> as the Server URL (since this would refer to the AVD itself). Instead, use your computer's IP address on the local network, as shown by the <code>ipconfig</code>
-   or <code>ifconfig</code> utilities.</small>
+   <small>Note: Use <code>10.0.2.2</code> as the host in the Server URL. Do not enter <code>localhost</code>, since this would refer to the AVD itself).</small>
    </li>
     <li>        
     To simulate incoming SMS on the emulator: