Arduino 入門 番外編 09 【スケッチ（コード、プログラム）の関数化】

Arduino 入門
番外編 09
【スケッチ（コード、プログラム）の関数化】

こんにちは管理人のomoroyaです。

今回は、「Arduino 入門 番外編 09 スケッチ（コード、プログラム）の関数化」です。

arduino 入門 番外編はarduinoの基本的なことを書いていく方向性にしたいと考えています。

本日は、スケッチ（コード、プログラム）の関数化についてです。

 

Arduinoに複雑なことをさせようとすると、スケッチ（コード、プログラム）がどんどん複雑になっていきますよね。

そんなときは、スケッチ（コード、プログラム）の関数化で解決です。

ぜひ、スケッチ（コード、プログラム）を関数化することで分かりやすいコードを書いてみてください。

arduino自身のこと、スケッチ（コード、プログラム）を少しづつ理解して行きましょう。

 

いやいや、arduinoを早速始めたいんだ！というかたは下記の入門編からお読みください。

 

Arduino入門編の解説にて使用しているArduinoは互換品です。

互換品とは言え、Arduinoはオープンソースであり複製して販売するのもライセンス的に問題なし。

そのため互換品の品質も悪くなく、それでいて値段は安いです。

正規品本体の値段程度で豊富な部品が多数ついています。

正規品（Arduino UNO R3）の本体単品がほしい方はこちらとなります。

 

Arduino入門編2では「Arduino UNO R4 Minima」「Arduino UNO R4 WIFI」にて遊ぶため今のところは正規品を使用。（まだ互換品が・・・ほぼない）

 

 

スケッチ（コード、プログラム）の関数化について

ArduinoはC/C++をベースにしています。

そのため、

スケッチ（コード、プログラム）を機能ごとに分割して特定の仕事をこなすモジュールを作成するといったことが簡単にできます。

このモジュールの単位のことを関数（function）と呼びます。

 

スケッチ（コード、プログラム）のなか、頻繁に行われる処理をモジュール化することで1つの関数としてまとめます。

関数を呼び出す（コール）すると処理が実行され、処理が終了したらコールした位置へ戻ってきます。

 

Arduinoに慣れてきて、スケッチ（コード、プログラム）が複雑に長くなってしまわないように関数化は必須な作業です。

ぜひ、使えるようになりましょう。

 

スケッチ（コード、プログラム）を関数化することのメリット

メリットはいくつかありますが

私が考える一番のメリットは、「デバックが容易」といったところでしょうか。

一度、関数化してクローズさせてしまえば問題があったときにクローズしている中だけでデバックができるなどが可能です。

その他にも

• 関数化することでスケッチ（コード、プログラム）が見やすくなる。（※重要！）
• 同じ処理を何度も書かずに済む。
• スケッチ（コード、プログラム）のサイズを小さくする。
• スケッチが小さくなるのでメモリの使用量が減る。
• 関数の再利用が可能。

などなどメリットがたくさんあります。

ぜひ、同じ作業の繰り返しに関しては関数化することをお勧めします。

 

公式ホームページでは以下にて説明がなされています。

https://www.arduino.cc/en/Reference/FunctionDeclaration

…

www.arduino.cc

 

では、さっそく関数化について解説していきます。

関数化するには２つの手段があります。

１．戻り値を返す関数

２．戻り値を返さない関数

 

戻り値を返す関数

戻り値を返す関数というのは、関数が何かの作業をし、その作業結果を返すという処理のことです。

関数に対して、作業をさせるために情報を渡す（引数と言う）場合もあります。

戻り値の型名：int , double などのデータ型を定義
関数名：お好きにどうぞ（reserve名は使わないでね）
引数の型：int , double などのデータ型を定義
引数名：お好きにどうぞ
※引数がない場合は ( ) 内は何もか書かない。

実際の例で説明していきます。

 

例１．2つの数字の足し算をする関数。（引数あり）

int func_add(int x, int y) {

  int result;

  result = x + y;
  return result;
}

func_addが関数名、int x, int yは関数に渡される引数となります。

ここでは、int型の整数を2つ引数としています。

{ } 内で囲まれた箇所が、func_add関数が処理する作業となります。

ｘ、ｙの値をもらって、x + yを実行してresultに格納。

resultの結果を戻り値として返すということになります。

 

実際のスケッチに組み込んだサンプルコードがこちら。

シリアルモニタに計算結果を表示するサンプルスケッチです。

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

void loop() {
  int a = 7;
  int b = 5;
  int c;
  
  c = func_add(a, b);
  Serial.println(c);
  delay(500);
}

int func_add(int x, int y) {
  int result;
  result = x + y;
  return result;
}

 

例２．2つの数字の足し算をする関数。（引数なし）

int func_add() {

  int x = 8;
  int x = 5;
  int result;

  result = x + y;
  return result;
}

func_addが関数名、関数に渡す引数がない場合は()内になにも記載しなくてOK。

{ } 内で囲まれた箇所が、func_add関数が処理する作業となります。

ｘ、ｙに定義された値で、x + yを実行してresultに格納。

resultの結果を戻り値として返すということになります。

 

実際のスケッチに組み込んだサンプルコードがこちら。

シリアルモニタに計算結果を表示するサンプルスケッチです。

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

void loop() {
  int c;
  
  c = func_add();
  Serial.println(c);
  delay(500);
}

int func_add() {

  int x = 8;
  int y = 5;
  int result;

  result = x + y;
  return result;
}

 

戻り値を返さない関数

戻り値を返さない関数というのは、関数に何かの作業だけをさせ、その作業結果をスケッチ内で特に利用しない場合に利用します。

関数に対して、作業をさせるために情報を渡す（引数と言う）場合もあります。

void：戻り値がない場合はvoidとなります。
関数名：お好きにどうぞ（reserve名は使わないでね）
引数の型：int , double などのデータ型を定義
引数名：お好きにどうぞ
※引数がない場合は ( ) 内は何もか書かない。

実際の例で説明していきます。

 

例１．LEDをON OFF する関数。（引数あり）

こんなんでも、関数にできちゃいますよという例です。

void func_led(int x) {

  pinMode(x, OUTPUT);

  digitalWrite(x , HIGH);
  delay(500);
  digitalWrite(x , LOW);
  delay(500);
}

func_ledが関数名、int xは関数に渡される引数となります。

ここでは、int型の整数を１つ引数としています。

{ } 内で囲まれた箇所が、func_led関数が処理する作業となります。

 

ｘに定義されたデジタル入出力ピンをHIGH、LOWにすることでLEDをON、OFFしています。

 

実際のスケッチに組み込んだサンプルコードがこちら。

デジタル入出力、８、９番ピンに接続されたLEDをON、OFFするサンプルスケッチです。

同じことを２回、記述しなくても良いことをわかりやすくしたサンプルです。

void setup() {
}

void loop() {
  func_led(8);
  func_led(9);
}

void func_led(int x) {

  pinMode(x, OUTPUT);

  digitalWrite(x , HIGH);
  delay(500);
  digitalWrite(x , LOW);
  delay(500);
}

 

例２．LEDをON OFF する関数。（引数なし）

例1を引数なしで記述してみました。

void func_led() {

  pinMode(8, OUTPUT);

  digitalWrite(8 , HIGH);
  delay(500);
  digitalWrite(8 , LOW);
  delay(500);
}

func_ledが関数名、引数なしとなります。

{ } 内で囲まれた箇所が、func_led関数が処理する作業となります。

 

デジタル入出力の8番ピンをHIGH、LOWにすることでLEDをON、OFFしています。

 

実際のスケッチに組み込んだサンプルコードがこちら。

デジタル入出力の８番ピン接続されたLEDをON、OFFするサンプルスケッチです。

同じLEDを3秒、５秒のインターバルを設けてON、OFFさせています。

こちらも同じことを２回、記述しなくても良いことをわかりやすくしたサンプルです。

void setup() {
}

void loop() {
  func_led();
  delay(3000);
  func_led();
  delay(5000);
}

void func_led() {

  pinMode(8, OUTPUT);

  digitalWrite(8 , HIGH);
  delay(500);
  digitalWrite(8 , LOW);
  delay(500);
}

 

まとめ

「Arduino 入門 番外編 09 スケッチ（コード、プログラム）の関数化」

いかがだったでしょうか？

 

Arduinoに色んなことをさせようと考えると、スケッチ（コード、プログラム）がどんどん複雑になっていきます。

そんなときは、ぜひ関数化してわかりやすいスケッチを書くようにすると良いと思います。

デバックが容易ですし、後で見てもわかりやすいです。

 

次回の番外編は、スケッチで重要な【変数のスコープ】について情報を発信したいと考えています。

Arduino 入門 番外編 10 【変数のスコープ】（ローカル変数、グローバル変数）

今回は、重要なことなんだけと初心者、入門レベルではあまり意識していない？「変数のスコープ（ローカル変数、グローバル変数）」について解説します。Arduinoに複雑なことをさせようとすると、スケッチ（コード、プログラム）がどんどん複雑になって…

omoroya.com