sparkfun / sparkfun_micro_oled_particle_library Goto Github PK

View Code? Open in Web Editor NEW

10.0 46.0 37.0 45 KB

Firmware library SparkFun's Photon Micro OLED Shield.

License: GNU General Public License v3.0

C++ 62.80% C 37.20%

sparkfun oled particle-io particle-photon

sparkfun_micro_oled_particle_library's Introduction

SparkFun Photon Micro OLED Shield Library

Firmware library SparkFun's Photon Micro OLED Shield.

About

This is a firmware library for SparkFun's Photon Micro OLED Shield.

With a bit of extra setup, it'll also work with the Micro OELD Breakout.

You can use this library to draw pixels, lines, circles, squares, and text on the micro OLED's 64x48 display.

Repository Contents

/firmware - Source files for the library (.cpp, .h).
/firmware/examples - Example sketches for the library (.cpp). Run these from the Particle IDE.
spark.json - General library properties for the Particel library manager.

Example Usage

Include the library, declare a MicroOLED object, and set the display up with these snippets of code:

#include "SparkFunMicroOLED.h"  // Include the SFE_MicroOLED library
...
//////////////////////////
// MicroOLED Definition //
//////////////////////////
#define PIN_RESET D7  // Connect RST to pin 7 (req. for SPI and I2C)
#define PIN_DC    D3  // Connect DC to pin 3 (required for SPI)
#define PIN_CS    A2 // Connect CS to pin A2 (required for SPI)

//////////////////////////////////
// MicroOLED Object Declaration //
//////////////////////////////////
// Declare a MicroOLED object. The parameters include:
// 1 - Mode: Should be either MODE_SPI or MODE_I2C
// 2 - Reset pin: Any digital pin
// 3 - D/C pin: Any digital pin (SPI mode only)
// 4 - CS pin: Any digital pin (SPI mode only, 10 recommended)
MicroOLED oled(MODE_SPI, PIN_RESET, PIN_DC, PIN_CS);
...
void setup()
{
	oled.begin(); // Initialize the OLED
	oled.clear(ALL); // Clear the OLED's internal display buffer
	oled.display(); // Display whatever is in the firmware display buffer (SparkFun logo by default)
}

Check out the example files in the examples directory for more guidance.

Recommended Components

Generating Images

LCD Assistant - Useful tool for generating images

License Information

This product is open source!

Please review the LICENSE.md file for license information.

If you have any questions or concerns on licensing, please contact [email protected].

Distributed as-is; no warranty is given.

Your friends at SparkFun.

sparkfun_micro_oled_particle_library's People

Contributors

Stargazers

Watchers

sparkfun_micro_oled_particle_library's Issues

display() sends data for pages 0-5, clear(ALL) sends zeros for pages 0-7

I noticed this when I was working with the library - display() outer loop for sending data is for (i = 0; i < 6; i++) but clear(uint8_t mode) (and clear(uint8_t mode, uint8_t c)) outer loop for sending zeros/values is for (int i = 0; i < 8; i++)
Note that display is looping through the range 0...5, but clear is looping through the range 0...7.

Doesn't compile with the Particle Build IDE: can't find "application.h"

Is there something I'm missing?

'CLOCK_SPEED_400KHZ' was not declared in this scope

Veryfing code using this library in Particle Build fails with this error:

SparkFunMicroOLED/SparkFunMicroOLED.cpp:879:16: error: 'CLOCK_SPEED_400KHZ' was not declared in this scope
  Wire.setSpeed(CLOCK_SPEED_400KHZ)

_this was running the default script with the shield._

Improve I2C Speed

Just tried this lib on photon, works fine, I used a cheap ebay SSD1306 128x64 Oled without any issue.

As SSD1306 spec says it can works until 400 KHz in I2C mode, I suggest to add the following line in the i2csetup() just before Wire.begin();

Wire.setSpeed(CLOCK_SPEED_400KHZ);

this becomes

void MicroOLED::i2cSetup()
{
Wire.setSpeed(CLOCK_SPEED_400KHZ);
Wire.begin();

// SCL frequency = (F_CPU) / (16 + 2(TWBR) * (prescalar))
//TWBR = ((F_CPU / I2C_FREQ) - 16) / 2;
}

For information I was able to push my OLED until 1 MHz I2C, just 10 x faster than original code by using Wire.setSpeed(1000000); instead of Wire.setSpeed(CLOCK_SPEED_400KHZ);
Worth it

OLED-CUBE sample doesn't build in Particle Build (aka Web IDE)

Due to #include "application.h" in SparkFunMicroOLED.h the IDE throws oled-cube.cpp:39:80: fatal error: SparkFunMicroOLED/SparkFunMicroOLED.h: No such file or directory #include "application.h"

File not found when used in Particle Web IDE

Error message is :

test.ino:2:62: SparkFunMicroOLED.h: No such file or directory

The import statement was created automatically by the particle IDE, but I have edited it to try quote as well as angle brackets.

// This #include statement was automatically added by the Particle IDE.
#include "SparkFunMicroOLED.h" // Include Micro OLED library

I have also cleared the cache.

The example code from the library works fine!

All very frustrating.