Permalink
Browse files

comments

  • Loading branch information...
1 parent 2af13b4 commit 5664e999533e89432247530a439e7ac5daa008a6 @mlm79 committed Mar 9, 2012
Showing with 32 additions and 31 deletions.
  1. +8 −1 main.rb
  2. BIN public/imgs/default.png
  3. +24 −30 public/js/functions.js
View
@@ -1,8 +1,15 @@
####
#
-# A Simple RemoteControl web app for an XBee network
+# A Simple Remote Control web app for an XBee network
# @author - Margaret McKenna
#
+# Functionality to log in with Digi creditials, configure an XBee
+# for the Garage Door Remote, and open/close the garage door
+#
+# Templating is via haml
+#
+#
+#
####
module Main
View
Deleted file not rendered
View
@@ -1,19 +1,19 @@
/**
- * A Simple RemoteControl web app for an XBee network
+ * A Simple Remote Control web app for an XBee network
* This script requires jQuery.
*
* @author Margaret McKenna - mlmckenna.com
+ *
*/
+
/*
- *
- * updateXBeeList function
- * @params - none
- * @return - none
- *
- * After selecting a gateway id, update the associated list of XBees
- * Gateway JSON object is stored in data attr of #data
- *
+ updateXBeeList function
+ @params - none
+ @return - none
+
+ After selecting a gateway id, update the associated list of XBees
+ Gateway JSON object is stored in data attr of #data
*/
function updateXBeeList(){
@@ -29,13 +29,11 @@ function updateXBeeList(){
}
/*
- *
- * configureXBee function
- * @params - none
- * @return - none
- *
- * Ajax request to configure XBee for garage door opener
- *
+ configureXBee function
+ @params - none
+ @return - none
+
+ Ajax request to configure XBee for garage door opener
*/
function configureXBee() {
@@ -66,13 +64,11 @@ function configureXBee() {
}
/*
- *
- * toggleSensor function
- * @params - state : string, "open" or "closed"
- * @return - message from server, or bad credentials page
- *
- * Ajax request to check state of sensor; if state != state of sensor, toggle sensor
- *
+ toggleSensor function
+ @params - state : string, "open" or "closed"
+ @return - message from server, or bad credentials page
+
+ Ajax request to check state of sensor; if state != state of sensor, toggle sensor
*/
function toggleSensor(state){
@@ -100,13 +96,11 @@ function toggleSensor(state){
}
/*
- *
- * getParam function
- * @params - name : string, key in url parameters
- * @return - value of key; if key does not exist, return "/"
- *
- * Used to pass values on LogIn page and Garage App page
- *
+ getParam function
+ @params - name : string, key in url parameters
+ @return - value of key; if key does not exist, return "/"
+
+ Used to pass values on LogIn page and Garage App page
*/
function getParam(name){

0 comments on commit 5664e99

Please sign in to comment.