第32回 MPLAB X IDEデバッグ機能（１）

前回作成したプログラムの動作確認と、MPLAB X IDEのデバッグ機能の使い方を確認します。

これから行うこと

なんだか結構大変でしたが、温湿度・気圧センサーとSPI通信をしてIDを取得するプログラムを作成しました。

取得したIDが正しいかどうかはLEDの色で表示しますので、最初のプログラムの動作を確認します。

LEDの色で結果が判定できますが、それとは別にMPLAB X IDEの「デバッグ機能」を使って、本当にIDが正しく取れているか確認します。（今は「デバッグ」について分からなくて大丈夫です）

そこで、今回の記事では次の順番で進めていきます。

プログラム動作確認

それでは、前回作成したプログラムをPICマイコンに書き込んで、動作確認してみます。

といっても何か派手な動きをするわけではなく、電源を入れるとLEDが点灯するだけなので、ちょっと寂しいですね。

実際に動作させると、次のようにLEDが青に点灯しました。

もし、LEDが赤に点灯したら、温湿度・気圧センサーの接続と、LEDの接続を確認してみてください。

特にLEDの接続については注意が必要です。

LED本体から3本のリード線が出ていて、中央がGNDで両側が青と赤のLEDに接続されています。向きを逆にすると逆の色で点灯しますので、接続向きを確認するようにしてください。

デバッグ機能とは?

今回の確認では、温湿度・気圧センサーから正しくIDが取得できたかどうかという二択ですので、LEDの色で識別することができました。

例えばですが、取得した湿度の値を確認したい場合など、数値自体を確認したいケースもありますよね。

その場合はLEDの点灯状態で判別するのはかなり無理があります。

他にも、作成したプログラムが動作しない場合、PICマイコンの中で何が起こっているのか知りたいケースもありますよね。（自分の場合、記事に載せている大半のプログラムは、一発でうまく動くことはほとんどない、という現状です…！）

このようなときは、MPLAB X IDEの搭載されいる「デバッグ機能」が便利です。

デバッグ機能を利用すると、作成したプログラムを1行1行実行しながら、PICマイコンの中でプログラムがどのように動いているか確認することができます。

また、1行1行動作させている最中に、変数の値を確認することもできます。

と説明されても、いまいちどうやって確認できるのか具体的なイメージが湧かないですよね。

そこで、習うより慣れろということで、作成したプログラムを使用してデバッグ機能を動かしてみます。

ところで「デバッグ」ってちょっと不思議な言葉ですよね。

昔、プログラムが動作しないとき、プログラムに「虫」（＝Bug・バグ）がいてそれが悪さをする、と考えていました。

プログラムの修正作業は、その虫を取る作業と捉えて、「Bug」に「De」（日本語で「除去する」という意味）をつけて、「Debug」と呼び、日本語でもそのままデバッグと呼ぶようになったようです。

デバッグで行うこと

プログラムのmain関数内では、次のように温湿度・気圧センサーのIDを取得しています。（28行目）

void main(void) {

    // 動作周波数設定
    OSCCON1bits.NDIV = 0b0000;  // 分周1:1
    OSCFRQbits.HFFRQ = 0b010;   // 4MHz

    // SPI通信用ピン属性設定
    ANSELC = 0b00000000;
    TRISC  = 0b01000000;
    
    // LED用ピン属性設定;
    ANSELB = 0b00000000;
    TRISBbits.TRISB0 = 0;
    TRISBbits.TRISB1 = 0;

    // SPI信号線初期設定
    SPI_SCK  = 0;  // クロックを0
    SPI_MOSI = 0;  // 送信データを0
    SPI_CSB  = 1;  // チップセレクトを1(=無効)
    
    // LEDをOFF
    LED_BLUE = 0;
    LED_RED  = 0;

    // 0xD0に格納されているチップIDを読み取る
    uint8_t chipid = 0x0;

    chipid = spiRead1ByteData(0xD0);
    
    if( chipid == 0x60 ) {
        LED_BLUE = 1;
    } else {
        LED_RED  = 1;
    }
    
    // ここで動作停止
    while(1){
    }

}

これから、デバッグ機能を使って、実際にPICマイコンの動作中にchipidの値がどのようになっているのか確認してみます。

これから、PICマイコンを実際に動作させて、spiRead1ByteData関数を実行したあと、chipidにどのような値が格納されるか確認してみます。（0x60のはずですよね）

ところで、MPLAB X IDEは、PICマイコンの動作中にPICマイコンの中の内部状態を確認します。

そのため、デバッグ中はPICkitでPCとPICマイコンを接続したまま使用することになります。

PICkitを接続すると物理的に安定しないことがありますよね。

デバッグ中は両手が空くように、PICkitをうまく固定できるようにしておくと良いと思います。

デバッグ手順の概要

デバッグ機能を使用する場合、通常のプログラム書き込み手順とは異なります。

デバッグ機能を使用する場合、手順の概略は次のようになります。

それでは、それぞれのステップを確認していきましょう！

Step 1. ブレークポイントの設定

デバッグを開始する前に、プログラムのどこで動作を一時停止するか指定します。

今回はchipidの変数の値を確認しますので、次の行にブレークポイントを設定することにします。

    chipid = spiRead1ByteData(0xD0);

それではこの行にブレークポイントを設定しましょう！

設定は、次のようにブレークポイントを設定する行の行番号をクリックします。

行番号をクリックすると、行番号が四角の記号に変わり、行が赤色でハイライトされます。

これがブレークポイントが設定されている表現になります。

Step 2. デバッグ開始

次に、PICマイコンにデバッグ実行してもらいます。

今までは書き込みボタンをクリックしていましたが、デバッグの場合は次の「デバッグ実行」のボタンをクリックします。（右側にある小さい▼部分をクリックするとメニューが表示されます。その場合は「Debug Project」を選択してください）

もし、上のデバッグボタンが見当たらない場合、ボタンが隠れています。

その場合は、ウィンドウサイズを大きくするか、次のように マークにマウスカーソルを合わせるとボタンが表示されます。

デバッグボタンをクリックすると、最初に次のダイアログが表示されます。

このダイアログでは「ソフトウェアブレークポイントを使用するか？」と聞いています。

この内容を理解するにはPICマイコンのハードウェア知識が必要です。ほとんどのケースで「Yes」ボタンをクリックして問題ありませんのでYesをクリックして先に進めます。

次に、書き込み時の電圧について確認があります。

これは通常のプログラム書き込みの時にも表示されますよね。

今回は外部電源を使用して、PICkitから電源供給しませんので問題ありません。

OKをクリックします。

さらに確認があります。

このダイアログの内容は、プログラムに書いてあるコンフィグレーション設定を一時的に変更して良いか？という確認です。

日本語では、「「現在のプログラムのコンフィグレーション設定では、PWRTがEnableになっていますが、これらはデバッグ時には、Disableにする必要があります。一時的に変更して実行しますがいいですか？」という内容です。

この変更は、デバッグ実行時のみMPLAB X IDEが一時的に変更するだけで、作成したプログラムを書き換わるわけではありませんので、Yesをクリックして進めます。

クリックすると、プログラムをビルドして、書き込み、デバッグモードで実行します。

すぐにブレークポイントで一時的に動作が止まり、次のようにPICマイコンは待機状態になります。

一時停止した時点のPICマイコンの状態が確認できますので、chipidの値を確認しましょう！

Step 3. 変数の値の確認

それでは、変数chipidの値を確認しましょう！

確認方法は3通りありますので、それぞれの方法で確認してみます。

なお、デバッグ方法に関して重要な操作がありますので、「❶ 変数名にマウスカーソルを合わせる」からご確認いただければと思います。

❶ 変数名にマウスカーソルを合わせる

最初の方法は、chipidという変数名にマウスカーソルを合わせます。

カーソルを合わせて1〜2秒待っていると、chipidの内容がツールチップとして次のように表示されます。

ツールチップ部分は「Address = 0x75, chipid = NULL; 0x0」と表示されています。

この意味は、「chipidという変数は、メモリのアドレス0x75番地に格納されていて、その値は0x0」という意味です。

温湿度・気圧センサーのIDの値は0x60ですが、chipidの値は0になっていますので正しくデータが受信できていないのでしょうか？

実は、「ブレークポイントで一時停止した状態」というのは「その行をこれから実行する状態」なんです。つまり、まだspiRead1ByteData()は実行されていないんです。

そこで、この行を1行だけ実行してみます

ブレークポイントの行を1行だけ実行して次に進めるには、次のボタンをクリックします。（このボタンは「ステップオーバー」というボタンで、詳細は次回の記事で解説します）

なお、このボタンが見当たらない場合、ボタンが隠れています。

その場合は、ウィンドウサイズを大きくするか、次のように マークにマウスカーソルを合わせるとボタンが表示されます。

1行実行すると、次の行で一時停止した状態になります。

これで、spiRead1ByteData()が実行されましたので、変数chipidに正しい値（0x60）が格納されているはずです！

先ほどと同じように変数の値を確認してみます。

無事、0x60になっていることが確認できました！

❷ Variablesウィンドウで確認

次の方法は、「Variablesウインドウ」で確認する方法です。

MPLAB X IDEの下の方にウインドウがいくつか並んであると思いますが、その中に「Variables」というウインドウがあるはずですので探してみてください。

見つからない場合は、MPLABX IDEメニューの「Window」→「Debugging」→「Variables」を選択してください。

このウインドウを確認すると、次のように変数の値が表示されています。（クリックすると拡大できます）

❸ Watchesウィンドウで確認

最後の方法は、Watchesウインドウを確認する方法です。

先ほどのVariablesウインドウの並びに「Watches」ウインドウがあると思いますので探してみてください。

見つからない場合は、MPLABX IDEメニューの「Window」→「Debugging」→「Watches」を選択してください。

先ほどの2つの方法とは違って、何も表示されていませんよね。

このウインドウでは、自分で確認したい（Watchしたい）変数などを登録しておく必要があります。

それでは変数chipidを登録してみましょう。

次の部分をダブルクリックします。

次のダイアログが表示されますので、変数名chipidと入力してOKボタンをクリックするとchipidが登録されて、中身の確認ができるようになります。

なお、ダブルクリックの間隔が長い場合（ゆっくり2回クリックした場合)、次のように変数名の欄に直接変数名を入力するモードになります。

次のようにchipidと入力しても登録することができます。

デバッグの終了

これでデバッグ機能を使用してchipidの確認ができました。

PICマイコンはまだ処理を一時停止しています。

この後にさらにプログラムがあり処理を継続させたい場合は、次のContinueボタン（処理継続ボタン）をクリックします。

Continueボタンをクリックすると、プログラムの処理を続けます。

今回のプログラムはこの後while(1){}ですので、実行は続けても何も変化はありません。

最後に、デバッグを終了する場合は、以下のFinishボタン（デバッグ終了ボタン）をクリックします。

以上が典型的なデバッグの手順です。

デバッグ機能は他にも色々な機能があります。

次回の記事で、このプログラムを使用して他のデバッグ機能の確認を行います。

更新履歴