Add Comment and Wire.begin()

- Add Wire.begin() to the setup() in the examples since it was removed from the .cpp file.
- Adding comments to clarify on when to use certain functions for SPI and I2C

Author: bboyho

examples/MicroOLED_Clock/MicroOLED_Clock.ino

@@ -1,21 +1,21 @@
 /****************************************************************
- * MicroOLED_Clock.ino
- * Analog Clock demo using SFE_MicroOLED Library
- * Jim Lindblom @ SparkFun Electronics
- * Original Creation Date: October 27, 2014
- * 
- * This sketch uses the MicroOLED library to draw a 3-D projected
- * cube, and rotate it along all three axes.
- * 
- * Development environment specifics:
- *  Arduino 1.0.5
- *  Arduino Pro 3.3V
- *  Micro OLED Breakout v1.0
- * 
- * This code is beerware; if you see me (or any other SparkFun employee) at the
- * local, and you've found our code helpful, please buy us a round!
- * 
- * Distributed as-is; no warranty is given.
+   MicroOLED_Clock.ino
+   Analog Clock demo using SFE_MicroOLED Library
+   Jim Lindblom @ SparkFun Electronics
+   Original Creation Date: October 27, 2014
+
+   This sketch uses the MicroOLED library to draw a 3-D projected
+   cube, and rotate it along all three axes.
+
+   Development environment specifics:
+    Arduino 1.0.5
+    Arduino Pro 3.3V
+    Micro OLED Breakout v1.0
+
+   This code is beerware; if you see me (or any other SparkFun employee) at the
+   local, and you've found our code helpful, please buy us a round!
+
+   Distributed as-is; no warranty is given.
  ***************************************************************/
 #include <Wire.h>  // Include Wire if you're using I2C
 #include <SPI.h>  // Include SPI if you're using SPI
@@ -27,13 +27,19 @@
 #define PIN_RESET 9  // Connect RST to pin 9 (SPI & I2C)
 #define PIN_DC    8  // Connect DC to pin 8 (SPI only)
 #define PIN_CS    10 // Connect CS to pin 10 (SPI only)
-#define DC_JUMPER 0  // DC jumper setting(I2C only)
+#define DC_JUMPER 0 // Set to either 0 (SPI, default) or 1 (I2C) based on jumper, matching the value of the DC Jumper
+// Also connect pin 13 to SCK and pin 11 to MOSI
 
 //////////////////////////////////
 // MicroOLED Object Declaration //
 //////////////////////////////////
-MicroOLED oled(PIN_RESET, PIN_DC, PIN_CS);  // SPI Example
-//MicroOLED oled(PIN_RESET, DC_JUMPER);  // I2C Example
+// Declare a MicroOLED object. The parameters include:
+// 1 - Reset pin: Any digital pin
+// 2 - D/C pin: Any digital pin (SPI mode only)
+// 3 - CS pin: Any digital pin (SPI mode only, 10 recommended)
+
+MicroOLED oled(PIN_RESET, PIN_DC, PIN_CS);  //Example SPI declaration, comment out if using I2C
+//MicroOLED oled(PIN_RESET, DC_JUMPER);  //Example I2C declaration, uncomment if using I2C
 
 // Use these variables to set the initial time
 int hours = 11;
@@ -67,27 +73,36 @@ void initClockVariables()
   POS_12_X = MIDDLE_X - oled.getFontWidth();
   POS_12_Y = MIDDLE_Y - CLOCK_RADIUS + 2;
   POS_3_X  = MIDDLE_X + CLOCK_RADIUS - oled.getFontWidth() - 1;
-  POS_3_Y  = MIDDLE_Y - oled.getFontHeight()/2;
-  POS_6_X  = MIDDLE_X - oled.getFontWidth()/2;
+  POS_3_Y  = MIDDLE_Y - oled.getFontHeight() / 2;
+  POS_6_X  = MIDDLE_X - oled.getFontWidth() / 2;
   POS_6_Y  = MIDDLE_Y + CLOCK_RADIUS - oled.getFontHeight() - 1;
   POS_9_X  = MIDDLE_X - CLOCK_RADIUS + oled.getFontWidth() - 2;
-  POS_9_Y  = MIDDLE_Y - oled.getFontHeight()/2;
-  
+  POS_9_Y  = MIDDLE_Y - oled.getFontHeight() / 2;
+
   // Calculate clock arm lengths
   S_LENGTH = CLOCK_RADIUS - 2;
   M_LENGTH = S_LENGTH * 0.7;
   H_LENGTH = S_LENGTH * 0.5;
 }
 
+// I2C is great, but will result in a much slower update rate. The
+// slower framerate may be a worthwhile tradeoff, if you need more
+// pins, though.
+
 void setup()
 {
+  delay(100);
+  //Wire.begin(); //set up I2C bus, uncomment if you are using I2C
+  // These three lines of code are all you need to initialize the
+  // OLED and print the splash screen.
+
   oled.begin();     // Initialize the OLED
   oled.clear(PAGE); // Clear the display's internal memory
   oled.clear(ALL);  // Clear the library's display buffer
   oled.display();   // Display what's in the buffer (splashscreen)
-  
+
   initClockVariables();
-  
+
   oled.clear(ALL);
   drawFace();
   drawArms(hours, minutes, seconds);
@@ -96,14 +111,14 @@ void setup()
 
 void loop()
 {
-  
+
   // Check if we need to update seconds, minutes, hours:
   if (lastDraw + CLOCK_SPEED < millis())
   {
     lastDraw = millis();
     // Add a second, update minutes/hours if necessary:
     updateTime();
-    
+
     // Draw the clock:
     oled.clear(PAGE);  // Clear the buffer
     drawFace();  // Draw the face to the buffer
@@ -138,7 +153,7 @@ void drawArms(int h, int m, int s)
 {
   double midHours;  // this will be used to slightly adjust the hour hand
   static int hx, hy, mx, my, sx, sy;
-  
+
   // Adjust time to shift display 90 degrees ccw
   // this will turn the clock the same direction as text:
   h -= 3;
@@ -150,21 +165,21 @@ void drawArms(int h, int m, int s)
     m += 60;
   if (s < 0)
     s += 60;
-  
+
   // Calculate and draw new lines:
   s = map(s, 0, 60, 0, 360);  // map the 0-60, to "360 degrees"
   sx = S_LENGTH * cos(PI * ((float)s) / 180);  // woo trig!
   sy = S_LENGTH * sin(PI * ((float)s) / 180);  // woo trig!
   // draw the second hand:
   oled.line(MIDDLE_X, MIDDLE_Y, MIDDLE_X + sx, MIDDLE_Y + sy);
-  
+
   m = map(m, 0, 60, 0, 360);  // map the 0-60, to "360 degrees"
   mx = M_LENGTH * cos(PI * ((float)m) / 180);  // woo trig!
   my = M_LENGTH * sin(PI * ((float)m) / 180);  // woo trig!
   // draw the minute hand
   oled.line(MIDDLE_X, MIDDLE_Y, MIDDLE_X + mx, MIDDLE_Y + my);
-  
-  midHours = minutes/12;  // midHours is used to set the hours hand to middling levels between whole hours
+
+  midHours = minutes / 12; // midHours is used to set the hours hand to middling levels between whole hours
   h *= 5;  // Get hours and midhours to the same scale
   h += midHours;  // add hours and midhours
   h = map(h, 0, 60, 0, 360);  // map the 0-60, to "360 degrees"
@@ -179,7 +194,7 @@ void drawFace()
 {
   // Draw the clock border
   oled.circle(MIDDLE_X, MIDDLE_Y, CLOCK_RADIUS);
-  
+
   // Draw the clock numbers
   oled.setFontType(0); // set font type 0, please see declaration in SFE_MicroOLED.cpp
   oled.setCursor(POS_12_X, POS_12_Y); // points cursor to x=27 y=0

examples/MicroOLED_Cube/MicroOLED_Cube.ino

@@ -1,21 +1,21 @@
 /******************************************************************************
- * MicroOLED_Cube.ino
- * Rotating a 3-D Cube on the MicroOLED Breakout
- * Jim Lindblom @ SparkFun Electronics
- * Original Creation Date: October 27, 2014
- * 
- * This sketch uses the MicroOLED library to draw a 3-D projected
- * cube, and rotate it along all three axes.
- * 
- * Development environment specifics:
- *  Arduino 1.0.5
- *  Arduino Pro 3.3V
- *  Micro OLED Breakout v1.0
- * 
- * This code is beerware; if you see me (or any other SparkFun employee) at the
- * local, and you've found our code helpful, please buy us a round!
- * 
- * Distributed as-is; no warranty is given.
+   MicroOLED_Cube.ino
+   Rotating a 3-D Cube on the MicroOLED Breakout
+   Jim Lindblom @ SparkFun Electronics
+   Original Creation Date: October 27, 2014
+
+   This sketch uses the MicroOLED library to draw a 3-D projected
+   cube, and rotate it along all three axes.
+
+   Development environment specifics:
+    Arduino 1.0.5
+    Arduino Pro 3.3V
+    Micro OLED Breakout v1.0
+
+   This code is beerware; if you see me (or any other SparkFun employee) at the
+   local, and you've found our code helpful, please buy us a round!
+
+   Distributed as-is; no warranty is given.
  ******************************************************************************/
 #include <Wire.h>  // Include Wire if you're using I2C
 #include <SPI.h>  // Include SPI if you're using SPI
@@ -27,43 +27,61 @@
 #define PIN_RESET 9  // Connect RST to pin 9
 #define PIN_DC    8  // Connect DC to pin 8
 #define PIN_CS    10 // Connect CS to pin 10
-#define DC_JUMPER 0
+#define DC_JUMPER 0 // Set to either 0 (SPI, default) or 1 (I2C) based on jumper, matching the value of the DC Jumper
+// Also connect pin 13 to SCK and pin 11 to MOSI
 
 //////////////////////////////////
 // MicroOLED Object Declaration //
 //////////////////////////////////
-MicroOLED oled(PIN_RESET, PIN_DC, PIN_CS); // SPI declaration
-//MicroOLED oled(PIN_RESET, DC_JUMPER);    // I2C declaration
+// Declare a MicroOLED object. The parameters include:
+// 1 - Reset pin: Any digital pin
+// 2 - D/C pin: Any digital pin (SPI mode only)
+// 3 - CS pin: Any digital pin (SPI mode only, 10 recommended)
+
+MicroOLED oled(PIN_RESET, PIN_DC, PIN_CS); //Example SPI declaration, comment out if using I2C
+//MicroOLED oled(PIN_RESET, DC_JUMPER); //Example I2C declaration, uncomment if using I2C
 
 int SCREEN_WIDTH = oled.getLCDWidth();
 int SCREEN_HEIGHT = oled.getLCDHeight();
 
 float d = 3;
-float px[] = { 
-  -d,  d,  d, -d, -d,  d,  d, -d };
-float py[] = { 
-  -d, -d,  d,  d, -d, -d,  d,  d };
-float pz[] = { 
-  -d, -d, -d, -d,  d,  d,  d,  d };
+float px[] = {
+  -d,  d,  d, -d, -d,  d,  d, -d
+};
+float py[] = {
+  -d, -d,  d,  d, -d, -d,  d,  d
+};
+float pz[] = {
+  -d, -d, -d, -d,  d,  d,  d,  d
+};
 
 float p2x[] = {
-  0,0,0,0,0,0,0,0};
+  0, 0, 0, 0, 0, 0, 0, 0
+};
 float p2y[] = {
-  0,0,0,0,0,0,0,0};
+  0, 0, 0, 0, 0, 0, 0, 0
+};
 
 float r[] = {
-  0,0,0};
+  0, 0, 0
+};
 
 #define SHAPE_SIZE 600
 // Define how fast the cube rotates. Smaller numbers are faster.
 // This is the number of ms between draws.
 #define ROTATION_SPEED 0
 
+// I2C is great, but will result in a much slower update rate. The
+// slower framerate may be a worthwhile tradeoff, if you need more
+// pins, though.
 void setup()
 {
+  delay(100);
+  //Wire.begin(); //set up I2C bus, uncomment if you are using I2C
+
   oled.begin();
   oled.clear(ALL);
-  oled.display();  
+  oled.display();
 }
 
 void loop()
@@ -74,41 +92,41 @@ void loop()
 
 void drawCube()
 {
-  r[0]=r[0]+PI/180.0; // Add a degree
-  r[1]=r[1]+PI/180.0; // Add a degree
-  r[2]=r[2]+PI/180.0; // Add a degree
-  if (r[0] >= 360.0*PI/180.0) r[0] = 0;
-  if (r[1] >= 360.0*PI/180.0) r[1] = 0;
-  if (r[2] >= 360.0*PI/180.0) r[2] = 0;
-
-  for (int i=0;i<8;i++)
+  r[0] = r[0] + PI / 180.0; // Add a degree
+  r[1] = r[1] + PI / 180.0; // Add a degree
+  r[2] = r[2] + PI / 180.0; // Add a degree
+  if (r[0] >= 360.0 * PI / 180.0) r[0] = 0;
+  if (r[1] >= 360.0 * PI / 180.0) r[1] = 0;
+  if (r[2] >= 360.0 * PI / 180.0) r[2] = 0;
+
+  for (int i = 0; i < 8; i++)
   {
     float px2 = px[i];
-    float py2 = cos(r[0])*py[i] - sin(r[0])*pz[i];
-    float pz2 = sin(r[0])*py[i] + cos(r[0])*pz[i];
+    float py2 = cos(r[0]) * py[i] - sin(r[0]) * pz[i];
+    float pz2 = sin(r[0]) * py[i] + cos(r[0]) * pz[i];
 
-    float px3 = cos(r[1])*px2 + sin(r[1])*pz2;
+    float px3 = cos(r[1]) * px2 + sin(r[1]) * pz2;
     float py3 = py2;
-    float pz3 = -sin(r[1])*px2 + cos(r[1])*pz2;
+    float pz3 = -sin(r[1]) * px2 + cos(r[1]) * pz2;
 
-    float ax = cos(r[2])*px3 - sin(r[2])*py3;
-    float ay = sin(r[2])*px3 + cos(r[2])*py3;
-    float az = pz3-150;
+    float ax = cos(r[2]) * px3 - sin(r[2]) * py3;
+    float ay = sin(r[2]) * px3 + cos(r[2]) * py3;
+    float az = pz3 - 150;
 
-    p2x[i] = SCREEN_WIDTH/2+ax*SHAPE_SIZE/az;
-    p2y[i] = SCREEN_HEIGHT/2+ay*SHAPE_SIZE/az;
+    p2x[i] = SCREEN_WIDTH / 2 + ax * SHAPE_SIZE / az;
+    p2y[i] = SCREEN_HEIGHT / 2 + ay * SHAPE_SIZE / az;
   }
 
   oled.clear(PAGE);
-  for (int i=0;i<3;i++) 
+  for (int i = 0; i < 3; i++)
   {
-    oled.line(p2x[i],p2y[i],p2x[i+1],p2y[i+1]);
-    oled.line(p2x[i+4],p2y[i+4],p2x[i+5],p2y[i+5]);
-    oled.line(p2x[i],p2y[i],p2x[i+4],p2y[i+4]);
-  }    
-  oled.line(p2x[3],p2y[3],p2x[0],p2y[0]);
-  oled.line(p2x[7],p2y[7],p2x[4],p2y[4]);
-  oled.line(p2x[3],p2y[3],p2x[7],p2y[7]);
+    oled.line(p2x[i], p2y[i], p2x[i + 1], p2y[i + 1]);
+    oled.line(p2x[i + 4], p2y[i + 4], p2x[i + 5], p2y[i + 5]);
+    oled.line(p2x[i], p2y[i], p2x[i + 4], p2y[i + 4]);
+  }
+  oled.line(p2x[3], p2y[3], p2x[0], p2y[0]);
+  oled.line(p2x[7], p2y[7], p2x[4], p2y[4]);
+  oled.line(p2x[3], p2y[3], p2x[7], p2y[7]);
   oled.display();
 }