Arduino撰寫自己的程式庫

不論是哪套軟體開發平台，一定會有程式庫（也可能以元件庫、類別庫、軟體開發框架的形式出現）的概念，其功用就是把某功能寫好包裝起來，隱藏細節，方便大家運用。

Arduino軟體開發環境內建了一些常用程式庫，諸如LiquidCrystal、Servo、SoftwareSerial、SPI、等等，有了它們，便只需在較抽象較上層的階級對該功能有所了解即可，不必完全知曉底層複雜的技術。

另外也有很多人將開發出來的Arduino程式包裝成程式庫開放給大家使用，譬如Dr. Monk的Timer、存取1-Wire匯流排協定的OneWire、讀取Dallas溫度感測器的DallasTemperature、解決按鈕訊號在高低電位之間彈跳的Bounce、等等，

這篇的主題是撰寫自己的Arduino程式庫，將功能包裝後變成程式庫，隱藏底層細節、提供較簡易的介面，供別的專案使用，甚至供其他人使用。

首先以底下這份草稿碼，以PWM讓LED漸亮、漸暗、不斷循環，我稱之為呼吸燈。

詳情就不解說了，請參考我寫的Arduino練習：呼吸燈。

int brightness = 0;
int fadeAmount = 5;
int delayDuration = 30;

void setup()  {
  pinMode(9, OUTPUT);
}

void loop()  {
  analogWrite(9, brightness);
  brightness = brightness + fadeAmount;
  if (brightness <= 0 || brightness >= 255) {
    fadeAmount = -fadeAmount ;
  }  

  delay(delayDuration);                          
}

好，那如果想要有三個呼吸燈呢，程式會變得很複雜吧。當然啦，其實可使用計時器的程式庫，譬如Dr. Monk的Timer，就能寫出簡單易懂的程式碼，不過這篇要介紹的是自行撰寫Arduino程式庫，所以讓我寫個程式庫，將以上的程式碼包起來，方便使用。

Arduino程式庫有兩個地方，一個是內建的，我們不動它，另一個是自己安裝的，這個程式庫的目錄在sketchbook底下的libraries（若無請自行建立）。

在libraries底下新增目錄，命名為PwmLed，這就是我將撰寫的程式庫的位置，裡面放進PwmLed.cpp與PwmLed.h，這是程式庫的主體，內容如下。

（咳咳，我就不解釋C++程式語言了。）

首先是PwmLed.h：

#ifndef PwmLed_h
#define PwmLed_h

#include <inttypes.h>

class PwmLed
{

public:
  unsigned long m_lastTime;
  uint8_t m_pin;
  int m_brightness;
  int m_fadeAmount;
  unsigned long m_delayDuration;
 
  PwmLed(void);
  void set(uint8_t pin, int initBrightness, int fadeAmount, unsigned long delayDuration);
  void update(void);
};

#endif

內容很普通，就是一般的C++標頭檔。接下來是PwmLed.cpp：

// For Arduino 1.0 and earlier
#if defined(ARDUINO) && ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif

#include "PwmLed.h"

PwmLed::PwmLed(void)
{
}

void PwmLed::set(uint8_t pin, int initBrightness, int fadeAmount, unsigned long delayDuration)
{
    m_pin = pin;
    m_brightness = initBrightness;
    m_fadeAmount = fadeAmount;
    m_delayDuration = delayDuration;
   
    pinMode(m_pin, OUTPUT);
    analogWrite(m_pin, m_brightness);
    m_lastTime = millis();
}


void PwmLed::update(void)
{
    unsigned long t = millis();
    if(t > m_lastTime + m_delayDuration){
        m_lastTime += m_delayDuration;
       
        analogWrite(m_pin, m_brightness);
        m_brightness = m_brightness + m_fadeAmount;
   
        if (m_brightness <= 0 || m_brightness >= 255) {
            m_fadeAmount = -m_fadeAmount;
        }
    }
}

還可以再加入keywords.txt，指定程式庫的關鍵字，這麼一來，Arduino軟體開發環境的編輯器就能以不同顏色顯示。如下：

#######################################
# Syntax Coloring Map For Timer Library
#######################################

#######################################
# Datatypes (KEYWORD1)
#######################################

PwmLed    KEYWORD1

#######################################
# Methods and Functions (KEYWORD2)
#######################################

set    KEYWORD2
update    KEYWORD2

#######################################
# Instances (KEYWORD2)
#######################################

#######################################
# Constants (LITERAL1)
#######################################

libraries/PwmLed底下還可以放個examples目錄，存放範例，我就不管了。

程式庫至此已經準備完畢，請重新開啟Arduino軟體開發環境，應該就能在Sketch-Import Library...下看到PwmLed。

接下來就是使用了。

電路圖如下：

Arduino腳位9、10、11（具有PWM功能），各自接到220 ohm電阻、再接到LED長腳，LED短腳接地。


然後，使用PwmLed程式庫，讓三個LED變成呼吸燈的草稿碼如下：

#include <PwmLed.h>

#define LED0 9
#define LED1 10
#define LED2 11

PwmLed led0;
PwmLed led1;
PwmLed led2;

void setup()  {
  led0.set(LED0, 0, 5, 30);
  led1.set(LED1, 0, 10, 60);
  led2.set(LED2, 0, 30, 300);
}

void loop()  {
  led0.update();  
  led1.update();  
  led2.update();
}

先以set設定，參數第一個是PWM腳位，第二個是初始亮度，0不亮、255全亮，第三個是每次更新亮度時的更新幅度，越小代表變化會越平順，第四個代表更新頻率，單位是千分之一秒，越小代表越快更新。聽起來很複雜，但換換數字看看結果就清楚了。

然後在loop()裡以update更新亮度。

很簡單吧！

原始碼可到這裡下載。


參考資料：

• Arduino官方網站參考文件：Libraries、Installing Additional Arduino Libraries。
• Arduino官方網站參考文件：Writing a Library for Arduino。
• Arduino Playground：How to write libraries for the Arduino?。
• NoMi Design的Writing Your Own Arduino Libraries。