PICマイコン（PIC16F1827）でES920LRの設定と無線通信

こんにちは、ENGかぴです。

PIC16F1827はシリアル通信機能（EUSART）を持っているため外部機器と通信を行うことができます。MCCを使用してEUSARTの設定を行いES920LRの初期設定する方法と電文を使って無線通信する方法をまとめました。

ES920LRB（EASEL製：東京デバイセズで購入）を２台使用して親機と子機の設定を行います。ES920LRには後継機種としてES920LR2及びES920LR3があります。

本記事ではES920LRの初期化をプロフェッサーモードで設定を行い電文を生成して無線通信を行います。PIC16F1827のシリアル通信の方法とES920LRの設定を行って無線通信する方法は以下の記事にまとめています。

PICマイコン(PIC16F1827)のシリアル通信の応用

LoRaモジュールES920LRの設定と無線通信の確認

これらで紹介した記事を応用して無線通信を実現します。

PIC16F1827で動作確認したことについてリンクをまとめています。

PICマイコン（PIC16F1827）で実現できる機能と解説リンクまとめ

EUSARTを実装する
ES920LRで無線通信する
動作確認
ソースコード全体
関連リンク

EUSARTを実装する

PIC16F1827の設定はMCCを使っています。MCCの使い方については下記記事にまとめています。

MPLAB Code Configurator(MCC)の追加と使い方

今回はMCCを使用してEUSART及びTMR0の設定を行っています。

広告
マイベスト３年連続1位を獲得した実績を持つ実践型のプログラミングスクール

System Moduleの設定

最初に共通事項であるSystem Moduleの設定を行います。MPLAB X IDEを起動しMCCのアイコンをクリックしてMCCを有効にします。

内部クロックを使用するためINTOSCを選択しています。ES920LRの初期のボーレートが115200bpsなのでEUSART設定時の誤差を減らすために16MHz_HFを選択しています。

EUSARTを設定する

PICマイコンのシリアル通信はEUSARTと表現されています。EUSARTはDevice Resources内のPeripherals欄のEUSARTを選択して追加します。

EUSARTを非同期で使用するためにModeでasynchronousを選択しEnable Transmit及びEnable Receiveにチェックを入れます。Baud RateをES920LRのデフォルトである115200bpsにします。

クロックが低い状態で115200bpsを選択すると誤差が大きくなり送受信が失敗したりなど通信が不安定になるため注意が必要です。

送信や受信時に割り込みを使用してデータの格納を行う方が確実なデータ取得がしやすいためEnable EUSART Interruptsをチェックして割り込みを使用します。

パリティを使用しないためTransmission Bits及びReception Bitsを8ビット構成にしています。

Software Settings欄にはTransmit Buffer SizeやReceive Buffer Sizeで割り込み時にデータを一時保存しておくバッファのサイズを選択できますがサイズを大きくするとデータ容量が増えてしまいます。

PR：スキマ時間を有効に！スマホで学べる人気のオンライン資格講座【スタディング】まずは気になる講座を無料で体験しよう！

TMR0の設定

TMR0はDevice Resources内のPeripherals欄のTimerを選択しTMR0をクリックして追加します。

Timer Clock内でクロックに関する設定を行います。Clock Sourceは内部クロックを使用しているためFOSC（FOSC/4）を指定します。PrescalerはClock Sourceに対してTMR0のカウントアップする分周比を指定します。

Timer PeriodはTMR0がオーバーフローするタイミングを設定します。1ms毎にオーバーフロー割り込みが発生しますがCallback Function Rateを0x0Aを指定しているため10ms毎にコールバック関数が呼び出されます。

void mainTimer(void); //ﾀｲﾏｰ0割り込みのコールバック関数
//コールバック関数の使用例
TMR0_SetInterruptHandler(mainTimer); //コールバック関数を指定

上記例ではmainTimer()が10ms毎にコールされます。

電文を受信する

while(EUSART_is_rx_ready()) //受信データがあるか
{
    picRcv.buf[picRcv.wp] = EUSART_Read(); //データをリード
    if( ++picRcv.wp >= sizeof(picRcv.buf)){ //次に保管する位置を更新
        picRcv.wp = 0;
    }
}

EUSARTで受信したデータを一時保管します。EUSART_is_rx_ready()は受信したデータがあるとtrueを戻り値で返します。trueであればEUSART_Read()で受信したデータを読み込み一時保管します。

While()で受信データを確認しているのはメイン処理に来るたびに受信しているデータ分だけ確実に取得するためです。if()で確認するよりもデータの一時保管が早くなります。

受信データの受付とデータの送信

void eUsartmain(bool init){

    switch(ComMode){
        case COM_RX_WAIT:
            //受信待ちで一時保管したデータのチェックを行う
            //ヘッダーとSUMで電文の整合性チェックをチェック
            break;
        case COM_RCVDATA: 
            //受け入れた電文に対して処理を行う
            break;
        case COM_TX:
            //返信電文を送信する
            break;        
    }
}

eUsartmain()関数でシリアル通信の管理を行います。引数はES920LRの初期化の場合と通常の電文で処理を切り替えるために使用します。初期化する場合は引数にtrueを指定します。

受信と送信をモードによる切り替え処理で管理します。以下のように3つのモードを実装します。

モード	説明
COM_RX_WAIT	一時保管したデータをヘッダーやデータ長から電文を判断する。データのチェックサムによって問題なければ電文受け入れる。
COM_RCVDATA	受け付けた電文を解析して処理を行う。
COM_TX	データを送信する。

送受信を管理するモードの説明

COM_RX_WAITで受信したデータの確認を行いチェックサムの条件を満足すると電文を受け入れてモードをCOM_RCVDATAに遷移します。

COM_RCVDATAで電文を解析して処理を行います。データを返信する場合は送信用のデータをセットしてモードをCOM_TXに遷移します。返信しない場合はモードをCOM_RCVDATAに戻して受信待ちにします。

モードを切り替えて処理するため受信データのチェックと送信の処理が同時に発生することはありません。

データの送信

if(EUSART_is_tx_ready()){ //送信ビジーでないか
    if ( Txdata.cnt < sizeof(Txdata.data)){
        EUSART_Write(Txdata.data[Txdata.cnt]); //データを送信
        ++Txdata.cnt; //送信データカウントを更新
    }
    else{ //全データの送信が完了
        timTxWait = TIME_OFF;
        ComMode = COM_RX_WAIT; //受信待ちに遷移
    }
}  
                
if( timTxWait == TIME_UP ){ //送信タイムアウトか
    timTxWait = TIME_OFF;
    ComMode = COM_RX_WAIT; //受信待ちに遷移
}

COM_TXモードでは送信がビジー（待機状態）でなければデータを送信します。送信データを配列として準備し送信データカウントを更新しながら配列の先頭から順に送信します。

送信タイムアウトを設けていますが何らかの要因で送信がうまくいかなかった場合にタイムアウトで受信モードに切り替えることができます。

送信タイムアウトに引っかかってしまう場合は異常状態とみなしてシリアル通信機能をリスタートするなど対策に使用できます。

ES920LRで無線通信する

ES920LRの初期設定をプロフェッサーモードで行います。PIC16F1827のシリアル通信でES920LRの初期設定を行い、自作の電文で無線通信を行います。

ES920LRの初期設定

プロフェッサーモードはショートコマンドを使用してES920LRの設定する方法です。設定方法の詳細はEASEL社のHPに公開されているデータシート（ES920LRコマンド仕様ソフトウェア説明書_v121）で確認することができます。

EASEL社ー920MHz帯LoRaモジュール　ES920LR

ES920LRの設定は以下の手順で行います。半角のスペースを␣改行コードをCRLF(0x0D 0x0A)と表記します。

ES920LRの初期化の例

手順1
プロフェッサーモードに遷移

電源ONから３秒後に[Select Mode]が表示されるのを待って
2CRLFでプロフェッサーモードに遷移します。
手順2
ノードの選択

親機/子機で動作するかを設定します。
親機：a␣1 CRLF、子機：a␣2 CRLF
手順3
ノードのPAMIDの設定

親機/子機で共通のPANIDを設定します。
e␣12AB CRLF（12ABは16進数）
手順4
自局のアドレスの設定

親機/子機の自局のアドレスを設定します。
親機：f␣0000 CRLF、子機：f␣0001 CRLF
手順5
送信先（宛先）のアドレスの設定

送信相手のアドレスを設定します。
親機：g␣0001 CRLF、子機：g␣0000 CRLF
手順6
ペイロードのフォーマットの設定

※バイナリデータで送信に変更
A␣2 CRLF
手順7
起動時のモードの設定（本記事では未実装）

電源ONした後のモードを設定する。オペレーションモードで起動
q␣2 CRLF
手順8
設定の保存（本記事では未実装）

手順6までに設定した項目を保存する。
手順9
オペレーションモードスタート

オペレーションモードに遷移します。
z CRLF

ES920LRは電源をONして3秒（bootモードに遷移するまでの時限）ほどコマンドを受け付けることができません。そのためプロフェッサーモードに遷移させるコマンドを３秒経過してから送信するようにします。

上位互換のES920LR2やES920LR3は起動時の仕組みが改善されているため３秒のウェイトを置く必要はありません。

本記事では未実装ですが起動時に親機と子機の役割が明確な場合は手順7による起動時のモードの設定と手順8の設定の保存を行うことで次回起動時に初期化処理をせずに無線通信ができます。

switch(initmode){
  case INIT_WAIT: //3秒以上のウェイト
    if(timInitWait == TIME_UP ){
      timInitWait = TIME_OFF;
      initmode = INIT_SEL;
    }
    break;
  case INIT_SEL: //プロフェッサーモードを選択
    if( IntTxDataSet((uint8_t*)&select,1)){ //2CRLFを送信
      initmode = INIT_SEL_WAIT; //OKが返信されるのを待つモード
    }            
    break;
  case INIT_NODE: //ノードの設定
    if(selParent){ //親機の場合
      if( IntTxDataSet((uint8_t*)&node1,3)){ //a␣1 CRLFを送信
        initmode = INIT_NODE_WAIT; //OKが返信されるのを待つモード
      }                   
    }
    else{ //子機の場合
      if( IntTxDataSet((uint8_t*)&node2,3)){ //a␣2 CRLFを送信
        initmode = INIT_NODE_WAIT; //OKが返信されるのを待つモード
      }                     
    }
    break;
}

初期化処理はモード切替で行います。ES920LRの初期化の例の手順に従うようにモードを遷移させていきます。INIT_SELモードでは「2CRLF」を送信し、INIT_SEL_WAITモードで返信を待ちます。

プロフェッサーモードではコマンドを受け付けると「OK」を返信します。「OK」が確認できれば次のモードであるINIT_NODEに遷移します。このように送信と返信待ちを繰り返しながら各種設定を行っていきます。

使用環境によってはシリアル通信がうまくいかずNGが返信されたりOKが掴めなかったりして処理が停滞してしまうことがあります。対策として失敗したときのリトライを設けると安定性が良くなります。

送受信に使用する電文

引用：EASEL社-ES920LRコマンド仕様ソフトウェア説明書_v121.pdf

ES920LRの初期設定の時に通信方式をPayloadモードに変更しています。Payloadモードでは先頭に全体の入力長を1バイトで指定し２バイト目から入力データ（最大50バイト）を指定します。

アスキー文字の方が受信時に文字として見やすいため分かりやすいですが、バイナリデータを文字に置き換えると2バイト必要となり送信バイト数が増えてしまいます。

例）バイナリデータで1バイトデータである「0x31」を送信する場合はアスキー文字では0x33 0x31と2バイト分のデータとなります。

LoRa通信などLPWAでは低消費電力を実現するために可能な限り送信するバイト数を減らすことが必要です。対策としてバイナリデータで送信バイト数を減らす方法が有効です。

Payloadモードのフォーマットに従って電文を構成します。

１バイト目には全体の入力長を指定します。２バイト目は電文を判別するためのヘッダーとして「L」を指定します。コマンドに番号を指定しデータ1からデータ3はコマンドの番号に対する処理の内容を指定します。SUMはコマンドからデータ３までを加算した値の下位1バイトを付加します。

受信データのチェック

  if( rxsz >= 2 ){ //データ長分だけ獲得しているか
      for( i = 0; i < 2; i++){//データサイズ算出のため仮おき
          dat[i] = picRcv.buf[ rp ];
          if(++rp >= sizeof(picRcv.buf) ) rp = 0;
      }
      if( dat[1] == HEADER){ //ヘッダーの確認
          if( dat[0] > sizeof(picRcv.buf) ){
              allsz = sizeof(picRcv.buf);
          }
          else{
              datsz = dat[0] - 2; //headerとsumを除外
              allsz = dat[0] + 1; //データ数分を含む
          }
                  
          if( rxsz >= allsz){ //確定したサイズ以上か
              timRxWait = TIME_OFF;
              for(i=0; i < sizeof(Rcvdata); i++){
                  Rcvdata[i] = 0; //バッファのクリア
              }
              for( i=0; i < allsz; i++ ){ //一時保管したデータを移す
                  Rcvdata[i] = picRcv.buf[picRcv.rp]; 
                  ReadPointerAdd(); //読み込み位置の更新
              }
              sumchk = CalcSum(&Rcvdata[2], datsz); //チェックサムの計算
              if( sumchk == Rcvdata[allsz-1]){ //チェックサムの確認
                  ComMode = COM_RCVDATA; //モードを遷移
              }
          }    
      }
  }

受信したデータが電文の構成であるかを確認するためにCOM_RX_WAITモードで受信データのチェックを行います。受信データはデータ数が先頭で２バイト目にヘッダとなるように電文を構成しているため最初の２バイトで全体のサイズとヘッダの一致を確認します。

ヘッダが一致した場合は受信データを電文保管用のバッファ(Rcvdata[])に移し替えてRcvdata[]の３バイト目から４バイト分のチェックサム（SUM）を計算します。

電文の最終バイトに付加したチェックサムの値と計算したチェックサムが一致した時正常な電文として受け入れてCOM_RCVDATAモードに遷移します。

動作確認

PIC16F1827とES920LRをシリアル通信して無線通信を行います。ES920LRの動作電圧はDC3.3VなのでPIC16F1827をDC5Vで動作させる場合は注意が必要です。

親機と子機で回路を切り替えます。親機で使用する場合は6ピン(RB0)をGNDに接続して電源をONします。子機の場合は未接続とします。回路図の赤線は子機で使用し青線は親機で使用します。子機のSW1を押すと無線通信を行い親機のLED1を５秒間点灯させます。

PIC16F1827はDC3.3Vでも動作できるためDC3.3Vの電源を使用して直接ES920LRと直接接続しても問題ありません。回路例ではDC5VのPIC16F1827のシリアル通信信号をDC3.3Vに電圧変換してES920LRと接続しています。

三端子レギュレータBA33BC0FP（ローム）を使用していますが、負荷側にコンデンサ（22uF～1000uF）が必要になります。消費電流はほとんどないためLP2950L-3.3V（UTC）やNJM2845DL1（西日本無線）でも代用可能です。

UART_TXはES920LRからPIC16F1827に向けた通信になるためDC3.3VからDC5Vに電圧変換を行います。UART_RXはPIC16F1827らES920LRに向けた通信になるためDC5VからDC3.3Vに電圧変換しています。

TR1とTR2のようにpnpトランジスタを使用することで通信の極性が反転しないようにしています。PIC16F1827側のコレクタは内蔵プルアップで接続しています。

電源をONして５秒くらい経過した後、子機のSW1を押すと親機のLED1が５秒間点灯した後消灯するが確認できました。距離が離れるとLED1の点灯の確認が難しくなるため親機から子機に対して返信電文を送信して子機に表示するなど工夫が必要だと感じました。

MCCのピン設定は以下の通りです。

PB0はINPUTでウィークプルアップ（WPU）設定しています。WPUを有効にするためにはRegistersのnWPUENをenabledにする必要があります。

Easy SetupでWPUにチェックするのみでは有効にならないので注意が必要です。Notificationsにワーニングで通知されます。

ソースコード全体

ソースコードは記事作成時点において動作確認できていますが、使用しているライブラリの更新により動作が保証できなくなる可能性があります。また、ソースコードを使用したことによって生じた不利益などの一切の責任を負いかねます。参考資料としてお使いください。

リンクからZIPファイル形式のファイルをダウンロードし、任意の場所に展開していただくとテキストファイルが生成されます。

ソースコードをダウンロード

main.cをコピーすると使用できます。本ソースコードはMPLAB X IDEにMCCのプラグインをインストールしていることが前提となります。MCCをインストールする方法は下記記事を参考にしてください。