使用 Python 控制 Arduino

本周從市圖借到這本 "Python x Arduino 物聯網整合開發實戰 (碁峰, 曾吉弘譯)",  此書翻譯自 Packt 出版的 "Python Programming for Arduino (Pratik Desai)", 主要是利用 Firmata 通訊協定讓電腦 (Windows, Linux, MacOS) 透過序列埠控制 Arduino, 使用 Python 豐富的函式庫 (視覺化, GUI, 遠端存取等) 實作 Arduino 的物聯網應用, 熟悉 Python 語言的人可駕輕就熟進入 IoT 領域.

Source : CAVEDU

不過這本書所介紹的技術不是要取代 Arduino C 原生程式碼的功能 (也不能), 而只是將 Firmata 協定所寫的韌體燒入 Arduino 當中間人, 讓電腦中的 Python 程式能透過 USB 串列埠與 Arduino 溝通而已. 這種模式下 Arduino 並非獨立運作, 而是接受電腦的 Python 程式控制. 獨立運作的 Arduino 還是必須使用 C 語言編寫原生碼 (韌體), 而非 Firmata.

以下即依照書中描述, 實際測試 Firmata 的功能. Arduino IDE 已經內建了各種應用的 Firmata 韌體, 放置在 "檔案/範例/Firmata" 裡, 測試 Firmata 功能的最簡單方式是開啟 "檔案/範例/Firmata/StandardFirmata" 這個範例程式 :

開啟後不要做任何修改, 直接上傳 Arduino 即可, 編譯後記憶體占用情形如下 (1.8.1 版) :

草稿碼使用了 11134 bytes (36%) 的程式儲存空間。上限為 30720 bytes。
全域變數使用了 1029 bytes (50%) 的動態記憶體，剩餘 1019 bytes 給區域變數。上限為 2048 bytes 。

韌體上傳 Arduino 後, 接下來就是要在電腦端執行 Firmata 測試程式, 連線 Firmata 官網下載 Windows 版的 firmata_test.exe :

# http://www.firmata.org

執行 firmata_test.exe, 點選上方的 Port 選單, 選擇 Arduino 所接的 USB COM 埠 (參考 Arduino Nano 開機測試) :

選定後就會出現 Arduino 每一個 Port 的目前狀態, 其中 6 個 Analog 因為接腳浮接的關係, 其值是隨機的亂數, 因此數值不斷閃爍. 按下 D13 的按鈕切換至 HIGH 狀態時, Arduino 板子上內建的 D13 LED 會亮起來, 切回 LOW 就熄滅, 這就是 Firmata 的主要功能, 即不需要撰寫 Arduino 草稿碼也可以控制 Arduino :

上面的 firmata_test.exe 是現成的電腦主機端軟體, 透過 USB 串列埠與 Arduino 裡的 StandardFirmata 草稿碼互動. 如果要用 Python 自行撰寫程式與 Arduino 程式碼互動, 必須在電腦中安裝 Python 的 pySerial 套件 :

C:\Users\Tony>pip3 install pyserial
Collecting pyserial
  Downloading pyserial-3.3-py2.py3-none-any.whl (189kB)
Installing collected packages: pyserial
Successfully installed pyserial-3.3

如果是離線安裝, 先下載 pyserial 的 whl 或 gz 檔 :

# https://pypi.python.org/pypi/pyserial#downloads

C:\Users\Tony>pip3 install d:\python\pyserial-3.3-py2.py3-none-any.whl
Processing d:\python\pyserial-3.3-py2.py3-none-any.whl
Installing collected packages: pyserial
Successfully installed pyserial-3.3

關於 PySerial 函式庫的 API 用法參考 :

# http://pyserial.readthedocs.io/en/latest/pyserial_api.html

接下來到 Arduino IDE 開啟 "檔案/範例/01.Basics/DigitReadSerial" 草稿碼 :

其內容如下 :

// digital pin 2 has a pushbutton attached to it. Give it a name:
int pushButton = 2;

// the setup routine runs once when you press reset:
void setup() {
  // initialize serial communication at 9600 bits per second:
  Serial.begin(9600);
  // make the pushbutton's pin an input:
  pinMode(pushButton, INPUT);
}

// the loop routine runs over and over again forever:
void loop() {
  // read the input pin:
  int buttonState = digitalRead(pushButton);
  // print out the state of the button:
  Serial.println(buttonState);
  delay(1);        // delay in between reads for stability
}

程式只是從 Pin2 接腳讀取按鈕輸入, 然後送到序列埠去, 此程式不用修改直接上傳 Arduino 即可, 我們接下來要在電腦這端使用 Python 程式透過 PySerial 套件讀取 Arduino 送到串列埠的數據. 在 IDLE 輸入如下指令 :

Python 3.6.1 (v3.6.1:69c0db5, Mar 21 2017, 18:41:36) [MSC v.1900 64 bit (AMD64)] on win32
Type "copyright", "credits" or "license()" for more information.
>>> import serial
>>> s=serial.Serial("com3",9600)
>>> while True:
        print(s.readline())

此程式利用 serial.Serial() 函數建立 com3 (或 COM3, 大小寫無關) 的序列埠物件, 再以此物件的 readline() 讀取連接至 COM3 的 Arduino 序列埠數據. 這時畫面會不斷顯示從序列埠讀取到 0, 這是因為 Arduino 的 Pin2 並未真正接上按鈕之故.

上面是我照書本上的範例所做的測試, 從 Arduiono 輸出數據 (0) 到 USB 串列埠, 再由 Python 程式透過 PySerial 去讀取. 接下來我想反方向測試, 由 Python 程式經序列埠傳送資料給 Arduino. Python 程式如下 :

import serial

s=serial.Serial("com3",9600)

from time import sleep

while True:

s.write('H'.encode())

sleep(1)

s.write('L'.encode())

sleep(1)

此程式從 time 套件匯入 sleep() 函數用來暫停程式執行 (即休眠), 其參數單位為秒, 程式會在無限迴圈中持續對序列埠送出 'H' 與 'L', 間隔一秒, 注意, 因為 Python 3 字串都以 Unicode 表示, 因此在輸出到序列埠時必須呼叫 encode() 將其轉成 byte 編碼. 參考 :

# python3 pySerial TypeError: unicode strings are not supported, please encode to bytes

而 Arduino 端程式則是持續讀取序列埠, 若收到 'H' 就點亮 D13 LED; 否則就熄滅它 :

int LED=13;
void setup() {
  Serial.begin(9600);
  }

void loop() {
  if (Serial.available() > 0) {
    if (Serial.read()=='H') {digitalWrite(LED, HIGH);}
    else {digitalWrite(LED, LOW);}
    }
  delay(1);    
  }

將此 Arduino 草稿碼上傳後, 於 PC 端執行 Python 程式, Arduino 板上的 D13 LED 將亮一秒, 滅一秒反覆交替. 從這個範例可以看出 PySerial 的角色是在 Arduino 與 PC 間透過 USB 串列埠搭起雙向溝通的橋樑. 不過 PySerial 功能較為樸素, 不具有 Firmata 功能, 因此除了 PC 端要寫 Python 程式外, 對於不同的應用, Arduino 端也必須配合不斷改寫上傳, 殊為不便.

有沒有兼具 Firmata 與 PySerial 功能的函式庫, 可以讓 Arduino 端指上傳韌體一次即可, 我們只要專注在 PC 端即可呢? 有的, 那就是 PyFirmata 函式庫, 此函式庫是在 PySerial 基礎上加入 Firmata 功能, 可以用 pip3 install pyfirmata 指令安裝此套件 :

C:\Users\Tony>pip3 install pyfirmata
Collecting pyfirmata
  Downloading pyFirmata-1.0.3-py2.py3-none-any.whl
Requirement already satisfied: pyserial in c:\python36\lib\site-packages (from pyfirmata)
Installing collected packages: pyfirmata
Successfully installed pyfirmata-1.0.3

若需離線安裝, 可先下載 pyfirmata 的 whl 或 gz 檔 :

# https://pypi.python.org/pypi/pyFirmata

C:\Users\Tony>pip3 install d:\python\pyFirmata-1.0.3-py2.py3-none-any.whl
Processing d:\python\pyfirmata-1.0.3-py2.py3-none-any.whl
Requirement already satisfied: pyserial in c:\python36\lib\site-packages (from p
yFirmata==1.0.3)
Installing collected packages: pyFirmata
Successfully installed pyFirmata-1.0.3

關於 PyFirmata API 使用說明參考 :

# http://pyfirmata.readthedocs.io/en/latest/

欲測試 PyFirmata 功能, 需從 Arduino IDE 的範例中再次上傳 StandardFirmata 草稿碼, 然後就可以在 PC 端用 Python 程式透過序列埠操控 Arduino 了, 程式如下 :

import pyfirmata
from time import sleep
LED=13
PORT="COM3"
board=pyfirmata.Arduino(PORT)
while True:
board.digital[LED].write(1)
sleep(1)
board.digital[LED].write(0)
sleep(1)

這裡要先匯入 pyfirmata 函式庫, 然後呼叫 Arduino() 函數來指定兩方溝通的序列埠名稱, 傳回Arduino 板子物件, 此物件的 digital 串列物件可用來指定 Arduino 腳位, write() 函數可用來輸出準位. 執行後同樣可看到 Arduino 板上的 D13 LED 間隔一秒明滅. 與使用 PySerial 不同的是, 如果要更改應用程式功能, 不需要 (也不可以) 動 Arduino 端韌體 (不須再上傳草稿碼), 全部在電腦端用 Python 程式就可以搞定了.

哇! 這番測試下來發現 Python 這語言真是好用, 甚麼樣功能的函式庫都有高手寫好了, 就怕我們不知道而已. 我在想, 以前 Arduino 要跟電腦互動大都使用 Processing 程式, 有了 PyFirmata 後是否可以用 Python 完全取代 Processing 呢?

參考 :

# Arduino：在Windows裡使用Python語言經由Firmata協定控制Arduino開發板
# ARDUINO筆記(十三)：使用FIRMATA 協定，ARDUINO 也可以執行 PYTHON