Mini tutorial on making a library, we will make a mini tutorial to add two numbers
and flash an LED on selected pin.
*** I M P O R T A N T ***
Write the routine as a void [routine]() in Arduino IDE
Make sure it runs as you want it to.
(My son sat for 3 hours trying to get a library working with a bad routine!!!!!!!!!)
Make a .h header file e.g. addatobLIB.h
(I tend to use LIB at the end if the filename so I know its a LIBrary)
add these lines :
#ifndef [name of library]_h
#define [name of library]_h
#include "WProgram.h"
class [name of library]
{
public:
private:
};
#endif
So ours will be :
#ifndef addatob_h
#define addatob_h
#include "WProgram.h"
class addatobLIB
{
public:
private:
};
#endif
Now, define the variables we want to use, and define the library's command name :
I want to pass 2 int's,for easy use i'll call them apass and bpass.
#ifndef addatob_h
#define addatob_h
#include "WProgram.h"
class addatobLIB
{
public:
addatobLIB(int pin); //Our startup
int add(int apass,int bpass); //int used because we are ruturning a value
int minus(int apass,int bpass); //as above
private:
int _pin;
int _apass;
int _bpass;
int _total;
};
#endif
save this file as addatob.h in the library\addato folder in your arduino directory
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Now for the .cpp file
Create a file called addatob.cpp
Add these to our file :
#include "addatobLIB.h"
#include "WProgram.h"
addatobLIB::addatobLIB(int pin)
{
//Initialise the output pin for our routine
_pin = pin;
pinMode(pin, OUTPUT);
}
Now lets add the routines to add and minus :
#include "addatob.h"
#include "WProgram.h"
addatobLIB::addatobLIB(pin)
{
//Initialise the output pin for our routine
_pin = pin;
pinMode(_pin, OUTPUT);
}
//Almost a complete copy and paste from your working program
int addatobLIB::add(int apass,int bpass) // This line was void add(int apass,int bpass)
// We use int here, as we will be returning _total later.
{
_apass=apass;
_bpass=bpass;
_total=((_apass)+(_bpass));
for(int z=0:z<(_total):z++)
{
digitalWrite(_pin,HIGH);
delay(500);
digitalWrire(_pin,LOW);
delay(500);
}
return (_total);
}
int addatobLIB::minus(int apass,int bpass)// This line was void add(int apass,int bpass);
// We use int here, as we will be returning _total later.
{
_apass=apass;
_bpass=bpass;
_total=((_apass) - (_bpass));
for(int z=0;z<(_total);z++)
{
digitalWrite(_pin,HIGH);
delay(500);
digitalWrite(_pin,LOW);
delay(500);
}
return (_total);
}
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Just an example to go :
(If you save this in a folder called examples inside your library's folder, it will
be added to the menu in the IDE)
#include <addatobLIB.h> // Add the Library for use
addatobLIB mat(13); // Start the library and create an object called mat, set pin 13 for output
void setup()
{
Serial.begin(57600);
}
void loop()
{
int pool = mat.add(3,4); // pool is equal to 3+4 using library function add
Serial.println(pool); // Output value to serial port
while(1){} // Stop here forever
}
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
What about adding keywords :
add a file called keywords.txt
add this to it :
#######################################
# Syntax Coloring Map For binstop
#######################################
#######################################
# Datatypes (KEYWORD1)
#######################################
add KEYWORD1
minus KEYWORD1
(The space between add and minus & KEYWORD1 is a TAB)
| Arduino Forum :: Forum 2005-2010 (read only) :: General :: Exhibition :: New, Easy, Arduino to shift register LIBRARY