LCD: Update examples to reflect present, correct API

rwaldron · May 23, 2015 · 7342a11 · 7342a11
1 parent 4320f9a
commit 7342a11
Show file tree

Hide file tree

Showing 10 changed files with 122 additions and 148 deletions.
diff --git a/docs/lcd-enumeratechars.md b/docs/lcd-enumeratechars.md
@@ -12,56 +12,49 @@ node eg/lcd-enumeratechars.js
 <!--remove-end-->
 
 ```javascript
-var five = require("johnny-five"),
-  board, lcd;
-
-board = new five.Board();
+var five = require("johnny-five");
+var board = new five.Board();
 
 board.on("ready", function() {
 
-  lcd = new five.LCD({
+  var lcd = new five.LCD({
     // LCD pin name  RS  EN  DB4 DB5 DB6 DB7
     // Arduino pin # 7    8   9   10  11  12
     pins: [7, 8, 9, 10, 11, 12],
     rows: 4,
     cols: 20
   });
 
-  lcd.on("ready", function() {
-    var k, i, length, keys, eights;
-
-    k = 0;
-    i = 0;
+  var k = 0;
+  var i = 0;
+  var keys = Object.keys(five.LCD.Characters);
+  var length = keys.length;
+  var eights = [];
 
-    keys = Object.keys(five.LCD.Characters);
-    length = keys.length;
-    eights = [];
+  while (i < length) {
+    eights.push(keys.slice(i, i + 8));
+    i += 8;
+  }
 
-    while (i < length) {
-      eights.push(keys.slice(i, i + 8));
-      i += 8;
-    }
+  console.log("Wait 5 seconds...");
 
-    console.log("Wait 5 seconds...");
+  this.loop(2000, function() {
+    var charset = eights[k],
+      display = "";
 
-    board.loop(2000, function() {
-      var charset = eights[k],
-        display = "";
+    lcd.clear();
 
-      lcd.clear();
+    if (k < eights.length) {
 
-      if (k < eights.length) {
+      charset.forEach(function(char, index) {
+        lcd.useChar(char);
+        display += ":" + char + ":";
+      });
 
-        charset.forEach(function(char, index) {
-          lcd.useChar(char);
-          display += ":" + char + ":";
-        });
+      lcd.clear().cursor(0, 0).print(display);
 
-        lcd.clear().cursor(0, 0).print(display);
-
-        k++;
-      }
-    });
+      k++;
+    }
   });
 });
 

diff --git a/docs/lcd-i2c-runner.md b/docs/lcd-i2c-runner.md
@@ -30,7 +30,7 @@ board.on("ready", function() {
   lcd.useChar("runninga");
   lcd.useChar("runningb");
 
-  board.loop(300, function() {
+  this.loop(300, function() {
 
     lcd.clear().cursor(row, col).print(
       ":running" + ((frame ^= 1) === 0 ? "a" : "b") + ":"
@@ -45,7 +45,7 @@ board.on("ready", function() {
     }
   });
 
-  board.loop(1000, function() {
+  this.loop(1000, function() {
     lcd.bgColor(clist[Math.floor(Math.random() * clength)]);
   });
 });

diff --git a/docs/lcd-runner-20x4.md b/docs/lcd-runner-20x4.md
@@ -27,29 +27,26 @@ board.on("ready", function() {
     cols: 20
   });
 
-  lcd.on("ready", function() {
+  var frame = 1;
+  var col = 0;
+  var row = 0;
 
-    var frame = 1,
-      col = 0,
-      row = 0;
+  lcd.useChar("runninga");
+  lcd.useChar("runningb");
 
-    lcd.useChar("runninga");
-    lcd.useChar("runningb");
+  board.loop(300, function() {
 
-    board.loop(300, function() {
+    lcd.clear().cursor(row, col).print(
+      ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"
+    );
 
-      lcd.clear().cursor(row, col).print(
-        ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"
-      );
+    if (++col === lcd.cols) {
+      col = 0;
 
-      if (++col === lcd.cols) {
-        col = 0;
-
-        if (++row === lcd.rows) {
-          row = 0;
-        }
+      if (++row === lcd.rows) {
+        row = 0;
       }
-    });
+    }
   });
 });
 

diff --git a/docs/lcd-runner.md b/docs/lcd-runner.md
@@ -26,15 +26,15 @@ board.on("ready", function() {
     cols: 16
   });
 
-  var frame = 1,
-    col = 0,
-    row = 0;
+  var frame = 1;
+  var col = 0;
+  var row = 0;
 
   lcd.display();
   lcd.useChar("runninga");
   lcd.useChar("runningb");
 
-  board.loop(300, function() {
+  this.loop(300, function() {
 
     lcd.clear().cursor(row, col).print(
       ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"

diff --git a/docs/lcd.md b/docs/lcd.md
@@ -34,30 +34,27 @@ board.on("ready", function() {
     // dots: matrix dimensions, defaults to "5x8"
   });
 
-  lcd.on("ready", function() {
-    // Tell the LCD you will use the heart character
-    lcd.useChar("check");
-    lcd.useChar("heart");
-    lcd.useChar("duck");
-
-    // Line 1: Hi rmurphey & hgstrp!
-    lcd.clear().print("rmurphey, hgstrp");
-    lcd.cursor(1, 0);
-
-    // Line 2: I <3 johnny-five
-    // lcd.print("I").write(7).print(" johnny-five");
-    // can now be written as:
-    lcd.print("I :heart: johnny-five");
-
-    setTimeout(function() {
-      lcd.clear().cursor(0, 0).print("I :check::heart: 2 :duck: :)");
-    }, 3000);
+  // Tell the LCD you will use these characters:
+  lcd.useChar("check");
+  lcd.useChar("heart");
+  lcd.useChar("duck");
+
+  // Line 1: Hi rmurphey & hgstrp!
+  lcd.clear().print("rmurphey, hgstrp");
+  lcd.cursor(1, 0);
+
+  // Line 2: I <3 johnny-five
+  // lcd.print("I").write(7).print(" johnny-five");
+  // can now be written as:
+  lcd.print("I :heart: johnny-five");
+
+  this.wait(3000, function() {
+    lcd.clear().cursor(0, 0).print("I :check::heart: 2 :duck: :)");
   });
 
   this.repl.inject({
     lcd: lcd
   });
-
 });
 
 

diff --git a/eg/lcd-enumeratechars.js b/eg/lcd-enumeratechars.js
@@ -1,53 +1,46 @@
-var five = require("../lib/johnny-five"),
-  board, lcd;
-
-board = new five.Board();
+var five = require("../lib/johnny-five");
+var board = new five.Board();
 
 board.on("ready", function() {
 
-  lcd = new five.LCD({
+  var lcd = new five.LCD({
     // LCD pin name  RS  EN  DB4 DB5 DB6 DB7
     // Arduino pin # 7    8   9   10  11  12
     pins: [7, 8, 9, 10, 11, 12],
     rows: 4,
     cols: 20
   });
 
-  lcd.on("ready", function() {
-    var k, i, length, keys, eights;
-
-    k = 0;
-    i = 0;
+  var k = 0;
+  var i = 0;
+  var keys = Object.keys(five.LCD.Characters);
+  var length = keys.length;
+  var eights = [];
 
-    keys = Object.keys(five.LCD.Characters);
-    length = keys.length;
-    eights = [];
+  while (i < length) {
+    eights.push(keys.slice(i, i + 8));
+    i += 8;
+  }
 
-    while (i < length) {
-      eights.push(keys.slice(i, i + 8));
-      i += 8;
-    }
+  console.log("Wait 5 seconds...");
 
-    console.log("Wait 5 seconds...");
+  this.loop(2000, function() {
+    var charset = eights[k],
+      display = "";
 
-    board.loop(2000, function() {
-      var charset = eights[k],
-        display = "";
+    lcd.clear();
 
-      lcd.clear();
+    if (k < eights.length) {
 
-      if (k < eights.length) {
+      charset.forEach(function(char, index) {
+        lcd.useChar(char);
+        display += ":" + char + ":";
+      });
 
-        charset.forEach(function(char, index) {
-          lcd.useChar(char);
-          display += ":" + char + ":";
-        });
+      lcd.clear().cursor(0, 0).print(display);
 
-        lcd.clear().cursor(0, 0).print(display);
-
-        k++;
-      }
-    });
+      k++;
+    }
   });
 });
 

diff --git a/eg/lcd-i2c-runner.js b/eg/lcd-i2c-runner.js
@@ -16,7 +16,7 @@ board.on("ready", function() {
   lcd.useChar("runninga");
   lcd.useChar("runningb");
 
-  board.loop(300, function() {
+  this.loop(300, function() {
 
     lcd.clear().cursor(row, col).print(
       ":running" + ((frame ^= 1) === 0 ? "a" : "b") + ":"
@@ -31,7 +31,7 @@ board.on("ready", function() {
     }
   });
 
-  board.loop(1000, function() {
+  this.loop(1000, function() {
     lcd.bgColor(clist[Math.floor(Math.random() * clength)]);
   });
 });
diff --git a/eg/lcd-runner-20x4.js b/eg/lcd-runner-20x4.js
@@ -13,29 +13,26 @@ board.on("ready", function() {
     cols: 20
   });
 
-  lcd.on("ready", function() {
+  var frame = 1;
+  var col = 0;
+  var row = 0;
 
-    var frame = 1,
-      col = 0,
-      row = 0;
+  lcd.useChar("runninga");
+  lcd.useChar("runningb");
 
-    lcd.useChar("runninga");
-    lcd.useChar("runningb");
+  board.loop(300, function() {
 
-    board.loop(300, function() {
+    lcd.clear().cursor(row, col).print(
+      ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"
+    );
 
-      lcd.clear().cursor(row, col).print(
-        ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"
-      );
+    if (++col === lcd.cols) {
+      col = 0;
 
-      if (++col === lcd.cols) {
-        col = 0;
-
-        if (++row === lcd.rows) {
-          row = 0;
-        }
+      if (++row === lcd.rows) {
+        row = 0;
       }
-    });
+    }
   });
 });
 

diff --git a/eg/lcd-runner.js b/eg/lcd-runner.js
@@ -12,15 +12,15 @@ board.on("ready", function() {
     cols: 16
   });
 
-  var frame = 1,
-    col = 0,
-    row = 0;
+  var frame = 1;
+  var col = 0;
+  var row = 0;
 
   lcd.display();
   lcd.useChar("runninga");
   lcd.useChar("runningb");
 
-  board.loop(300, function() {
+  this.loop(300, function() {
 
     lcd.clear().cursor(row, col).print(
       ":running" + (++frame % 2 === 0 ? "a" : "b") + ":"