Belajar

Fungsi Arduino: tulis sekali, panggil di mana saja

Atau lihat semua pelajaran.

  • 526komponen di meja kerja
  • 46board sedang berjalan
  • 1.00xwaktu nyata, di semua board
Arduino Uno: tiga lampu, satu fungsi flashlive0.000 s 0.00x
Tekan Jalankan dan lihat lampunya
flash(pin, times, onMs) ditulis sekali dan dipanggil tiga kali dengan angka berbeda.

Fungsi adalah blok kode bernama yang bisa kamu jalankan dari mana saja di sketch-mu dengan menulis namanya. void flash(int pin, int times) adalah fungsi yang mengedipkan pin apa pun sebanyak apa pun kali, jadi alih-alih menyalin empat baris yang sama untuk setiap LED, kamu cukup menulis flash(13, 1), flash(12, 2) dan flash(11, 3). setup() dan loop() juga fungsi; kamu sudah menulisnya selama ini.

Rangkaian di atas punya tiga lampu di pin 13, 12 dan 11, yang digerakkan persis oleh fungsi itu. Tekan Jalankan. Serial monitor mencetak "three lamps, one flash function", lalu "pin 13 flashes 1 times", "pin 12 flashes 2 times" dan "pin 11 flashes 3 times", dan setiap lampu melakukan apa yang tertulis di barisnya.

Di bawah ini adalah bentuk sebuah fungsi, fungsi yang mengembalikan jawaban, kenapa mengubah parameter tidak berpengaruh pada pemanggilnya, di mana fungsi boleh dan tidak boleh diletakkan, dan pesan error untuk setiap kesalahan.

Mau versi langkah demi langkah? Pelajaran "Write it once" membahas ini dengan checkpoint.

Buka pelajaran

Bentuk sebuah fungsi

Fungsi punya tipe kembalian, nama, dan parameternya dalam kurung, lalu tubuhnya dalam kurung kurawal. Pada void flash(int pin, int times, int onMs), void berarti tidak mengembalikan apa pun, flash adalah namanya, dan tiga int adalah angka yang harus diberikan pemanggilnya. Di dalamnya, pin, times dan onMs adalah variabel biasa yang berisi apa pun yang diteruskan pemanggilnya.

Dua fungsi kecil setelahnya menjawab pertanyaan alih-alih melakukan pekerjaan. lampFor(round) mengembalikan pin untuk sebuah ronde dan timesFor(round) mengembalikan berapa kali kedipan, dan loop() memakai jawaban mereka. Ubah return round + 1; menjadi return round + 2; dan setiap lampu berkedip sekali lebih banyak.

firmware/uno/examples/cppfunc (fungsi-fungsi yang berjalan di atas)
void flash(int pin, int times, int onMs) {
  for (int i = 0; i < times; i++) {
    digitalWrite(pin, HIGH);
    delay(onMs);
    digitalWrite(pin, LOW);
    delay(onMs);
  }
}

int lampFor(int round) {
  if (round == 0) return LAMP_A;
  if (round == 1) return LAMP_B;
  return LAMP_C;
}

int timesFor(int round) {
  return round + 1;
}

Mengembalikan nilai

Tipe apa pun selain void berarti fungsi mengembalikan nilai dengan tipe itu, dan return adalah caranya. Pemanggilnya bisa mencetaknya, menyimpannya, atau memakainya dalam hitungan. Di bawah, twice(21) mencetak 42.

Perhatikan bahwa twice() ditulis setelah setup() yang memanggilnya. Di C++ biasa itu error, karena compiler membaca dari atas dan belum melihat twice. Arduino IDE diam-diam menambahkan deklarasi untuk setiap fungsi di file .ino di bagian atas sebelum mengompilasi, dan Mokxi melakukan hal yang sama, jadi di sketch-mu urutannya tidak masalah.

Fungsi yang menjawab
void setup() {
  Serial.begin(9600);
  Serial.println(twice(21));
}

void loop() {
}

int twice(int x) {
  return x * 2;
}

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

Parameter adalah salinan

Parameter adalah salinan dari apa yang diteruskan pemanggilnya. addOne(score) di bawah menambah satu pada salinannya sendiri lalu membuangnya, jadi score masih mencetak 5 setelahnya. Sering kali itu memang yang kamu mau: fungsi tidak bisa diam-diam mengubah variabelmu.

Saat kamu memang menginginkannya, taruh & setelah tipenya. void addOneRef(int &n) menerima reference, yaitu variabel milik pemanggilnya dengan nama lain, dan setelah addOneRef(score) ia mencetak 6. Reference juga cara biasa untuk mendapatkan dua jawaban dari satu fungsi: minMax(7, 3, lo, hi) mengisi keduanya dan mencetak "3 7".

Salinan, dan reference
void addOne(int n) {
  n = n + 1;
}

void addOneRef(int &n) {
  n = n + 1;
}

void setup() {
  Serial.begin(9600);
  int score = 5;
  addOne(score);
  Serial.println(score);
  addOneRef(score);
  Serial.println(score);
}

void loop() {
}

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

Di mana fungsi diletakkan, dan error saat salah tempat

Fungsi diletakkan di luar semua fungsi lain, di level teratas file, biasanya setelah loop() atau di atas setup(). Jaga agar setiap fungsi tetap pendek dan beri nama yang menjelaskan tugasnya, seperti readTemperature() atau flashError(), dan loop() mulai terbaca seperti daftar langkah. Tulis satu di dalam setup() dan build berhenti. Mokxi mengompilasi dengan clang, yang kata-katanya function definition is not allowed here; GCC milik Arduino IDE berkata a function-definition is not allowed here before '{' token. Ini hampir selalu berarti ada kurung kurawal penutup yang hilang di atasnya, sehingga compiler mengira kamu masih di dalam setup(). Hitung kurung kurawalmu.

Fungsi yang menjanjikan nilai harus mengembalikannya di setiap jalur. int f(int x) { if (x > 0) return 1; } bisa di-build, dengan peringatan: non-void function does not return a value in all control paths. Panggil f(-5) dan kamu mendapatkan apa pun yang kebetulan tertinggal, yang di sini mencetak 1. Tambahkan return di akhir, sekalipun itu return 0;.

Fungsi di tab .cpp terpisah tidak mendapatkan deklarasi otomatis seperti file .ino. Kami memindahkan sebuah fungsi ke tab bernama more.cpp dan sketch berhenti dengan use of undeclared identifier 'helper'. Letakkan deklarasi, void helper();, di header seperti more.h dan #include "more.h" di bagian atas sketch, lalu build-nya berhasil.

Buka rangkaian ini di editor. Arduino Uno: tiga lampu, satu fungsi flash, dengan kabel seperti yang berjalan di bagian atas halaman ini. Ubah satu komponen atau nilainya lalu jalankan lagi.

Pertanyaan

Apa arti void di Arduino?

Bahwa fungsi tersebut tidak mengembalikan apa pun. void setup() dan void loop() melakukan tugasnya dan tidak mengembalikan nilai. Fungsi yang menjawab sebuah pertanyaan punya tipe, misalnya int atau float, dan diakhiri dengan return.

Apakah aku harus mendeklarasikan fungsi sebelum memakainya di Arduino?

Tidak di file .ino: Arduino IDE menambahkan deklarasi untukmu sebelum mengompilasi, dan Mokxi juga, jadi fungsi boleh ditulis di bawah kode yang memanggilnya. Di file .cpp kamu perlu, biasanya di header.

Bagaimana cara mengembalikan dua nilai dari satu fungsi?

Kirim dua variabel by reference, dengan & setelah tipenya, lalu isi di dalam fungsi. Atau kembalikan sebuah struct yang menampung keduanya. Contoh minMax() di halaman ini mengisi nilai terendah dan tertinggi dengan cara ini.

Kenapa mengubah parameter tidak mengubah variabelku?

Karena parameter adalah salinan. Mengubahnya hanya mengubah salinannya. Deklarasikan parameter sebagai reference, int &n bukan int n, jika fungsi memang dimaksudkan untuk mengubah variabel pemanggilnya.

Apa arti "a function-definition is not allowed here"?

Bahwa sebuah fungsi didefinisikan di dalam fungsi lain, hampir selalu karena kurung tutup di atasnya kurang. Cari fungsi sebelum error tersebut dan periksa setiap { punya pasangan }.

Apakah fungsi Arduino bisa mengembalikan array?

Tidak sebagai array. Fungsi bisa mengembalikan pointer, tapi mengembalikan alamat array lokal adalah bug: build tetap berhasil dengan peringatan address of stack memory associated with local variable 'a' returned, karena array-nya sudah hilang begitu fungsi berakhir. Kirim array sebagai parameter lalu isi, atau kembalikan struct yang menampung nilainya.

Rakit versi nyatanya

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