DEV-13628 Datasheet DEV-13628 | P4-P6

Using the Particle OLED Library

Great, now that we understand the hardware setup, let’s put some code on

this thing and see what it can do. Using the Particle library we’ve written,

you’ll be able to write text, draw lines and shapes, and generally display

anything that’ll fit on the screen.

Getting the Particle OLED Library

For this page we’ll be using the online Particle environment. If you’re using

the Particle Dev environment instead, you can get the library and code

examples from the GitHub repository.

DOWNLOAD THE PARTICLE OLED LIBRARY

Load the Demo Example

If you haven’t created a Particle user account and claimed your board,

you’ll need to do that now. Starting here is a great idea if you’re having

trouble.

Once you’re logged into build.particle.io and have a device selected (all this

is covered at the link above), you’ll want to click on the

create new app

button in the sidebar – it’s big and blue, you can’t miss it. Call your app

something like ‘OLED_test’.

Next – this is the important part – we include the

SparkFunMicroOLED

library. To do this:

• Click on the icon that looks like a bookmark (it’s all the way to the left

on the black skinny sidebar, 4th up from the bottom)

• In the text box under ‘community libraries’, search for ‘OLED’ and

you’ll see ‘SparkFunMicroOLED’ come up (though it might be cut off

a little bit, don’t worry).

It should look something like this:

Page 4 of 1

• Click on the library name, and a bunch of stuff will pop up, including

all the library files as well as a few options of what to do with the

library.

• In this case, we just want to use the library in our app, so click on the

‘include in app’ button.

• This will lead you to list of all your apps - click on the name of the app

you just created, and you should see a statement like

#include "SparkFunMicroOLED/SparkFunMicroOLED.h" at the top of

your app.

• Last thing is to add the math library to our sketch - on the line below

the first

#include statement, type in: #include "math.h"

Now that we’ve included the library in our app, let’s give it some code - just

copy the demo code below and paste it into your app, below the include

statements.

Page 5 of 1

/*

MicroOLEDShieldExample.ino

SparkFunMicroOLEDLibraryHelloWorldExample

JimLindblom@SparkFunElectronics

OriginalCreationDate:June22,2015

Thissketchprintsafriendly,recognizablelogoontheOLEDS

hield,then

goesontodemotheMicroOLEDlibrary'sfunctionalitydrawi

ngpixels,

lines,shapes,andtext.

Har

dwareConnections:

ThissketchwaswrittenspecificallyforthePhotonMicroOL

EDShield,whichdoesallthewiringforyou.IfyouhaveaMi

croOLEDbreakout,usethefollowinghardwaresetup:

MicroOLEDPhoton

GNDGND

VDD3.3V(VCC)

D1/MOSIA5(don'tchange)

D0/SCKA3(don'tchange)



D2

D/CD6(canbeanydigitalpin)

RSTD7(canbeanydigitalpin)

CSA2(canbeanydigitalpin)

Developmentenvironmentspecifics:

IDE:ParticleBuild

HardwarePlatform:ParticlePhoton

SparkFunPhotonMicroOLEDShield

Thiscodeisbeerware;ifyouseeme(oranyotherSpar

kFun

employee)atthelocal,andyou'vefoundourcodehelpful,

pleasebuyusaround!

Distributedasis;nowarrantyisgiven.

//////////////////////////////////

//MicroOLEDObjectDeclaration//

//////////////////////////////////

//DeclareaMicroOLEDobject.Ifnoparametersaresupplied,

defaultpinsare

//used,whichwillworkforth

ePhotonMicroOLEDShield(RST

=D7,DC=D6,CS=A2)

MicroOLEDoled;

void setup()

{

oled.begin();//InitializetheOLED

oled.clear(ALL);//Clearthedisplay'sinternalmemory

oled.display();//Displaywhat'sinthebuffer(splashscre

en)

delay(1000);//Delay1000ms

oled.clear(PAGE);//Clearthebuffer.

randomSeed(analogRead(A0)+ analogRead(A1));

}

void loop()

{

pixelExample();//Runthep

ixelexamplefunction

Page 6 of 1

P1-P3 P4-P6 P7-P9 P10-P12

DEV-13628

Mfr. #:

Buy DEV-13628

Manufacturer:

SparkFun

Description:

Display Development Tools PhotonMicro OLED Shield

Lifecycle:

New from this manufacturer.

Delivery:

DHL FedEx Ups TNT EMS

Payment:

T/T Paypal Visa MoneyGram Western Union

Products related to this Datasheet

DEV-13628