Belajar

Cara debug kode Arduino, dari print Serial sampai breakpoint

Pemula

Atau lihat semua pelajaran.

  • 526komponen di meja kerja
  • 46board sedang berjalan
  • 1.00xwaktu nyata, di semua board
Arduino Uno: sebuah knob dan LEDlive0.000 s 0.00x
Klik untuk membukanya di editor
Potensiometer di A0 mengatur LED di pin 9. Buka, tempel contoh kerjanya, dan putar knob-nya dengan Serial Monitor terbuka.

Arduino tidak punya layar, jadi saat sketch-mu bermasalah kamu tidak bisa melihat apa yang dipikirkannya. Uno dan Nano klasik juga tidak bisa di-step di Arduino IDE: debugger IDE hanya mendukung board tertentu yang lebih baru, bukan board AVR yang dipakai kebanyakan kelas dan kit. Jadi kebanyakan orang debug dengan Serial.print, dan itu bekerja baik begitu dipakai dengan sengaja.

Halaman ini adalah metode untuk mempersempit bug, lalu tiga alat: mencetak, mem-plot, dan menghentikan board di satu baris. Rangkaian di atas adalah sebuah Uno dengan potensiometer di A0 dan LED di pin 9, cukup untuk menunjukkan ketiganya, termasuk bug sungguhan yang hanya terjadi di Uno.

Perkecil bug-nya sebelum mengejarnya

Tuliskan apa yang kamu harapkan dan apa yang terjadi, masing-masing dalam satu kalimat. "LED harusnya makin terang saat kuputar knob-nya, dan malah terang, lalu gelap, lalu terang lagi" adalah bug yang bisa diuji; "tidak jalan" bukan.

Lalu persempit masalahnya. Periksa kabel terhadap nomor pin di kode lebih dulu, karena itu menangkap sebagian besar bug. Beri komentar pada semua yang tidak terlibat, atau salin bagian yang dicurigai ke sketch baru. Ubah satu hal dalam satu waktu dan jalankan lagi. Bug yang bertahan dalam sepuluh baris adalah bug yang akan kamu temukan; bug yang sama dalam tiga ratus baris hanya tebak-tebakan.

Serial.print, dipakai dengan sengaja

Mulai port di setup() dengan Serial.begin, dan di board sungguhan setel serial monitor ke baud rate yang sama, atau kamu dapat karakter kacau. Cetak sesuatu sekali di akhir setup(). Jika baris itu muncul lagi dan lagi, board sedang reset, yang biasanya berarti motor atau servo menurunkan catu daya.

Beri label pada tiap nilai, jadi button: pressed daripada 0 saja. Cetak saat sesuatu berubah, bukan di tiap putaran loop(), yang membanjiri monitor terlalu cepat untuk dibaca. Dan bungkus print dalam makro, agar bisa dimatikan di satu tempat alih-alih dihapus dan diketik ulang saat bug itu kembali.

Print berlabel, saat berubah, di balik satu saklar
#define DEBUG 1

#if DEBUG
#define DEBUG_PRINT(x) Serial.print(x)
#define DEBUG_PRINTLN(x) Serial.println(x)
#else
#define DEBUG_PRINT(x)
#define DEBUG_PRINTLN(x)
#endif

const int BUTTON_PIN = 2;
int lastState = HIGH;

void setup() {
  Serial.begin(115200);
  pinMode(BUTTON_PIN, INPUT_PULLUP);
  DEBUG_PRINTLN("setup done");  // printed again on every reset
}

void loop() {
  int state = digitalRead(BUTTON_PIN);
  if (state != lastState) {  // print on a change, not on every pass
    DEBUG_PRINT("button: ");
    DEBUG_PRINTLN(state == LOW ? "pressed" : "released");
    lastState = state;
  }
}

Buka sketch ini di editorKodenya saja: editor menempatkan board dan komponen yang bisa dibacanya dari sketch.

Mencetak butuh waktu

Tiap karakter butuh sekitar satu milidetik untuk dikirim pada 9600 baud, jadi satu baris 20 karakter memakan sekitar 20 milidetik. Uno sungguhan menyembunyikan 64 byte pertama di buffer kirim, tapi sketch yang mencetak di tiap putaran cepat memenuhinya lalu menunggu di tiap karakter. Pakai 115200 baud, dua belas kali lebih cepat, dan cetak lebih sedikit.

Ini juga alasan menambah satu print kadang membuat bug menghilang. Jika memperlambat sketch memperbaikinya, bug-nya soal waktu: tombol dibaca terlalu cepat, sensor dibaca sebelum siap, atau interrupt berlomba dengan loop utama. Itu petunjuk, bukan perbaikan. Jangan mencetak di dalam interrupt handler; setel sebuah flag di sana dan cetak dari loop().

Contoh nyata: rata-rata yang jadi negatif

Ini bug sungguhan. Sketch-nya merata-ratakan 64 pembacaan potensiometer untuk menghaluskannya. Dengan rangkaian dimmer di atas dan knob di 100, ia mencetak total:6400 average:100, yang benar. Putar knob ke tengah, 512, dan ia mencetak total:-32768 average:-512. Di puncak, 1023, ia mencetak total:-64 average:-1.

Print membuat penyebabnya terlihat: totalnya salah, jadi rata-rata bukan masalahnya. Di Uno sebuah int 16 bit dan menampung maksimum 32.767, sedangkan 64 pembacaan sebesar 1023 berjumlah 65.472, jadi totalnya melipat menjadi negatif. Sketch yang sama bekerja di ESP32, tempat int 32 bit, dan inilah persis jenis perbedaan yang membuat bug terlihat acak. Perbaikannya long total = 0;. Tanpa mencetak totalnya, kamu hanya melihat rata-rata yang buruk dan mungkin mencari di tempat yang salah.

Bug-nya, dan perbaikan satu katanya di komentar
const int SENSOR_PIN = A0;

void setup() {
  Serial.begin(115200);
}

void loop() {
  int total = 0;  // the bug: make this long
  for (int i = 0; i < 64; i++) {
    total += analogRead(SENSOR_PIN);
  }
  Serial.print("total:");
  Serial.print(total);
  Serial.print(" average:");
  Serial.println(total / 64);
  delay(250);
}

Buka sketch ini di editorKodenya saja: editor menempatkan board dan komponen yang bisa dibacanya dari sketch.

Plot angkanya alih-alih membacanya

Nilai yang berubah sepanjang waktu lebih mudah dinilai sebagai garis. Serial Plotter Arduino IDE dan tab Plot Mokxi membaca format yang sama: angka dalam satu baris dipisah spasi atau koma, masing-masing boleh berlabel name:value. Contoh kerja di atas sudah mencetak dalam bentuk itu, jadi buka tab Plot dan putar knob-nya, dan kamu bisa menyaksikan total melipat menjadi negatif di titik tengah.

Mencetak ambang di samping pembacaan, seperti reading:512 threshold:600, menggambar ambang sebagai garis datar, jadi kamu bisa melihat kapan persisnya sensor melintasinya dan seberapa berisik di dekat tepinya. Itu menjawab "kenapa lampuku berkedip nyala-mati saat senja" dalam sekali lihat.

Hentikan board di satu baris

Di Mokxi kamu bisa menghentikan board mana pun dengan breakpoint, termasuk Uno, karena chipnya disimulasikan, bukan tersambung lewat USB. Klik di gutter di kiri nomor baris, dan titik merah muncul; tekan Jalankan, dan board berhenti sebelum baris itu dijalankan. Seluruh rangkaian berhenti bersamanya, jadi LED tetap seterang sebelumnya dan millis() tidak melompat selagi kamu melihat.

Tab Debug lalu menunjukkan di mana board berhenti, register-nya, dan daftar pantau untuk variabel global. Step over menjalankan satu baris dalam satu waktu. Daftar pantau hanya membaca global, jadi saat debug membantu menjadikan variabel yang kamu pedulikan sebagai global. Di ESP32 dan ESP8266, Jeda dan daftar pantau bekerja, tapi breakpoint tidak, karena compiler browser tidak bisa build untuk dua chip itu. Contoh breakpoint di bawah memandumu melakukannya di ESP32-C3.

Buka rangkaian ini di editor. Arduino Uno: sebuah knob dan LED, dirangkai seperti yang berjalan di bagian atas halaman ini. Ganti satu komponen atau nilainya lalu jalankan lagi.

Buka rangkaian ini

Pertanyaan

Bisakah kamu men-debug Arduino Uno dengan breakpoint?

Tidak dengan debugger Arduino IDE, yang tidak mendukung board AVR. ATmega328P punya antarmuka debug satu kabel, debugWIRE, tapi itu butuh hardware debugger terpisah. Di Mokxi, breakpoint bekerja langsung pada Uno yang disimulasikan.

Kenapa Serial Monitor-ku menampilkan karakter acak?

Di board sungguhan, baud rate monitor tidak cocok dengan Serial.begin. Set keduanya ke angka yang sama, misalnya 115200.

Kenapa menambahkan Serial.print membuat bug-ku hilang?

Mencetak memperlambat sketch, jadi bug-nya bergantung pada timing: pembacaan yang terjadi terlalu dini, debounce yang hilang, atau variabel yang dipakai bersama dengan interrupt.

Haruskah aku membiarkan cetakan debug di sketch yang sudah jadi?

Matikan saja daripada menghapusnya, dengan macro DEBUG seperti di atas. Saat aktif mereka memakan waktu dan memori, saat mati tidak sama sekali.

Rakit versi nyatanya

Buka editor, ubah sebuah nilai, dan lihat angkanya ikut berubah. Tidak ada yang perlu dipasang, dan tidak perlu akun.